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 char *guestfs_debug (guestfs_h *handle,
529 char * const* const extraargs);
531 The C<guestfs_debug> command exposes some internals of
532 C<guestfsd> (the guestfs daemon) that runs inside the
535 There is no comprehensive help for this command. You have
536 to look at the file C<daemon/debug.c> in the libguestfs source
537 to find out what you can do.
539 This function returns a string, or NULL on error.
540 I<The caller must free the returned string after use>.
542 =head2 guestfs_download
544 int guestfs_download (guestfs_h *handle,
545 const char *remotefilename,
546 const char *filename);
548 Download file C<remotefilename> and save it as C<filename>
549 on the local machine.
551 C<filename> can also be a named pipe.
553 See also C<guestfs_upload>, C<guestfs_cat>.
555 This function returns 0 on success or -1 on error.
557 =head2 guestfs_exists
559 int guestfs_exists (guestfs_h *handle,
562 This returns C<true> if and only if there is a file, directory
563 (or anything) with the given C<path> name.
565 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.
567 This function returns a C truth value on success or -1 on error.
571 char *guestfs_file (guestfs_h *handle,
574 This call uses the standard L<file(1)> command to determine
575 the type or contents of the file. This also works on devices,
576 for example to find out whether a partition contains a filesystem.
578 The exact command which runs is C<file -bsL path>. Note in
579 particular that the filename is not prepended to the output
582 This function returns a string, or NULL on error.
583 I<The caller must free the returned string after use>.
587 int guestfs_fsck (guestfs_h *handle,
591 This runs the filesystem checker (fsck) on C<device> which
592 should have filesystem type C<fstype>.
594 The returned integer is the status. See L<fsck(8)> for the
595 list of status codes from C<fsck>, and note that multiple
596 status codes can be summed together.
598 It is entirely equivalent to running C<fsck -a -t fstype device>.
599 Note that checking or repairing NTFS volumes is not supported
602 On error this function returns -1.
604 =head2 guestfs_get_autosync
606 int guestfs_get_autosync (guestfs_h *handle);
608 Get the autosync flag.
610 This function returns a C truth value on success or -1 on error.
612 =head2 guestfs_get_e2label
614 char *guestfs_get_e2label (guestfs_h *handle,
617 This returns the ext2/3/4 filesystem label of the filesystem on
620 This function returns a string, or NULL on error.
621 I<The caller must free the returned string after use>.
623 =head2 guestfs_get_e2uuid
625 char *guestfs_get_e2uuid (guestfs_h *handle,
628 This returns the ext2/3/4 filesystem UUID of the filesystem on
631 This function returns a string, or NULL on error.
632 I<The caller must free the returned string after use>.
634 =head2 guestfs_get_path
636 const char *guestfs_get_path (guestfs_h *handle);
638 Return the current search path.
640 This is always non-NULL. If it wasn't set already, then this will
641 return the default path.
643 This function returns a string, or NULL on error.
644 The string is owned by the guest handle and must I<not> be freed.
646 =head2 guestfs_get_qemu
648 const char *guestfs_get_qemu (guestfs_h *handle);
650 Return the current qemu binary.
652 This is always non-NULL. If it wasn't set already, then this will
653 return the default qemu binary name.
655 This function returns a string, or NULL on error.
656 The string is owned by the guest handle and must I<not> be freed.
658 =head2 guestfs_get_state
660 int guestfs_get_state (guestfs_h *handle);
662 This returns the current state as an opaque integer. This is
663 only useful for printing debug and internal error messages.
665 For more information on states, see L<guestfs(3)>.
667 On error this function returns -1.
669 =head2 guestfs_get_verbose
671 int guestfs_get_verbose (guestfs_h *handle);
673 This returns the verbose messages flag.
675 This function returns a C truth value on success or -1 on error.
677 =head2 guestfs_is_busy
679 int guestfs_is_busy (guestfs_h *handle);
681 This returns true iff this handle is busy processing a command
682 (in the C<BUSY> state).
684 For more information on states, see L<guestfs(3)>.
686 This function returns a C truth value on success or -1 on error.
688 =head2 guestfs_is_config
690 int guestfs_is_config (guestfs_h *handle);
692 This returns true iff this handle is being configured
693 (in the C<CONFIG> state).
695 For more information on states, see L<guestfs(3)>.
697 This function returns a C truth value on success or -1 on error.
699 =head2 guestfs_is_dir
701 int guestfs_is_dir (guestfs_h *handle,
704 This returns C<true> if and only if there is a directory
705 with the given C<path> name. Note that it returns false for
706 other objects like files.
708 See also C<guestfs_stat>.
710 This function returns a C truth value on success or -1 on error.
712 =head2 guestfs_is_file
714 int guestfs_is_file (guestfs_h *handle,
717 This returns C<true> if and only if there is a file
718 with the given C<path> name. Note that it returns false for
719 other objects like directories.
721 See also C<guestfs_stat>.
723 This function returns a C truth value on success or -1 on error.
725 =head2 guestfs_is_launching
727 int guestfs_is_launching (guestfs_h *handle);
729 This returns true iff this handle is launching the subprocess
730 (in the C<LAUNCHING> state).
732 For more information on states, see L<guestfs(3)>.
734 This function returns a C truth value on success or -1 on error.
736 =head2 guestfs_is_ready
738 int guestfs_is_ready (guestfs_h *handle);
740 This returns true iff this handle is ready to accept commands
741 (in the C<READY> state).
743 For more information on states, see L<guestfs(3)>.
745 This function returns a C truth value on success or -1 on error.
747 =head2 guestfs_kill_subprocess
749 int guestfs_kill_subprocess (guestfs_h *handle);
751 This kills the qemu subprocess. You should never need to call this.
753 This function returns 0 on success or -1 on error.
755 =head2 guestfs_launch
757 int guestfs_launch (guestfs_h *handle);
759 Internally libguestfs is implemented by running a virtual machine
762 You should call this after configuring the handle
763 (eg. adding drives) but before performing any actions.
765 This function returns 0 on success or -1 on error.
767 =head2 guestfs_list_devices
769 char **guestfs_list_devices (guestfs_h *handle);
771 List all the block devices.
773 The full block device names are returned, eg. C</dev/sda>
775 This function returns a NULL-terminated array of strings
776 (like L<environ(3)>), or NULL if there was an error.
777 I<The caller must free the strings and the array after use>.
779 =head2 guestfs_list_partitions
781 char **guestfs_list_partitions (guestfs_h *handle);
783 List all the partitions detected on all block devices.
785 The full partition device names are returned, eg. C</dev/sda1>
787 This does not return logical volumes. For that you will need to
790 This function returns a NULL-terminated array of strings
791 (like L<environ(3)>), or NULL if there was an error.
792 I<The caller must free the strings and the array after use>.
796 char *guestfs_ll (guestfs_h *handle,
797 const char *directory);
799 List the files in C<directory> (relative to the root directory,
800 there is no cwd) in the format of 'ls -la'.
802 This command is mostly useful for interactive sessions. It
803 is I<not> intended that you try to parse the output string.
805 This function returns a string, or NULL on error.
806 I<The caller must free the returned string after use>.
810 char **guestfs_ls (guestfs_h *handle,
811 const char *directory);
813 List the files in C<directory> (relative to the root directory,
814 there is no cwd). The '.' and '..' entries are not returned, but
815 hidden files are shown.
817 This command is mostly useful for interactive sessions. Programs
818 should probably use C<guestfs_readdir> instead.
820 This function returns a NULL-terminated array of strings
821 (like L<environ(3)>), or NULL if there was an error.
822 I<The caller must free the strings and the array after use>.
826 struct guestfs_stat *guestfs_lstat (guestfs_h *handle,
829 Returns file information for the given C<path>.
831 This is the same as C<guestfs_stat> except that if C<path>
832 is a symbolic link, then the link is stat-ed, not the file it
835 This is the same as the C<lstat(2)> system call.
837 This function returns a C<struct guestfs_stat *>
838 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
839 or NULL if there was an error.
840 I<The caller must call C<free> after use>.
842 =head2 guestfs_lvcreate
844 int guestfs_lvcreate (guestfs_h *handle,
846 const char *volgroup,
849 This creates an LVM volume group called C<logvol>
850 on the volume group C<volgroup>, with C<size> megabytes.
852 This function returns 0 on success or -1 on error.
854 =head2 guestfs_lvm_remove_all
856 int guestfs_lvm_remove_all (guestfs_h *handle);
858 This command removes all LVM logical volumes, volume groups
859 and physical volumes.
861 This function returns 0 on success or -1 on error.
863 B<This command is dangerous. Without careful use you
864 can easily destroy all your data>.
866 =head2 guestfs_lvremove
868 int guestfs_lvremove (guestfs_h *handle,
871 Remove an LVM logical volume C<device>, where C<device> is
872 the path to the LV, such as C</dev/VG/LV>.
874 You can also remove all LVs in a volume group by specifying
875 the VG name, C</dev/VG>.
877 This function returns 0 on success or -1 on error.
881 char **guestfs_lvs (guestfs_h *handle);
883 List all the logical volumes detected. This is the equivalent
884 of the L<lvs(8)> command.
886 This returns a list of the logical volume device names
887 (eg. C</dev/VolGroup00/LogVol00>).
889 See also C<guestfs_lvs_full>.
891 This function returns a NULL-terminated array of strings
892 (like L<environ(3)>), or NULL if there was an error.
893 I<The caller must free the strings and the array after use>.
895 =head2 guestfs_lvs_full
897 struct guestfs_lvm_lv_list *guestfs_lvs_full (guestfs_h *handle);
899 List all the logical volumes detected. This is the equivalent
900 of the L<lvs(8)> command. The "full" version includes all fields.
902 This function returns a C<struct guestfs_lvm_lv_list *>
903 (see E<lt>guestfs-structs.hE<gt>),
904 or NULL if there was an error.
905 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.
909 int guestfs_mkdir (guestfs_h *handle,
912 Create a directory named C<path>.
914 This function returns 0 on success or -1 on error.
916 =head2 guestfs_mkdir_p
918 int guestfs_mkdir_p (guestfs_h *handle,
921 Create a directory named C<path>, creating any parent directories
922 as necessary. This is like the C<mkdir -p> shell command.
924 This function returns 0 on success or -1 on error.
928 int guestfs_mkfs (guestfs_h *handle,
932 This creates a filesystem on C<device> (usually a partition
933 of LVM logical volume). The filesystem type is C<fstype>, for
936 This function returns 0 on success or -1 on error.
940 int guestfs_mount (guestfs_h *handle,
942 const char *mountpoint);
944 Mount a guest disk at a position in the filesystem. Block devices
945 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
946 the guest. If those block devices contain partitions, they will have
947 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
950 The rules are the same as for L<mount(2)>: A filesystem must
951 first be mounted on C</> before others can be mounted. Other
952 filesystems can only be mounted on directories which already
955 The mounted filesystem is writable, if we have sufficient permissions
956 on the underlying device.
958 The filesystem options C<sync> and C<noatime> are set with this
959 call, in order to improve reliability.
961 This function returns 0 on success or -1 on error.
963 =head2 guestfs_mount_options
965 int guestfs_mount_options (guestfs_h *handle,
968 const char *mountpoint);
970 This is the same as the C<guestfs_mount> command, but it
971 allows you to set the mount options as for the
972 L<mount(8)> I<-o> flag.
974 This function returns 0 on success or -1 on error.
976 =head2 guestfs_mount_ro
978 int guestfs_mount_ro (guestfs_h *handle,
980 const char *mountpoint);
982 This is the same as the C<guestfs_mount> command, but it
983 mounts the filesystem with the read-only (I<-o ro>) flag.
985 This function returns 0 on success or -1 on error.
987 =head2 guestfs_mount_vfs
989 int guestfs_mount_vfs (guestfs_h *handle,
993 const char *mountpoint);
995 This is the same as the C<guestfs_mount> command, but it
996 allows you to set both the mount options and the vfstype
997 as for the L<mount(8)> I<-o> and I<-t> flags.
999 This function returns 0 on success or -1 on error.
1001 =head2 guestfs_mounts
1003 char **guestfs_mounts (guestfs_h *handle);
1005 This returns the list of currently mounted filesystems. It returns
1006 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1008 Some internal mounts are not shown.
1010 This function returns a NULL-terminated array of strings
1011 (like L<environ(3)>), or NULL if there was an error.
1012 I<The caller must free the strings and the array after use>.
1014 =head2 guestfs_pvcreate
1016 int guestfs_pvcreate (guestfs_h *handle,
1017 const char *device);
1019 This creates an LVM physical volume on the named C<device>,
1020 where C<device> should usually be a partition name such
1023 This function returns 0 on success or -1 on error.
1025 =head2 guestfs_pvremove
1027 int guestfs_pvremove (guestfs_h *handle,
1028 const char *device);
1030 This wipes a physical volume C<device> so that LVM will no longer
1033 The implementation uses the C<pvremove> command which refuses to
1034 wipe physical volumes that contain any volume groups, so you have
1035 to remove those first.
1037 This function returns 0 on success or -1 on error.
1041 char **guestfs_pvs (guestfs_h *handle);
1043 List all the physical volumes detected. This is the equivalent
1044 of the L<pvs(8)> command.
1046 This returns a list of just the device names that contain
1047 PVs (eg. C</dev/sda2>).
1049 See also C<guestfs_pvs_full>.
1051 This function returns a NULL-terminated array of strings
1052 (like L<environ(3)>), or NULL if there was an error.
1053 I<The caller must free the strings and the array after use>.
1055 =head2 guestfs_pvs_full
1057 struct guestfs_lvm_pv_list *guestfs_pvs_full (guestfs_h *handle);
1059 List all the physical volumes detected. This is the equivalent
1060 of the L<pvs(8)> command. The "full" version includes all fields.
1062 This function returns a C<struct guestfs_lvm_pv_list *>
1063 (see E<lt>guestfs-structs.hE<gt>),
1064 or NULL if there was an error.
1065 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.
1067 =head2 guestfs_read_lines
1069 char **guestfs_read_lines (guestfs_h *handle,
1072 Return the contents of the file named C<path>.
1074 The file contents are returned as a list of lines. Trailing
1075 C<LF> and C<CRLF> character sequences are I<not> returned.
1077 Note that this function cannot correctly handle binary files
1078 (specifically, files containing C<\0> character which is treated
1079 as end of line). For those you need to use the C<guestfs_read_file>
1080 function which has a more complex interface.
1082 This function returns a NULL-terminated array of strings
1083 (like L<environ(3)>), or NULL if there was an error.
1084 I<The caller must free the strings and the array after use>.
1088 int guestfs_rm (guestfs_h *handle,
1091 Remove the single file C<path>.
1093 This function returns 0 on success or -1 on error.
1095 =head2 guestfs_rm_rf
1097 int guestfs_rm_rf (guestfs_h *handle,
1100 Remove the file or directory C<path>, recursively removing the
1101 contents if its a directory. This is like the C<rm -rf> shell
1104 This function returns 0 on success or -1 on error.
1106 =head2 guestfs_rmdir
1108 int guestfs_rmdir (guestfs_h *handle,
1111 Remove the single directory C<path>.
1113 This function returns 0 on success or -1 on error.
1115 =head2 guestfs_set_autosync
1117 int guestfs_set_autosync (guestfs_h *handle,
1120 If C<autosync> is true, this enables autosync. Libguestfs will make a
1121 best effort attempt to run C<guestfs_umount_all> followed by
1122 C<guestfs_sync> when the handle is closed
1123 (also if the program exits without closing handles).
1125 This is disabled by default (except in guestfish where it is
1126 enabled by default).
1128 This function returns 0 on success or -1 on error.
1130 =head2 guestfs_set_busy
1132 int guestfs_set_busy (guestfs_h *handle);
1134 This sets the state to C<BUSY>. This is only used when implementing
1135 actions using the low-level API.
1137 For more information on states, see L<guestfs(3)>.
1139 This function returns 0 on success or -1 on error.
1141 =head2 guestfs_set_e2label
1143 int guestfs_set_e2label (guestfs_h *handle,
1147 This sets the ext2/3/4 filesystem label of the filesystem on
1148 C<device> to C<label>. Filesystem labels are limited to
1151 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
1152 to return the existing label on a filesystem.
1154 This function returns 0 on success or -1 on error.
1156 =head2 guestfs_set_e2uuid
1158 int guestfs_set_e2uuid (guestfs_h *handle,
1162 This sets the ext2/3/4 filesystem UUID of the filesystem on
1163 C<device> to C<uuid>. The format of the UUID and alternatives
1164 such as C<clear>, C<random> and C<time> are described in the
1165 L<tune2fs(8)> manpage.
1167 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
1168 to return the existing UUID of a filesystem.
1170 This function returns 0 on success or -1 on error.
1172 =head2 guestfs_set_path
1174 int guestfs_set_path (guestfs_h *handle,
1177 Set the path that libguestfs searches for kernel and initrd.img.
1179 The default is C<$libdir/guestfs> unless overridden by setting
1180 C<LIBGUESTFS_PATH> environment variable.
1182 The string C<path> is stashed in the libguestfs handle, so the caller
1183 must make sure it remains valid for the lifetime of the handle.
1185 Setting C<path> to C<NULL> restores the default path.
1187 This function returns 0 on success or -1 on error.
1189 =head2 guestfs_set_qemu
1191 int guestfs_set_qemu (guestfs_h *handle,
1194 Set the qemu binary that we will use.
1196 The default is chosen when the library was compiled by the
1199 You can also override this by setting the C<LIBGUESTFS_QEMU>
1200 environment variable.
1202 The string C<qemu> is stashed in the libguestfs handle, so the caller
1203 must make sure it remains valid for the lifetime of the handle.
1205 Setting C<qemu> to C<NULL> restores the default qemu binary.
1207 This function returns 0 on success or -1 on error.
1209 =head2 guestfs_set_ready
1211 int guestfs_set_ready (guestfs_h *handle);
1213 This sets the state to C<READY>. This is only used when implementing
1214 actions using the low-level API.
1216 For more information on states, see L<guestfs(3)>.
1218 This function returns 0 on success or -1 on error.
1220 =head2 guestfs_set_verbose
1222 int guestfs_set_verbose (guestfs_h *handle,
1225 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
1227 Verbose messages are disabled unless the environment variable
1228 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
1230 This function returns 0 on success or -1 on error.
1232 =head2 guestfs_sfdisk
1234 int guestfs_sfdisk (guestfs_h *handle,
1239 char * const* const lines);
1241 This is a direct interface to the L<sfdisk(8)> program for creating
1242 partitions on block devices.
1244 C<device> should be a block device, for example C</dev/sda>.
1246 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1247 and sectors on the device, which are passed directly to sfdisk as
1248 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1249 of these, then the corresponding parameter is omitted. Usually for
1250 'large' disks, you can just pass C<0> for these, but for small
1251 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1252 out the right geometry and you will need to tell it.
1254 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1255 information refer to the L<sfdisk(8)> manpage.
1257 To create a single partition occupying the whole disk, you would
1258 pass C<lines> as a single element list, when the single element being
1259 the string C<,> (comma).
1261 This function returns 0 on success or -1 on error.
1263 B<This command is dangerous. Without careful use you
1264 can easily destroy all your data>.
1268 struct guestfs_stat *guestfs_stat (guestfs_h *handle,
1271 Returns file information for the given C<path>.
1273 This is the same as the C<stat(2)> system call.
1275 This function returns a C<struct guestfs_stat *>
1276 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
1277 or NULL if there was an error.
1278 I<The caller must call C<free> after use>.
1280 =head2 guestfs_statvfs
1282 struct guestfs_statvfs *guestfs_statvfs (guestfs_h *handle,
1285 Returns file system statistics for any mounted file system.
1286 C<path> should be a file or directory in the mounted file system
1287 (typically it is the mount point itself, but it doesn't need to be).
1289 This is the same as the C<statvfs(2)> system call.
1291 This function returns a C<struct guestfs_statvfs *>
1292 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
1293 or NULL if there was an error.
1294 I<The caller must call C<free> after use>.
1298 int guestfs_sync (guestfs_h *handle);
1300 This syncs the disk, so that any writes are flushed through to the
1301 underlying disk image.
1303 You should always call this if you have modified a disk image, before
1306 This function returns 0 on success or -1 on error.
1308 =head2 guestfs_tar_in
1310 int guestfs_tar_in (guestfs_h *handle,
1311 const char *tarfile,
1312 const char *directory);
1314 This command uploads and unpacks local file C<tarfile> (an
1315 I<uncompressed> tar file) into C<directory>.
1317 To upload a compressed tarball, use C<guestfs_tgz_in>.
1319 This function returns 0 on success or -1 on error.
1321 =head2 guestfs_tar_out
1323 int guestfs_tar_out (guestfs_h *handle,
1324 const char *directory,
1325 const char *tarfile);
1327 This command packs the contents of C<directory> and downloads
1328 it to local file C<tarfile>.
1330 To download a compressed tarball, use C<guestfs_tgz_out>.
1332 This function returns 0 on success or -1 on error.
1334 =head2 guestfs_tgz_in
1336 int guestfs_tgz_in (guestfs_h *handle,
1337 const char *tarball,
1338 const char *directory);
1340 This command uploads and unpacks local file C<tarball> (a
1341 I<gzip compressed> tar file) into C<directory>.
1343 To upload an uncompressed tarball, use C<guestfs_tar_in>.
1345 This function returns 0 on success or -1 on error.
1347 =head2 guestfs_tgz_out
1349 int guestfs_tgz_out (guestfs_h *handle,
1350 const char *directory,
1351 const char *tarball);
1353 This command packs the contents of C<directory> and downloads
1354 it to local file C<tarball>.
1356 To download an uncompressed tarball, use C<guestfs_tar_out>.
1358 This function returns 0 on success or -1 on error.
1360 =head2 guestfs_touch
1362 int guestfs_touch (guestfs_h *handle,
1365 Touch acts like the L<touch(1)> command. It can be used to
1366 update the timestamps on a file, or, if the file does not exist,
1367 to create a new zero-length file.
1369 This function returns 0 on success or -1 on error.
1371 =head2 guestfs_tune2fs_l
1373 char **guestfs_tune2fs_l (guestfs_h *handle,
1374 const char *device);
1376 This returns the contents of the ext2, ext3 or ext4 filesystem
1377 superblock on C<device>.
1379 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1380 manpage for more details. The list of fields returned isn't
1381 clearly defined, and depends on both the version of C<tune2fs>
1382 that libguestfs was built against, and the filesystem itself.
1384 This function returns a NULL-terminated array of
1385 strings, or NULL if there was an error.
1386 The array of strings will always have length C<2n+1>, where
1387 C<n> keys and values alternate, followed by the trailing NULL entry.
1388 I<The caller must free the strings and the array after use>.
1390 =head2 guestfs_umount
1392 int guestfs_umount (guestfs_h *handle,
1393 const char *pathordevice);
1395 This unmounts the given filesystem. The filesystem may be
1396 specified either by its mountpoint (path) or the device which
1397 contains the filesystem.
1399 This function returns 0 on success or -1 on error.
1401 =head2 guestfs_umount_all
1403 int guestfs_umount_all (guestfs_h *handle);
1405 This unmounts all mounted filesystems.
1407 Some internal mounts are not unmounted by this call.
1409 This function returns 0 on success or -1 on error.
1411 =head2 guestfs_upload
1413 int guestfs_upload (guestfs_h *handle,
1414 const char *filename,
1415 const char *remotefilename);
1417 Upload local file C<filename> to C<remotefilename> on the
1420 C<filename> can also be a named pipe.
1422 See also C<guestfs_download>.
1424 This function returns 0 on success or -1 on error.
1426 =head2 guestfs_vgcreate
1428 int guestfs_vgcreate (guestfs_h *handle,
1429 const char *volgroup,
1430 char * const* const physvols);
1432 This creates an LVM volume group called C<volgroup>
1433 from the non-empty list of physical volumes C<physvols>.
1435 This function returns 0 on success or -1 on error.
1437 =head2 guestfs_vgremove
1439 int guestfs_vgremove (guestfs_h *handle,
1440 const char *vgname);
1442 Remove an LVM volume group C<vgname>, (for example C<VG>).
1444 This also forcibly removes all logical volumes in the volume
1447 This function returns 0 on success or -1 on error.
1451 char **guestfs_vgs (guestfs_h *handle);
1453 List all the volumes groups detected. This is the equivalent
1454 of the L<vgs(8)> command.
1456 This returns a list of just the volume group names that were
1457 detected (eg. C<VolGroup00>).
1459 See also C<guestfs_vgs_full>.
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 =head2 guestfs_vgs_full
1467 struct guestfs_lvm_vg_list *guestfs_vgs_full (guestfs_h *handle);
1469 List all the volumes groups detected. This is the equivalent
1470 of the L<vgs(8)> command. The "full" version includes all fields.
1472 This function returns a C<struct guestfs_lvm_vg_list *>
1473 (see E<lt>guestfs-structs.hE<gt>),
1474 or NULL if there was an error.
1475 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.
1477 =head2 guestfs_wait_ready
1479 int guestfs_wait_ready (guestfs_h *handle);
1481 Internally libguestfs is implemented by running a virtual machine
1484 You should call this after C<guestfs_launch> to wait for the launch
1487 This function returns 0 on success or -1 on error.
1489 =head2 guestfs_write_file
1491 int guestfs_write_file (guestfs_h *handle,
1493 const char *content,
1496 This call creates a file called C<path>. The contents of the
1497 file is the string C<content> (which can contain any 8 bit data),
1498 with length C<size>.
1500 As a special case, if C<size> is C<0>
1501 then the length is calculated using C<strlen> (so in this case
1502 the content cannot contain embedded ASCII NULs).
1504 This function returns 0 on success or -1 on error.
1506 Because of the message protocol, there is a transfer limit
1507 of somewhere between 2MB and 4MB. To transfer large files you should use