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>.
564 =head2 guestfs_download
566 int guestfs_download (guestfs_h *handle,
567 const char *remotefilename,
568 const char *filename);
570 Download file C<remotefilename> and save it as C<filename>
571 on the local machine.
573 C<filename> can also be a named pipe.
575 See also C<guestfs_upload>, C<guestfs_cat>.
577 This function returns 0 on success or -1 on error.
579 =head2 guestfs_exists
581 int guestfs_exists (guestfs_h *handle,
584 This returns C<true> if and only if there is a file, directory
585 (or anything) with the given C<path> name.
587 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.
589 This function returns a C truth value on success or -1 on error.
593 char *guestfs_file (guestfs_h *handle,
596 This call uses the standard L<file(1)> command to determine
597 the type or contents of the file. This also works on devices,
598 for example to find out whether a partition contains a filesystem.
600 The exact command which runs is C<file -bsL path>. Note in
601 particular that the filename is not prepended to the output
604 This function returns a string, or NULL on error.
605 I<The caller must free the returned string after use>.
609 int guestfs_fsck (guestfs_h *handle,
613 This runs the filesystem checker (fsck) on C<device> which
614 should have filesystem type C<fstype>.
616 The returned integer is the status. See L<fsck(8)> for the
617 list of status codes from C<fsck>.
625 Multiple status codes can be summed together.
629 A non-zero return code can mean "success", for example if
630 errors have been corrected on the filesystem.
634 Checking or repairing NTFS volumes is not supported
639 This command is entirely equivalent to running C<fsck -a -t fstype device>.
641 On error this function returns -1.
643 =head2 guestfs_get_autosync
645 int guestfs_get_autosync (guestfs_h *handle);
647 Get the autosync flag.
649 This function returns a C truth value on success or -1 on error.
651 =head2 guestfs_get_e2label
653 char *guestfs_get_e2label (guestfs_h *handle,
656 This returns the ext2/3/4 filesystem label of the filesystem on
659 This function returns a string, or NULL on error.
660 I<The caller must free the returned string after use>.
662 =head2 guestfs_get_e2uuid
664 char *guestfs_get_e2uuid (guestfs_h *handle,
667 This returns the ext2/3/4 filesystem UUID of the filesystem on
670 This function returns a string, or NULL on error.
671 I<The caller must free the returned string after use>.
673 =head2 guestfs_get_path
675 const char *guestfs_get_path (guestfs_h *handle);
677 Return the current search path.
679 This is always non-NULL. If it wasn't set already, then this will
680 return the default path.
682 This function returns a string, or NULL on error.
683 The string is owned by the guest handle and must I<not> be freed.
685 =head2 guestfs_get_qemu
687 const char *guestfs_get_qemu (guestfs_h *handle);
689 Return the current qemu binary.
691 This is always non-NULL. If it wasn't set already, then this will
692 return the default qemu binary name.
694 This function returns a string, or NULL on error.
695 The string is owned by the guest handle and must I<not> be freed.
697 =head2 guestfs_get_state
699 int guestfs_get_state (guestfs_h *handle);
701 This returns the current state as an opaque integer. This is
702 only useful for printing debug and internal error messages.
704 For more information on states, see L<guestfs(3)>.
706 On error this function returns -1.
708 =head2 guestfs_get_verbose
710 int guestfs_get_verbose (guestfs_h *handle);
712 This returns the verbose messages flag.
714 This function returns a C truth value on success or -1 on error.
716 =head2 guestfs_grub_install
718 int guestfs_grub_install (guestfs_h *handle,
722 This command installs GRUB (the Grand Unified Bootloader) on
723 C<device>, with the root directory being C<root>.
725 This function returns 0 on success or -1 on error.
727 =head2 guestfs_is_busy
729 int guestfs_is_busy (guestfs_h *handle);
731 This returns true iff this handle is busy processing a command
732 (in the C<BUSY> state).
734 For more information on states, see L<guestfs(3)>.
736 This function returns a C truth value on success or -1 on error.
738 =head2 guestfs_is_config
740 int guestfs_is_config (guestfs_h *handle);
742 This returns true iff this handle is being configured
743 (in the C<CONFIG> state).
745 For more information on states, see L<guestfs(3)>.
747 This function returns a C truth value on success or -1 on error.
749 =head2 guestfs_is_dir
751 int guestfs_is_dir (guestfs_h *handle,
754 This returns C<true> if and only if there is a directory
755 with the given C<path> name. Note that it returns false for
756 other objects like files.
758 See also C<guestfs_stat>.
760 This function returns a C truth value on success or -1 on error.
762 =head2 guestfs_is_file
764 int guestfs_is_file (guestfs_h *handle,
767 This returns C<true> if and only if there is a file
768 with the given C<path> name. Note that it returns false for
769 other objects like directories.
771 See also C<guestfs_stat>.
773 This function returns a C truth value on success or -1 on error.
775 =head2 guestfs_is_launching
777 int guestfs_is_launching (guestfs_h *handle);
779 This returns true iff this handle is launching the subprocess
780 (in the C<LAUNCHING> state).
782 For more information on states, see L<guestfs(3)>.
784 This function returns a C truth value on success or -1 on error.
786 =head2 guestfs_is_ready
788 int guestfs_is_ready (guestfs_h *handle);
790 This returns true iff this handle is ready to accept commands
791 (in the C<READY> state).
793 For more information on states, see L<guestfs(3)>.
795 This function returns a C truth value on success or -1 on error.
797 =head2 guestfs_kill_subprocess
799 int guestfs_kill_subprocess (guestfs_h *handle);
801 This kills the qemu subprocess. You should never need to call this.
803 This function returns 0 on success or -1 on error.
805 =head2 guestfs_launch
807 int guestfs_launch (guestfs_h *handle);
809 Internally libguestfs is implemented by running a virtual machine
812 You should call this after configuring the handle
813 (eg. adding drives) but before performing any actions.
815 This function returns 0 on success or -1 on error.
817 =head2 guestfs_list_devices
819 char **guestfs_list_devices (guestfs_h *handle);
821 List all the block devices.
823 The full block device names are returned, eg. C</dev/sda>
825 This function returns a NULL-terminated array of strings
826 (like L<environ(3)>), or NULL if there was an error.
827 I<The caller must free the strings and the array after use>.
829 =head2 guestfs_list_partitions
831 char **guestfs_list_partitions (guestfs_h *handle);
833 List all the partitions detected on all block devices.
835 The full partition device names are returned, eg. C</dev/sda1>
837 This does not return logical volumes. For that you will need to
840 This function returns a NULL-terminated array of strings
841 (like L<environ(3)>), or NULL if there was an error.
842 I<The caller must free the strings and the array after use>.
846 char *guestfs_ll (guestfs_h *handle,
847 const char *directory);
849 List the files in C<directory> (relative to the root directory,
850 there is no cwd) in the format of 'ls -la'.
852 This command is mostly useful for interactive sessions. It
853 is I<not> intended that you try to parse the output string.
855 This function returns a string, or NULL on error.
856 I<The caller must free the returned string after use>.
860 char **guestfs_ls (guestfs_h *handle,
861 const char *directory);
863 List the files in C<directory> (relative to the root directory,
864 there is no cwd). The '.' and '..' entries are not returned, but
865 hidden files are shown.
867 This command is mostly useful for interactive sessions. Programs
868 should probably use C<guestfs_readdir> instead.
870 This function returns a NULL-terminated array of strings
871 (like L<environ(3)>), or NULL if there was an error.
872 I<The caller must free the strings and the array after use>.
876 struct guestfs_stat *guestfs_lstat (guestfs_h *handle,
879 Returns file information for the given C<path>.
881 This is the same as C<guestfs_stat> except that if C<path>
882 is a symbolic link, then the link is stat-ed, not the file it
885 This is the same as the C<lstat(2)> system call.
887 This function returns a C<struct guestfs_stat *>
888 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
889 or NULL if there was an error.
890 I<The caller must call C<free> after use>.
892 =head2 guestfs_lvcreate
894 int guestfs_lvcreate (guestfs_h *handle,
896 const char *volgroup,
899 This creates an LVM volume group called C<logvol>
900 on the volume group C<volgroup>, with C<size> megabytes.
902 This function returns 0 on success or -1 on error.
904 =head2 guestfs_lvm_remove_all
906 int guestfs_lvm_remove_all (guestfs_h *handle);
908 This command removes all LVM logical volumes, volume groups
909 and physical volumes.
911 This function returns 0 on success or -1 on error.
913 B<This command is dangerous. Without careful use you
914 can easily destroy all your data>.
916 =head2 guestfs_lvremove
918 int guestfs_lvremove (guestfs_h *handle,
921 Remove an LVM logical volume C<device>, where C<device> is
922 the path to the LV, such as C</dev/VG/LV>.
924 You can also remove all LVs in a volume group by specifying
925 the VG name, C</dev/VG>.
927 This function returns 0 on success or -1 on error.
931 char **guestfs_lvs (guestfs_h *handle);
933 List all the logical volumes detected. This is the equivalent
934 of the L<lvs(8)> command.
936 This returns a list of the logical volume device names
937 (eg. C</dev/VolGroup00/LogVol00>).
939 See also C<guestfs_lvs_full>.
941 This function returns a NULL-terminated array of strings
942 (like L<environ(3)>), or NULL if there was an error.
943 I<The caller must free the strings and the array after use>.
945 =head2 guestfs_lvs_full
947 struct guestfs_lvm_lv_list *guestfs_lvs_full (guestfs_h *handle);
949 List all the logical volumes detected. This is the equivalent
950 of the L<lvs(8)> command. The "full" version includes all fields.
952 This function returns a C<struct guestfs_lvm_lv_list *>
953 (see E<lt>guestfs-structs.hE<gt>),
954 or NULL if there was an error.
955 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.
959 int guestfs_mkdir (guestfs_h *handle,
962 Create a directory named C<path>.
964 This function returns 0 on success or -1 on error.
966 =head2 guestfs_mkdir_p
968 int guestfs_mkdir_p (guestfs_h *handle,
971 Create a directory named C<path>, creating any parent directories
972 as necessary. This is like the C<mkdir -p> shell command.
974 This function returns 0 on success or -1 on error.
978 int guestfs_mkfs (guestfs_h *handle,
982 This creates a filesystem on C<device> (usually a partition
983 of LVM logical volume). The filesystem type is C<fstype>, for
986 This function returns 0 on success or -1 on error.
990 int guestfs_mount (guestfs_h *handle,
992 const char *mountpoint);
994 Mount a guest disk at a position in the filesystem. Block devices
995 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
996 the guest. If those block devices contain partitions, they will have
997 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
1000 The rules are the same as for L<mount(2)>: A filesystem must
1001 first be mounted on C</> before others can be mounted. Other
1002 filesystems can only be mounted on directories which already
1005 The mounted filesystem is writable, if we have sufficient permissions
1006 on the underlying device.
1008 The filesystem options C<sync> and C<noatime> are set with this
1009 call, in order to improve reliability.
1011 This function returns 0 on success or -1 on error.
1013 =head2 guestfs_mount_options
1015 int guestfs_mount_options (guestfs_h *handle,
1016 const char *options,
1018 const char *mountpoint);
1020 This is the same as the C<guestfs_mount> command, but it
1021 allows you to set the mount options as for the
1022 L<mount(8)> I<-o> flag.
1024 This function returns 0 on success or -1 on error.
1026 =head2 guestfs_mount_ro
1028 int guestfs_mount_ro (guestfs_h *handle,
1030 const char *mountpoint);
1032 This is the same as the C<guestfs_mount> command, but it
1033 mounts the filesystem with the read-only (I<-o ro>) flag.
1035 This function returns 0 on success or -1 on error.
1037 =head2 guestfs_mount_vfs
1039 int guestfs_mount_vfs (guestfs_h *handle,
1040 const char *options,
1041 const char *vfstype,
1043 const char *mountpoint);
1045 This is the same as the C<guestfs_mount> command, but it
1046 allows you to set both the mount options and the vfstype
1047 as for the L<mount(8)> I<-o> and I<-t> flags.
1049 This function returns 0 on success or -1 on error.
1051 =head2 guestfs_mounts
1053 char **guestfs_mounts (guestfs_h *handle);
1055 This returns the list of currently mounted filesystems. It returns
1056 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1058 Some internal mounts are not shown.
1060 This function returns a NULL-terminated array of strings
1061 (like L<environ(3)>), or NULL if there was an error.
1062 I<The caller must free the strings and the array after use>.
1066 int guestfs_mv (guestfs_h *handle,
1070 This moves a file from C<src> to C<dest> where C<dest> is
1071 either a destination filename or destination directory.
1073 This function returns 0 on success or -1 on error.
1075 =head2 guestfs_pvcreate
1077 int guestfs_pvcreate (guestfs_h *handle,
1078 const char *device);
1080 This creates an LVM physical volume on the named C<device>,
1081 where C<device> should usually be a partition name such
1084 This function returns 0 on success or -1 on error.
1086 =head2 guestfs_pvremove
1088 int guestfs_pvremove (guestfs_h *handle,
1089 const char *device);
1091 This wipes a physical volume C<device> so that LVM will no longer
1094 The implementation uses the C<pvremove> command which refuses to
1095 wipe physical volumes that contain any volume groups, so you have
1096 to remove those first.
1098 This function returns 0 on success or -1 on error.
1102 char **guestfs_pvs (guestfs_h *handle);
1104 List all the physical volumes detected. This is the equivalent
1105 of the L<pvs(8)> command.
1107 This returns a list of just the device names that contain
1108 PVs (eg. C</dev/sda2>).
1110 See also C<guestfs_pvs_full>.
1112 This function returns a NULL-terminated array of strings
1113 (like L<environ(3)>), or NULL if there was an error.
1114 I<The caller must free the strings and the array after use>.
1116 =head2 guestfs_pvs_full
1118 struct guestfs_lvm_pv_list *guestfs_pvs_full (guestfs_h *handle);
1120 List all the physical volumes detected. This is the equivalent
1121 of the L<pvs(8)> command. The "full" version includes all fields.
1123 This function returns a C<struct guestfs_lvm_pv_list *>
1124 (see E<lt>guestfs-structs.hE<gt>),
1125 or NULL if there was an error.
1126 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.
1128 =head2 guestfs_read_lines
1130 char **guestfs_read_lines (guestfs_h *handle,
1133 Return the contents of the file named C<path>.
1135 The file contents are returned as a list of lines. Trailing
1136 C<LF> and C<CRLF> character sequences are I<not> returned.
1138 Note that this function cannot correctly handle binary files
1139 (specifically, files containing C<\0> character which is treated
1140 as end of line). For those you need to use the C<guestfs_read_file>
1141 function which has a more complex interface.
1143 This function returns a NULL-terminated array of strings
1144 (like L<environ(3)>), or NULL if there was an error.
1145 I<The caller must free the strings and the array after use>.
1149 int guestfs_rm (guestfs_h *handle,
1152 Remove the single file C<path>.
1154 This function returns 0 on success or -1 on error.
1156 =head2 guestfs_rm_rf
1158 int guestfs_rm_rf (guestfs_h *handle,
1161 Remove the file or directory C<path>, recursively removing the
1162 contents if its a directory. This is like the C<rm -rf> shell
1165 This function returns 0 on success or -1 on error.
1167 =head2 guestfs_rmdir
1169 int guestfs_rmdir (guestfs_h *handle,
1172 Remove the single directory C<path>.
1174 This function returns 0 on success or -1 on error.
1176 =head2 guestfs_set_autosync
1178 int guestfs_set_autosync (guestfs_h *handle,
1181 If C<autosync> is true, this enables autosync. Libguestfs will make a
1182 best effort attempt to run C<guestfs_umount_all> followed by
1183 C<guestfs_sync> when the handle is closed
1184 (also if the program exits without closing handles).
1186 This is disabled by default (except in guestfish where it is
1187 enabled by default).
1189 This function returns 0 on success or -1 on error.
1191 =head2 guestfs_set_busy
1193 int guestfs_set_busy (guestfs_h *handle);
1195 This sets the state to C<BUSY>. This is only used when implementing
1196 actions using the low-level API.
1198 For more information on states, see L<guestfs(3)>.
1200 This function returns 0 on success or -1 on error.
1202 =head2 guestfs_set_e2label
1204 int guestfs_set_e2label (guestfs_h *handle,
1208 This sets the ext2/3/4 filesystem label of the filesystem on
1209 C<device> to C<label>. Filesystem labels are limited to
1212 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
1213 to return the existing label on a filesystem.
1215 This function returns 0 on success or -1 on error.
1217 =head2 guestfs_set_e2uuid
1219 int guestfs_set_e2uuid (guestfs_h *handle,
1223 This sets the ext2/3/4 filesystem UUID of the filesystem on
1224 C<device> to C<uuid>. The format of the UUID and alternatives
1225 such as C<clear>, C<random> and C<time> are described in the
1226 L<tune2fs(8)> manpage.
1228 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
1229 to return the existing UUID of a filesystem.
1231 This function returns 0 on success or -1 on error.
1233 =head2 guestfs_set_path
1235 int guestfs_set_path (guestfs_h *handle,
1238 Set the path that libguestfs searches for kernel and initrd.img.
1240 The default is C<$libdir/guestfs> unless overridden by setting
1241 C<LIBGUESTFS_PATH> environment variable.
1243 The string C<path> is stashed in the libguestfs handle, so the caller
1244 must make sure it remains valid for the lifetime of the handle.
1246 Setting C<path> to C<NULL> restores the default path.
1248 This function returns 0 on success or -1 on error.
1250 =head2 guestfs_set_qemu
1252 int guestfs_set_qemu (guestfs_h *handle,
1255 Set the qemu binary that we will use.
1257 The default is chosen when the library was compiled by the
1260 You can also override this by setting the C<LIBGUESTFS_QEMU>
1261 environment variable.
1263 The string C<qemu> is stashed in the libguestfs handle, so the caller
1264 must make sure it remains valid for the lifetime of the handle.
1266 Setting C<qemu> to C<NULL> restores the default qemu binary.
1268 This function returns 0 on success or -1 on error.
1270 =head2 guestfs_set_ready
1272 int guestfs_set_ready (guestfs_h *handle);
1274 This sets the state to C<READY>. This is only used when implementing
1275 actions using the low-level API.
1277 For more information on states, see L<guestfs(3)>.
1279 This function returns 0 on success or -1 on error.
1281 =head2 guestfs_set_verbose
1283 int guestfs_set_verbose (guestfs_h *handle,
1286 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
1288 Verbose messages are disabled unless the environment variable
1289 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
1291 This function returns 0 on success or -1 on error.
1293 =head2 guestfs_sfdisk
1295 int guestfs_sfdisk (guestfs_h *handle,
1300 char * const* const lines);
1302 This is a direct interface to the L<sfdisk(8)> program for creating
1303 partitions on block devices.
1305 C<device> should be a block device, for example C</dev/sda>.
1307 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1308 and sectors on the device, which are passed directly to sfdisk as
1309 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1310 of these, then the corresponding parameter is omitted. Usually for
1311 'large' disks, you can just pass C<0> for these, but for small
1312 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1313 out the right geometry and you will need to tell it.
1315 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1316 information refer to the L<sfdisk(8)> manpage.
1318 To create a single partition occupying the whole disk, you would
1319 pass C<lines> as a single element list, when the single element being
1320 the string C<,> (comma).
1322 This function returns 0 on success or -1 on error.
1324 B<This command is dangerous. Without careful use you
1325 can easily destroy all your data>.
1329 struct guestfs_stat *guestfs_stat (guestfs_h *handle,
1332 Returns file information for the given C<path>.
1334 This is the same as the C<stat(2)> system call.
1336 This function returns a C<struct guestfs_stat *>
1337 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
1338 or NULL if there was an error.
1339 I<The caller must call C<free> after use>.
1341 =head2 guestfs_statvfs
1343 struct guestfs_statvfs *guestfs_statvfs (guestfs_h *handle,
1346 Returns file system statistics for any mounted file system.
1347 C<path> should be a file or directory in the mounted file system
1348 (typically it is the mount point itself, but it doesn't need to be).
1350 This is the same as the C<statvfs(2)> system call.
1352 This function returns a C<struct guestfs_statvfs *>
1353 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
1354 or NULL if there was an error.
1355 I<The caller must call C<free> after use>.
1359 int guestfs_sync (guestfs_h *handle);
1361 This syncs the disk, so that any writes are flushed through to the
1362 underlying disk image.
1364 You should always call this if you have modified a disk image, before
1367 This function returns 0 on success or -1 on error.
1369 =head2 guestfs_tar_in
1371 int guestfs_tar_in (guestfs_h *handle,
1372 const char *tarfile,
1373 const char *directory);
1375 This command uploads and unpacks local file C<tarfile> (an
1376 I<uncompressed> tar file) into C<directory>.
1378 To upload a compressed tarball, use C<guestfs_tgz_in>.
1380 This function returns 0 on success or -1 on error.
1382 =head2 guestfs_tar_out
1384 int guestfs_tar_out (guestfs_h *handle,
1385 const char *directory,
1386 const char *tarfile);
1388 This command packs the contents of C<directory> and downloads
1389 it to local file C<tarfile>.
1391 To download a compressed tarball, use C<guestfs_tgz_out>.
1393 This function returns 0 on success or -1 on error.
1395 =head2 guestfs_tgz_in
1397 int guestfs_tgz_in (guestfs_h *handle,
1398 const char *tarball,
1399 const char *directory);
1401 This command uploads and unpacks local file C<tarball> (a
1402 I<gzip compressed> tar file) into C<directory>.
1404 To upload an uncompressed tarball, use C<guestfs_tar_in>.
1406 This function returns 0 on success or -1 on error.
1408 =head2 guestfs_tgz_out
1410 int guestfs_tgz_out (guestfs_h *handle,
1411 const char *directory,
1412 const char *tarball);
1414 This command packs the contents of C<directory> and downloads
1415 it to local file C<tarball>.
1417 To download an uncompressed tarball, use C<guestfs_tar_out>.
1419 This function returns 0 on success or -1 on error.
1421 =head2 guestfs_touch
1423 int guestfs_touch (guestfs_h *handle,
1426 Touch acts like the L<touch(1)> command. It can be used to
1427 update the timestamps on a file, or, if the file does not exist,
1428 to create a new zero-length file.
1430 This function returns 0 on success or -1 on error.
1432 =head2 guestfs_tune2fs_l
1434 char **guestfs_tune2fs_l (guestfs_h *handle,
1435 const char *device);
1437 This returns the contents of the ext2, ext3 or ext4 filesystem
1438 superblock on C<device>.
1440 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1441 manpage for more details. The list of fields returned isn't
1442 clearly defined, and depends on both the version of C<tune2fs>
1443 that libguestfs was built against, and the filesystem itself.
1445 This function returns a NULL-terminated array of
1446 strings, or NULL if there was an error.
1447 The array of strings will always have length C<2n+1>, where
1448 C<n> keys and values alternate, followed by the trailing NULL entry.
1449 I<The caller must free the strings and the array after use>.
1451 =head2 guestfs_umount
1453 int guestfs_umount (guestfs_h *handle,
1454 const char *pathordevice);
1456 This unmounts the given filesystem. The filesystem may be
1457 specified either by its mountpoint (path) or the device which
1458 contains the filesystem.
1460 This function returns 0 on success or -1 on error.
1462 =head2 guestfs_umount_all
1464 int guestfs_umount_all (guestfs_h *handle);
1466 This unmounts all mounted filesystems.
1468 Some internal mounts are not unmounted by this call.
1470 This function returns 0 on success or -1 on error.
1472 =head2 guestfs_upload
1474 int guestfs_upload (guestfs_h *handle,
1475 const char *filename,
1476 const char *remotefilename);
1478 Upload local file C<filename> to C<remotefilename> on the
1481 C<filename> can also be a named pipe.
1483 See also C<guestfs_download>.
1485 This function returns 0 on success or -1 on error.
1487 =head2 guestfs_vgcreate
1489 int guestfs_vgcreate (guestfs_h *handle,
1490 const char *volgroup,
1491 char * const* const physvols);
1493 This creates an LVM volume group called C<volgroup>
1494 from the non-empty list of physical volumes C<physvols>.
1496 This function returns 0 on success or -1 on error.
1498 =head2 guestfs_vgremove
1500 int guestfs_vgremove (guestfs_h *handle,
1501 const char *vgname);
1503 Remove an LVM volume group C<vgname>, (for example C<VG>).
1505 This also forcibly removes all logical volumes in the volume
1508 This function returns 0 on success or -1 on error.
1512 char **guestfs_vgs (guestfs_h *handle);
1514 List all the volumes groups detected. This is the equivalent
1515 of the L<vgs(8)> command.
1517 This returns a list of just the volume group names that were
1518 detected (eg. C<VolGroup00>).
1520 See also C<guestfs_vgs_full>.
1522 This function returns a NULL-terminated array of strings
1523 (like L<environ(3)>), or NULL if there was an error.
1524 I<The caller must free the strings and the array after use>.
1526 =head2 guestfs_vgs_full
1528 struct guestfs_lvm_vg_list *guestfs_vgs_full (guestfs_h *handle);
1530 List all the volumes groups detected. This is the equivalent
1531 of the L<vgs(8)> command. The "full" version includes all fields.
1533 This function returns a C<struct guestfs_lvm_vg_list *>
1534 (see E<lt>guestfs-structs.hE<gt>),
1535 or NULL if there was an error.
1536 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.
1538 =head2 guestfs_wait_ready
1540 int guestfs_wait_ready (guestfs_h *handle);
1542 Internally libguestfs is implemented by running a virtual machine
1545 You should call this after C<guestfs_launch> to wait for the launch
1548 This function returns 0 on success or -1 on error.
1550 =head2 guestfs_write_file
1552 int guestfs_write_file (guestfs_h *handle,
1554 const char *content,
1557 This call creates a file called C<path>. The contents of the
1558 file is the string C<content> (which can contain any 8 bit data),
1559 with length C<size>.
1561 As a special case, if C<size> is C<0>
1562 then the length is calculated using C<strlen> (so in this case
1563 the content cannot contain embedded ASCII NULs).
1565 This function returns 0 on success or -1 on error.
1567 Because of the message protocol, there is a transfer limit
1568 of somewhere between 2MB and 4MB. To transfer large files you should use
1573 int guestfs_zero (guestfs_h *handle,
1574 const char *device);
1576 This command writes zeroes over the first few blocks of C<device>.
1578 How many blocks are zeroed isn't specified (but it's I<not> enough
1579 to securely wipe the device). It should be sufficient to remove
1580 any partition tables, filesystem superblocks and so on.
1582 This function returns 0 on success or -1 on error.