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.
525 =head2 guestfs_download
527 int guestfs_download (guestfs_h *handle,
528 const char *remotefilename,
529 const char *filename);
531 Download file C<remotefilename> and save it as C<filename>
532 on the local machine.
534 C<filename> can also be a named pipe.
536 See also C<guestfs_upload>, C<guestfs_cat>.
538 This function returns 0 on success or -1 on error.
540 =head2 guestfs_exists
542 int guestfs_exists (guestfs_h *handle,
545 This returns C<true> if and only if there is a file, directory
546 (or anything) with the given C<path> name.
548 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.
550 This function returns a C truth value on success or -1 on error.
554 char *guestfs_file (guestfs_h *handle,
557 This call uses the standard L<file(1)> command to determine
558 the type or contents of the file. This also works on devices,
559 for example to find out whether a partition contains a filesystem.
561 The exact command which runs is C<file -bsL path>. Note in
562 particular that the filename is not prepended to the output
565 This function returns a string, or NULL on error.
566 I<The caller must free the returned string after use>.
568 =head2 guestfs_get_autosync
570 int guestfs_get_autosync (guestfs_h *handle);
572 Get the autosync flag.
574 This function returns a C truth value on success or -1 on error.
576 =head2 guestfs_get_path
578 const char *guestfs_get_path (guestfs_h *handle);
580 Return the current search path.
582 This is always non-NULL. If it wasn't set already, then this will
583 return the default path.
585 This function returns a string, or NULL on error.
586 The string is owned by the guest handle and must I<not> be freed.
588 =head2 guestfs_get_state
590 int guestfs_get_state (guestfs_h *handle);
592 This returns the current state as an opaque integer. This is
593 only useful for printing debug and internal error messages.
595 For more information on states, see L<guestfs(3)>.
597 On error this function returns -1.
599 =head2 guestfs_get_verbose
601 int guestfs_get_verbose (guestfs_h *handle);
603 This returns the verbose messages flag.
605 This function returns a C truth value on success or -1 on error.
607 =head2 guestfs_is_busy
609 int guestfs_is_busy (guestfs_h *handle);
611 This returns true iff this handle is busy processing a command
612 (in the C<BUSY> state).
614 For more information on states, see L<guestfs(3)>.
616 This function returns a C truth value on success or -1 on error.
618 =head2 guestfs_is_config
620 int guestfs_is_config (guestfs_h *handle);
622 This returns true iff this handle is being configured
623 (in the C<CONFIG> state).
625 For more information on states, see L<guestfs(3)>.
627 This function returns a C truth value on success or -1 on error.
629 =head2 guestfs_is_dir
631 int guestfs_is_dir (guestfs_h *handle,
634 This returns C<true> if and only if there is a directory
635 with the given C<path> name. Note that it returns false for
636 other objects like files.
638 See also C<guestfs_stat>.
640 This function returns a C truth value on success or -1 on error.
642 =head2 guestfs_is_file
644 int guestfs_is_file (guestfs_h *handle,
647 This returns C<true> if and only if there is a file
648 with the given C<path> name. Note that it returns false for
649 other objects like directories.
651 See also C<guestfs_stat>.
653 This function returns a C truth value on success or -1 on error.
655 =head2 guestfs_is_launching
657 int guestfs_is_launching (guestfs_h *handle);
659 This returns true iff this handle is launching the subprocess
660 (in the C<LAUNCHING> state).
662 For more information on states, see L<guestfs(3)>.
664 This function returns a C truth value on success or -1 on error.
666 =head2 guestfs_is_ready
668 int guestfs_is_ready (guestfs_h *handle);
670 This returns true iff this handle is ready to accept commands
671 (in the C<READY> state).
673 For more information on states, see L<guestfs(3)>.
675 This function returns a C truth value on success or -1 on error.
677 =head2 guestfs_kill_subprocess
679 int guestfs_kill_subprocess (guestfs_h *handle);
681 This kills the qemu subprocess. You should never need to call this.
683 This function returns 0 on success or -1 on error.
685 =head2 guestfs_launch
687 int guestfs_launch (guestfs_h *handle);
689 Internally libguestfs is implemented by running a virtual machine
692 You should call this after configuring the handle
693 (eg. adding drives) but before performing any actions.
695 This function returns 0 on success or -1 on error.
697 =head2 guestfs_list_devices
699 char **guestfs_list_devices (guestfs_h *handle);
701 List all the block devices.
703 The full block device names are returned, eg. C</dev/sda>
705 This function returns a NULL-terminated array of strings
706 (like L<environ(3)>), or NULL if there was an error.
707 I<The caller must free the strings and the array after use>.
709 =head2 guestfs_list_partitions
711 char **guestfs_list_partitions (guestfs_h *handle);
713 List all the partitions detected on all block devices.
715 The full partition device names are returned, eg. C</dev/sda1>
717 This does not return logical volumes. For that you will need to
720 This function returns a NULL-terminated array of strings
721 (like L<environ(3)>), or NULL if there was an error.
722 I<The caller must free the strings and the array after use>.
726 char *guestfs_ll (guestfs_h *handle,
727 const char *directory);
729 List the files in C<directory> (relative to the root directory,
730 there is no cwd) in the format of 'ls -la'.
732 This command is mostly useful for interactive sessions. It
733 is I<not> intended that you try to parse the output string.
735 This function returns a string, or NULL on error.
736 I<The caller must free the returned string after use>.
740 char **guestfs_ls (guestfs_h *handle,
741 const char *directory);
743 List the files in C<directory> (relative to the root directory,
744 there is no cwd). The '.' and '..' entries are not returned, but
745 hidden files are shown.
747 This command is mostly useful for interactive sessions. Programs
748 should probably use C<guestfs_readdir> instead.
750 This function returns a NULL-terminated array of strings
751 (like L<environ(3)>), or NULL if there was an error.
752 I<The caller must free the strings and the array after use>.
756 struct guestfs_stat *guestfs_lstat (guestfs_h *handle,
759 Returns file information for the given C<path>.
761 This is the same as C<guestfs_stat> except that if C<path>
762 is a symbolic link, then the link is stat-ed, not the file it
765 This is the same as the C<lstat(2)> system call.
767 This function returns a C<struct guestfs_stat *>
768 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
769 or NULL if there was an error.
770 I<The caller must call C<free> after use>.
772 =head2 guestfs_lvcreate
774 int guestfs_lvcreate (guestfs_h *handle,
776 const char *volgroup,
779 This creates an LVM volume group called C<logvol>
780 on the volume group C<volgroup>, with C<size> megabytes.
782 This function returns 0 on success or -1 on error.
784 =head2 guestfs_lvm_remove_all
786 int guestfs_lvm_remove_all (guestfs_h *handle);
788 This command removes all LVM logical volumes, volume groups
789 and physical volumes.
791 This function returns 0 on success or -1 on error.
793 B<This command is dangerous. Without careful use you
794 can easily destroy all your data>.
798 char **guestfs_lvs (guestfs_h *handle);
800 List all the logical volumes detected. This is the equivalent
801 of the L<lvs(8)> command.
803 This returns a list of the logical volume device names
804 (eg. C</dev/VolGroup00/LogVol00>).
806 See also C<guestfs_lvs_full>.
808 This function returns a NULL-terminated array of strings
809 (like L<environ(3)>), or NULL if there was an error.
810 I<The caller must free the strings and the array after use>.
812 =head2 guestfs_lvs_full
814 struct guestfs_lvm_lv_list *guestfs_lvs_full (guestfs_h *handle);
816 List all the logical volumes detected. This is the equivalent
817 of the L<lvs(8)> command. The "full" version includes all fields.
819 This function returns a C<struct guestfs_lvm_lv_list *>
820 (see E<lt>guestfs-structs.hE<gt>),
821 or NULL if there was an error.
822 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.
826 int guestfs_mkdir (guestfs_h *handle,
829 Create a directory named C<path>.
831 This function returns 0 on success or -1 on error.
833 =head2 guestfs_mkdir_p
835 int guestfs_mkdir_p (guestfs_h *handle,
838 Create a directory named C<path>, creating any parent directories
839 as necessary. This is like the C<mkdir -p> shell command.
841 This function returns 0 on success or -1 on error.
845 int guestfs_mkfs (guestfs_h *handle,
849 This creates a filesystem on C<device> (usually a partition
850 of LVM logical volume). The filesystem type is C<fstype>, for
853 This function returns 0 on success or -1 on error.
857 int guestfs_mount (guestfs_h *handle,
859 const char *mountpoint);
861 Mount a guest disk at a position in the filesystem. Block devices
862 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
863 the guest. If those block devices contain partitions, they will have
864 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
867 The rules are the same as for L<mount(2)>: A filesystem must
868 first be mounted on C</> before others can be mounted. Other
869 filesystems can only be mounted on directories which already
872 The mounted filesystem is writable, if we have sufficient permissions
873 on the underlying device.
875 The filesystem options C<sync> and C<noatime> are set with this
876 call, in order to improve reliability.
878 This function returns 0 on success or -1 on error.
880 =head2 guestfs_mounts
882 char **guestfs_mounts (guestfs_h *handle);
884 This returns the list of currently mounted filesystems. It returns
885 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
887 Some internal mounts are not shown.
889 This function returns a NULL-terminated array of strings
890 (like L<environ(3)>), or NULL if there was an error.
891 I<The caller must free the strings and the array after use>.
893 =head2 guestfs_pvcreate
895 int guestfs_pvcreate (guestfs_h *handle,
898 This creates an LVM physical volume on the named C<device>,
899 where C<device> should usually be a partition name such
902 This function returns 0 on success or -1 on error.
906 char **guestfs_pvs (guestfs_h *handle);
908 List all the physical volumes detected. This is the equivalent
909 of the L<pvs(8)> command.
911 This returns a list of just the device names that contain
912 PVs (eg. C</dev/sda2>).
914 See also C<guestfs_pvs_full>.
916 This function returns a NULL-terminated array of strings
917 (like L<environ(3)>), or NULL if there was an error.
918 I<The caller must free the strings and the array after use>.
920 =head2 guestfs_pvs_full
922 struct guestfs_lvm_pv_list *guestfs_pvs_full (guestfs_h *handle);
924 List all the physical volumes detected. This is the equivalent
925 of the L<pvs(8)> command. The "full" version includes all fields.
927 This function returns a C<struct guestfs_lvm_pv_list *>
928 (see E<lt>guestfs-structs.hE<gt>),
929 or NULL if there was an error.
930 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.
932 =head2 guestfs_read_lines
934 char **guestfs_read_lines (guestfs_h *handle,
937 Return the contents of the file named C<path>.
939 The file contents are returned as a list of lines. Trailing
940 C<LF> and C<CRLF> character sequences are I<not> returned.
942 Note that this function cannot correctly handle binary files
943 (specifically, files containing C<\0> character which is treated
944 as end of line). For those you need to use the C<guestfs_read_file>
945 function which has a more complex interface.
947 This function returns a NULL-terminated array of strings
948 (like L<environ(3)>), or NULL if there was an error.
949 I<The caller must free the strings and the array after use>.
953 int guestfs_rm (guestfs_h *handle,
956 Remove the single file C<path>.
958 This function returns 0 on success or -1 on error.
962 int guestfs_rm_rf (guestfs_h *handle,
965 Remove the file or directory C<path>, recursively removing the
966 contents if its a directory. This is like the C<rm -rf> shell
969 This function returns 0 on success or -1 on error.
973 int guestfs_rmdir (guestfs_h *handle,
976 Remove the single directory C<path>.
978 This function returns 0 on success or -1 on error.
980 =head2 guestfs_set_autosync
982 int guestfs_set_autosync (guestfs_h *handle,
985 If C<autosync> is true, this enables autosync. Libguestfs will make a
986 best effort attempt to run C<guestfs_sync> when the handle is closed
987 (also if the program exits without closing handles).
989 This function returns 0 on success or -1 on error.
991 =head2 guestfs_set_busy
993 int guestfs_set_busy (guestfs_h *handle);
995 This sets the state to C<BUSY>. This is only used when implementing
996 actions using the low-level API.
998 For more information on states, see L<guestfs(3)>.
1000 This function returns 0 on success or -1 on error.
1002 =head2 guestfs_set_path
1004 int guestfs_set_path (guestfs_h *handle,
1007 Set the path that libguestfs searches for kernel and initrd.img.
1009 The default is C<$libdir/guestfs> unless overridden by setting
1010 C<LIBGUESTFS_PATH> environment variable.
1012 The string C<path> is stashed in the libguestfs handle, so the caller
1013 must make sure it remains valid for the lifetime of the handle.
1015 Setting C<path> to C<NULL> restores the default path.
1017 This function returns 0 on success or -1 on error.
1019 =head2 guestfs_set_ready
1021 int guestfs_set_ready (guestfs_h *handle);
1023 This sets the state to C<READY>. This is only used when implementing
1024 actions using the low-level API.
1026 For more information on states, see L<guestfs(3)>.
1028 This function returns 0 on success or -1 on error.
1030 =head2 guestfs_set_verbose
1032 int guestfs_set_verbose (guestfs_h *handle,
1035 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
1037 Verbose messages are disabled unless the environment variable
1038 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
1040 This function returns 0 on success or -1 on error.
1042 =head2 guestfs_sfdisk
1044 int guestfs_sfdisk (guestfs_h *handle,
1049 char * const* const lines);
1051 This is a direct interface to the L<sfdisk(8)> program for creating
1052 partitions on block devices.
1054 C<device> should be a block device, for example C</dev/sda>.
1056 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1057 and sectors on the device, which are passed directly to sfdisk as
1058 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1059 of these, then the corresponding parameter is omitted. Usually for
1060 'large' disks, you can just pass C<0> for these, but for small
1061 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1062 out the right geometry and you will need to tell it.
1064 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1065 information refer to the L<sfdisk(8)> manpage.
1067 To create a single partition occupying the whole disk, you would
1068 pass C<lines> as a single element list, when the single element being
1069 the string C<,> (comma).
1071 This function returns 0 on success or -1 on error.
1073 B<This command is dangerous. Without careful use you
1074 can easily destroy all your data>.
1078 struct guestfs_stat *guestfs_stat (guestfs_h *handle,
1081 Returns file information for the given C<path>.
1083 This is the same as the C<stat(2)> system call.
1085 This function returns a C<struct guestfs_stat *>
1086 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
1087 or NULL if there was an error.
1088 I<The caller must call C<free> after use>.
1090 =head2 guestfs_statvfs
1092 struct guestfs_statvfs *guestfs_statvfs (guestfs_h *handle,
1095 Returns file system statistics for any mounted file system.
1096 C<path> should be a file or directory in the mounted file system
1097 (typically it is the mount point itself, but it doesn't need to be).
1099 This is the same as the C<statvfs(2)> system call.
1101 This function returns a C<struct guestfs_statvfs *>
1102 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
1103 or NULL if there was an error.
1104 I<The caller must call C<free> after use>.
1108 int guestfs_sync (guestfs_h *handle);
1110 This syncs the disk, so that any writes are flushed through to the
1111 underlying disk image.
1113 You should always call this if you have modified a disk image, before
1116 This function returns 0 on success or -1 on error.
1118 =head2 guestfs_tar_in
1120 int guestfs_tar_in (guestfs_h *handle,
1121 const char *tarfile,
1122 const char *directory);
1124 This command uploads and unpacks local file C<tarfile> (an
1125 I<uncompressed> tar file) into C<directory>.
1127 To upload a compressed tarball, use C<guestfs_tgz_in>.
1129 This function returns 0 on success or -1 on error.
1131 =head2 guestfs_tar_out
1133 int guestfs_tar_out (guestfs_h *handle,
1134 const char *directory,
1135 const char *tarfile);
1137 This command packs the contents of C<directory> and downloads
1138 it to local file C<tarfile>.
1140 To download a compressed tarball, use C<guestfs_tgz_out>.
1142 This function returns 0 on success or -1 on error.
1144 =head2 guestfs_tgz_in
1146 int guestfs_tgz_in (guestfs_h *handle,
1147 const char *tarball,
1148 const char *directory);
1150 This command uploads and unpacks local file C<tarball> (a
1151 I<gzip compressed> tar file) into C<directory>.
1153 To upload an uncompressed tarball, use C<guestfs_tar_in>.
1155 This function returns 0 on success or -1 on error.
1157 =head2 guestfs_tgz_out
1159 int guestfs_tgz_out (guestfs_h *handle,
1160 const char *directory,
1161 const char *tarball);
1163 This command packs the contents of C<directory> and downloads
1164 it to local file C<tarball>.
1166 To download an uncompressed tarball, use C<guestfs_tar_out>.
1168 This function returns 0 on success or -1 on error.
1170 =head2 guestfs_touch
1172 int guestfs_touch (guestfs_h *handle,
1175 Touch acts like the L<touch(1)> command. It can be used to
1176 update the timestamps on a file, or, if the file does not exist,
1177 to create a new zero-length file.
1179 This function returns 0 on success or -1 on error.
1181 =head2 guestfs_tune2fs_l
1183 char **guestfs_tune2fs_l (guestfs_h *handle,
1184 const char *device);
1186 This returns the contents of the ext2 or ext3 filesystem superblock
1189 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1190 manpage for more details. The list of fields returned isn't
1191 clearly defined, and depends on both the version of C<tune2fs>
1192 that libguestfs was built against, and the filesystem itself.
1194 This function returns a NULL-terminated array of
1195 strings, or NULL if there was an error.
1196 The array of strings will always have length C<2n+1>, where
1197 C<n> keys and values alternate, followed by the trailing NULL entry.
1198 I<The caller must free the strings and the array after use>.
1200 =head2 guestfs_umount
1202 int guestfs_umount (guestfs_h *handle,
1203 const char *pathordevice);
1205 This unmounts the given filesystem. The filesystem may be
1206 specified either by its mountpoint (path) or the device which
1207 contains the filesystem.
1209 This function returns 0 on success or -1 on error.
1211 =head2 guestfs_umount_all
1213 int guestfs_umount_all (guestfs_h *handle);
1215 This unmounts all mounted filesystems.
1217 Some internal mounts are not unmounted by this call.
1219 This function returns 0 on success or -1 on error.
1221 =head2 guestfs_upload
1223 int guestfs_upload (guestfs_h *handle,
1224 const char *filename,
1225 const char *remotefilename);
1227 Upload local file C<filename> to C<remotefilename> on the
1230 C<filename> can also be a named pipe.
1232 See also C<guestfs_download>.
1234 This function returns 0 on success or -1 on error.
1236 =head2 guestfs_vgcreate
1238 int guestfs_vgcreate (guestfs_h *handle,
1239 const char *volgroup,
1240 char * const* const physvols);
1242 This creates an LVM volume group called C<volgroup>
1243 from the non-empty list of physical volumes C<physvols>.
1245 This function returns 0 on success or -1 on error.
1249 char **guestfs_vgs (guestfs_h *handle);
1251 List all the volumes groups detected. This is the equivalent
1252 of the L<vgs(8)> command.
1254 This returns a list of just the volume group names that were
1255 detected (eg. C<VolGroup00>).
1257 See also C<guestfs_vgs_full>.
1259 This function returns a NULL-terminated array of strings
1260 (like L<environ(3)>), or NULL if there was an error.
1261 I<The caller must free the strings and the array after use>.
1263 =head2 guestfs_vgs_full
1265 struct guestfs_lvm_vg_list *guestfs_vgs_full (guestfs_h *handle);
1267 List all the volumes groups detected. This is the equivalent
1268 of the L<vgs(8)> command. The "full" version includes all fields.
1270 This function returns a C<struct guestfs_lvm_vg_list *>
1271 (see E<lt>guestfs-structs.hE<gt>),
1272 or NULL if there was an error.
1273 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.
1275 =head2 guestfs_wait_ready
1277 int guestfs_wait_ready (guestfs_h *handle);
1279 Internally libguestfs is implemented by running a virtual machine
1282 You should call this after C<guestfs_launch> to wait for the launch
1285 This function returns 0 on success or -1 on error.
1287 =head2 guestfs_write_file
1289 int guestfs_write_file (guestfs_h *handle,
1291 const char *content,
1294 This call creates a file called C<path>. The contents of the
1295 file is the string C<content> (which can contain any 8 bit data),
1296 with length C<size>.
1298 As a special case, if C<size> is C<0>
1299 then the length is calculated using C<strlen> (so in this case
1300 the content cannot contain embedded ASCII NULs).
1302 This function returns 0 on success or -1 on error.
1304 Because of the message protocol, there is a transfer limit
1305 of somewhere between 2MB and 4MB. To transfer large files you should use