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_qemu
590 const char *guestfs_get_qemu (guestfs_h *handle);
592 Return the current qemu binary.
594 This is always non-NULL. If it wasn't set already, then this will
595 return the default qemu binary name.
597 This function returns a string, or NULL on error.
598 The string is owned by the guest handle and must I<not> be freed.
600 =head2 guestfs_get_state
602 int guestfs_get_state (guestfs_h *handle);
604 This returns the current state as an opaque integer. This is
605 only useful for printing debug and internal error messages.
607 For more information on states, see L<guestfs(3)>.
609 On error this function returns -1.
611 =head2 guestfs_get_verbose
613 int guestfs_get_verbose (guestfs_h *handle);
615 This returns the verbose messages flag.
617 This function returns a C truth value on success or -1 on error.
619 =head2 guestfs_is_busy
621 int guestfs_is_busy (guestfs_h *handle);
623 This returns true iff this handle is busy processing a command
624 (in the C<BUSY> state).
626 For more information on states, see L<guestfs(3)>.
628 This function returns a C truth value on success or -1 on error.
630 =head2 guestfs_is_config
632 int guestfs_is_config (guestfs_h *handle);
634 This returns true iff this handle is being configured
635 (in the C<CONFIG> state).
637 For more information on states, see L<guestfs(3)>.
639 This function returns a C truth value on success or -1 on error.
641 =head2 guestfs_is_dir
643 int guestfs_is_dir (guestfs_h *handle,
646 This returns C<true> if and only if there is a directory
647 with the given C<path> name. Note that it returns false for
648 other objects like files.
650 See also C<guestfs_stat>.
652 This function returns a C truth value on success or -1 on error.
654 =head2 guestfs_is_file
656 int guestfs_is_file (guestfs_h *handle,
659 This returns C<true> if and only if there is a file
660 with the given C<path> name. Note that it returns false for
661 other objects like directories.
663 See also C<guestfs_stat>.
665 This function returns a C truth value on success or -1 on error.
667 =head2 guestfs_is_launching
669 int guestfs_is_launching (guestfs_h *handle);
671 This returns true iff this handle is launching the subprocess
672 (in the C<LAUNCHING> state).
674 For more information on states, see L<guestfs(3)>.
676 This function returns a C truth value on success or -1 on error.
678 =head2 guestfs_is_ready
680 int guestfs_is_ready (guestfs_h *handle);
682 This returns true iff this handle is ready to accept commands
683 (in the C<READY> state).
685 For more information on states, see L<guestfs(3)>.
687 This function returns a C truth value on success or -1 on error.
689 =head2 guestfs_kill_subprocess
691 int guestfs_kill_subprocess (guestfs_h *handle);
693 This kills the qemu subprocess. You should never need to call this.
695 This function returns 0 on success or -1 on error.
697 =head2 guestfs_launch
699 int guestfs_launch (guestfs_h *handle);
701 Internally libguestfs is implemented by running a virtual machine
704 You should call this after configuring the handle
705 (eg. adding drives) but before performing any actions.
707 This function returns 0 on success or -1 on error.
709 =head2 guestfs_list_devices
711 char **guestfs_list_devices (guestfs_h *handle);
713 List all the block devices.
715 The full block device names are returned, eg. C</dev/sda>
717 This function returns a NULL-terminated array of strings
718 (like L<environ(3)>), or NULL if there was an error.
719 I<The caller must free the strings and the array after use>.
721 =head2 guestfs_list_partitions
723 char **guestfs_list_partitions (guestfs_h *handle);
725 List all the partitions detected on all block devices.
727 The full partition device names are returned, eg. C</dev/sda1>
729 This does not return logical volumes. For that you will need to
732 This function returns a NULL-terminated array of strings
733 (like L<environ(3)>), or NULL if there was an error.
734 I<The caller must free the strings and the array after use>.
738 char *guestfs_ll (guestfs_h *handle,
739 const char *directory);
741 List the files in C<directory> (relative to the root directory,
742 there is no cwd) in the format of 'ls -la'.
744 This command is mostly useful for interactive sessions. It
745 is I<not> intended that you try to parse the output string.
747 This function returns a string, or NULL on error.
748 I<The caller must free the returned string after use>.
752 char **guestfs_ls (guestfs_h *handle,
753 const char *directory);
755 List the files in C<directory> (relative to the root directory,
756 there is no cwd). The '.' and '..' entries are not returned, but
757 hidden files are shown.
759 This command is mostly useful for interactive sessions. Programs
760 should probably use C<guestfs_readdir> instead.
762 This function returns a NULL-terminated array of strings
763 (like L<environ(3)>), or NULL if there was an error.
764 I<The caller must free the strings and the array after use>.
768 struct guestfs_stat *guestfs_lstat (guestfs_h *handle,
771 Returns file information for the given C<path>.
773 This is the same as C<guestfs_stat> except that if C<path>
774 is a symbolic link, then the link is stat-ed, not the file it
777 This is the same as the C<lstat(2)> system call.
779 This function returns a C<struct guestfs_stat *>
780 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
781 or NULL if there was an error.
782 I<The caller must call C<free> after use>.
784 =head2 guestfs_lvcreate
786 int guestfs_lvcreate (guestfs_h *handle,
788 const char *volgroup,
791 This creates an LVM volume group called C<logvol>
792 on the volume group C<volgroup>, with C<size> megabytes.
794 This function returns 0 on success or -1 on error.
796 =head2 guestfs_lvm_remove_all
798 int guestfs_lvm_remove_all (guestfs_h *handle);
800 This command removes all LVM logical volumes, volume groups
801 and physical volumes.
803 This function returns 0 on success or -1 on error.
805 B<This command is dangerous. Without careful use you
806 can easily destroy all your data>.
810 char **guestfs_lvs (guestfs_h *handle);
812 List all the logical volumes detected. This is the equivalent
813 of the L<lvs(8)> command.
815 This returns a list of the logical volume device names
816 (eg. C</dev/VolGroup00/LogVol00>).
818 See also C<guestfs_lvs_full>.
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>.
824 =head2 guestfs_lvs_full
826 struct guestfs_lvm_lv_list *guestfs_lvs_full (guestfs_h *handle);
828 List all the logical volumes detected. This is the equivalent
829 of the L<lvs(8)> command. The "full" version includes all fields.
831 This function returns a C<struct guestfs_lvm_lv_list *>
832 (see E<lt>guestfs-structs.hE<gt>),
833 or NULL if there was an error.
834 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.
838 int guestfs_mkdir (guestfs_h *handle,
841 Create a directory named C<path>.
843 This function returns 0 on success or -1 on error.
845 =head2 guestfs_mkdir_p
847 int guestfs_mkdir_p (guestfs_h *handle,
850 Create a directory named C<path>, creating any parent directories
851 as necessary. This is like the C<mkdir -p> shell command.
853 This function returns 0 on success or -1 on error.
857 int guestfs_mkfs (guestfs_h *handle,
861 This creates a filesystem on C<device> (usually a partition
862 of LVM logical volume). The filesystem type is C<fstype>, for
865 This function returns 0 on success or -1 on error.
869 int guestfs_mount (guestfs_h *handle,
871 const char *mountpoint);
873 Mount a guest disk at a position in the filesystem. Block devices
874 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
875 the guest. If those block devices contain partitions, they will have
876 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
879 The rules are the same as for L<mount(2)>: A filesystem must
880 first be mounted on C</> before others can be mounted. Other
881 filesystems can only be mounted on directories which already
884 The mounted filesystem is writable, if we have sufficient permissions
885 on the underlying device.
887 The filesystem options C<sync> and C<noatime> are set with this
888 call, in order to improve reliability.
890 This function returns 0 on success or -1 on error.
892 =head2 guestfs_mount_options
894 int guestfs_mount_options (guestfs_h *handle,
897 const char *mountpoint);
899 This is the same as the C<guestfs_mount> command, but it
900 allows you to set the mount options as for the
901 L<mount(8)> I<-o> flag.
903 This function returns 0 on success or -1 on error.
905 =head2 guestfs_mount_ro
907 int guestfs_mount_ro (guestfs_h *handle,
909 const char *mountpoint);
911 This is the same as the C<guestfs_mount> command, but it
912 mounts the filesystem with the read-only (I<-o ro>) flag.
914 This function returns 0 on success or -1 on error.
916 =head2 guestfs_mount_vfs
918 int guestfs_mount_vfs (guestfs_h *handle,
922 const char *mountpoint);
924 This is the same as the C<guestfs_mount> command, but it
925 allows you to set both the mount options and the vfstype
926 as for the L<mount(8)> I<-o> and I<-t> flags.
928 This function returns 0 on success or -1 on error.
930 =head2 guestfs_mounts
932 char **guestfs_mounts (guestfs_h *handle);
934 This returns the list of currently mounted filesystems. It returns
935 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
937 Some internal mounts are not shown.
939 This function returns a NULL-terminated array of strings
940 (like L<environ(3)>), or NULL if there was an error.
941 I<The caller must free the strings and the array after use>.
943 =head2 guestfs_pvcreate
945 int guestfs_pvcreate (guestfs_h *handle,
948 This creates an LVM physical volume on the named C<device>,
949 where C<device> should usually be a partition name such
952 This function returns 0 on success or -1 on error.
956 char **guestfs_pvs (guestfs_h *handle);
958 List all the physical volumes detected. This is the equivalent
959 of the L<pvs(8)> command.
961 This returns a list of just the device names that contain
962 PVs (eg. C</dev/sda2>).
964 See also C<guestfs_pvs_full>.
966 This function returns a NULL-terminated array of strings
967 (like L<environ(3)>), or NULL if there was an error.
968 I<The caller must free the strings and the array after use>.
970 =head2 guestfs_pvs_full
972 struct guestfs_lvm_pv_list *guestfs_pvs_full (guestfs_h *handle);
974 List all the physical volumes detected. This is the equivalent
975 of the L<pvs(8)> command. The "full" version includes all fields.
977 This function returns a C<struct guestfs_lvm_pv_list *>
978 (see E<lt>guestfs-structs.hE<gt>),
979 or NULL if there was an error.
980 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.
982 =head2 guestfs_read_lines
984 char **guestfs_read_lines (guestfs_h *handle,
987 Return the contents of the file named C<path>.
989 The file contents are returned as a list of lines. Trailing
990 C<LF> and C<CRLF> character sequences are I<not> returned.
992 Note that this function cannot correctly handle binary files
993 (specifically, files containing C<\0> character which is treated
994 as end of line). For those you need to use the C<guestfs_read_file>
995 function which has a more complex interface.
997 This function returns a NULL-terminated array of strings
998 (like L<environ(3)>), or NULL if there was an error.
999 I<The caller must free the strings and the array after use>.
1003 int guestfs_rm (guestfs_h *handle,
1006 Remove the single file C<path>.
1008 This function returns 0 on success or -1 on error.
1010 =head2 guestfs_rm_rf
1012 int guestfs_rm_rf (guestfs_h *handle,
1015 Remove the file or directory C<path>, recursively removing the
1016 contents if its a directory. This is like the C<rm -rf> shell
1019 This function returns 0 on success or -1 on error.
1021 =head2 guestfs_rmdir
1023 int guestfs_rmdir (guestfs_h *handle,
1026 Remove the single directory C<path>.
1028 This function returns 0 on success or -1 on error.
1030 =head2 guestfs_set_autosync
1032 int guestfs_set_autosync (guestfs_h *handle,
1035 If C<autosync> is true, this enables autosync. Libguestfs will make a
1036 best effort attempt to run C<guestfs_sync> when the handle is closed
1037 (also if the program exits without closing handles).
1039 This function returns 0 on success or -1 on error.
1041 =head2 guestfs_set_busy
1043 int guestfs_set_busy (guestfs_h *handle);
1045 This sets the state to C<BUSY>. This is only used when implementing
1046 actions using the low-level API.
1048 For more information on states, see L<guestfs(3)>.
1050 This function returns 0 on success or -1 on error.
1052 =head2 guestfs_set_path
1054 int guestfs_set_path (guestfs_h *handle,
1057 Set the path that libguestfs searches for kernel and initrd.img.
1059 The default is C<$libdir/guestfs> unless overridden by setting
1060 C<LIBGUESTFS_PATH> environment variable.
1062 The string C<path> is stashed in the libguestfs handle, so the caller
1063 must make sure it remains valid for the lifetime of the handle.
1065 Setting C<path> to C<NULL> restores the default path.
1067 This function returns 0 on success or -1 on error.
1069 =head2 guestfs_set_qemu
1071 int guestfs_set_qemu (guestfs_h *handle,
1074 Set the qemu binary that we will use.
1076 The default is chosen when the library was compiled by the
1079 You can also override this by setting the C<LIBGUESTFS_QEMU>
1080 environment variable.
1082 The string C<qemu> is stashed in the libguestfs handle, so the caller
1083 must make sure it remains valid for the lifetime of the handle.
1085 Setting C<qemu> to C<NULL> restores the default qemu binary.
1087 This function returns 0 on success or -1 on error.
1089 =head2 guestfs_set_ready
1091 int guestfs_set_ready (guestfs_h *handle);
1093 This sets the state to C<READY>. This is only used when implementing
1094 actions using the low-level API.
1096 For more information on states, see L<guestfs(3)>.
1098 This function returns 0 on success or -1 on error.
1100 =head2 guestfs_set_verbose
1102 int guestfs_set_verbose (guestfs_h *handle,
1105 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
1107 Verbose messages are disabled unless the environment variable
1108 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
1110 This function returns 0 on success or -1 on error.
1112 =head2 guestfs_sfdisk
1114 int guestfs_sfdisk (guestfs_h *handle,
1119 char * const* const lines);
1121 This is a direct interface to the L<sfdisk(8)> program for creating
1122 partitions on block devices.
1124 C<device> should be a block device, for example C</dev/sda>.
1126 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1127 and sectors on the device, which are passed directly to sfdisk as
1128 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1129 of these, then the corresponding parameter is omitted. Usually for
1130 'large' disks, you can just pass C<0> for these, but for small
1131 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1132 out the right geometry and you will need to tell it.
1134 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1135 information refer to the L<sfdisk(8)> manpage.
1137 To create a single partition occupying the whole disk, you would
1138 pass C<lines> as a single element list, when the single element being
1139 the string C<,> (comma).
1141 This function returns 0 on success or -1 on error.
1143 B<This command is dangerous. Without careful use you
1144 can easily destroy all your data>.
1148 struct guestfs_stat *guestfs_stat (guestfs_h *handle,
1151 Returns file information for the given C<path>.
1153 This is the same as the C<stat(2)> system call.
1155 This function returns a C<struct guestfs_stat *>
1156 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
1157 or NULL if there was an error.
1158 I<The caller must call C<free> after use>.
1160 =head2 guestfs_statvfs
1162 struct guestfs_statvfs *guestfs_statvfs (guestfs_h *handle,
1165 Returns file system statistics for any mounted file system.
1166 C<path> should be a file or directory in the mounted file system
1167 (typically it is the mount point itself, but it doesn't need to be).
1169 This is the same as the C<statvfs(2)> system call.
1171 This function returns a C<struct guestfs_statvfs *>
1172 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
1173 or NULL if there was an error.
1174 I<The caller must call C<free> after use>.
1178 int guestfs_sync (guestfs_h *handle);
1180 This syncs the disk, so that any writes are flushed through to the
1181 underlying disk image.
1183 You should always call this if you have modified a disk image, before
1186 This function returns 0 on success or -1 on error.
1188 =head2 guestfs_tar_in
1190 int guestfs_tar_in (guestfs_h *handle,
1191 const char *tarfile,
1192 const char *directory);
1194 This command uploads and unpacks local file C<tarfile> (an
1195 I<uncompressed> tar file) into C<directory>.
1197 To upload a compressed tarball, use C<guestfs_tgz_in>.
1199 This function returns 0 on success or -1 on error.
1201 =head2 guestfs_tar_out
1203 int guestfs_tar_out (guestfs_h *handle,
1204 const char *directory,
1205 const char *tarfile);
1207 This command packs the contents of C<directory> and downloads
1208 it to local file C<tarfile>.
1210 To download a compressed tarball, use C<guestfs_tgz_out>.
1212 This function returns 0 on success or -1 on error.
1214 =head2 guestfs_tgz_in
1216 int guestfs_tgz_in (guestfs_h *handle,
1217 const char *tarball,
1218 const char *directory);
1220 This command uploads and unpacks local file C<tarball> (a
1221 I<gzip compressed> tar file) into C<directory>.
1223 To upload an uncompressed tarball, use C<guestfs_tar_in>.
1225 This function returns 0 on success or -1 on error.
1227 =head2 guestfs_tgz_out
1229 int guestfs_tgz_out (guestfs_h *handle,
1230 const char *directory,
1231 const char *tarball);
1233 This command packs the contents of C<directory> and downloads
1234 it to local file C<tarball>.
1236 To download an uncompressed tarball, use C<guestfs_tar_out>.
1238 This function returns 0 on success or -1 on error.
1240 =head2 guestfs_touch
1242 int guestfs_touch (guestfs_h *handle,
1245 Touch acts like the L<touch(1)> command. It can be used to
1246 update the timestamps on a file, or, if the file does not exist,
1247 to create a new zero-length file.
1249 This function returns 0 on success or -1 on error.
1251 =head2 guestfs_tune2fs_l
1253 char **guestfs_tune2fs_l (guestfs_h *handle,
1254 const char *device);
1256 This returns the contents of the ext2 or ext3 filesystem superblock
1259 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1260 manpage for more details. The list of fields returned isn't
1261 clearly defined, and depends on both the version of C<tune2fs>
1262 that libguestfs was built against, and the filesystem itself.
1264 This function returns a NULL-terminated array of
1265 strings, or NULL if there was an error.
1266 The array of strings will always have length C<2n+1>, where
1267 C<n> keys and values alternate, followed by the trailing NULL entry.
1268 I<The caller must free the strings and the array after use>.
1270 =head2 guestfs_umount
1272 int guestfs_umount (guestfs_h *handle,
1273 const char *pathordevice);
1275 This unmounts the given filesystem. The filesystem may be
1276 specified either by its mountpoint (path) or the device which
1277 contains the filesystem.
1279 This function returns 0 on success or -1 on error.
1281 =head2 guestfs_umount_all
1283 int guestfs_umount_all (guestfs_h *handle);
1285 This unmounts all mounted filesystems.
1287 Some internal mounts are not unmounted by this call.
1289 This function returns 0 on success or -1 on error.
1291 =head2 guestfs_upload
1293 int guestfs_upload (guestfs_h *handle,
1294 const char *filename,
1295 const char *remotefilename);
1297 Upload local file C<filename> to C<remotefilename> on the
1300 C<filename> can also be a named pipe.
1302 See also C<guestfs_download>.
1304 This function returns 0 on success or -1 on error.
1306 =head2 guestfs_vgcreate
1308 int guestfs_vgcreate (guestfs_h *handle,
1309 const char *volgroup,
1310 char * const* const physvols);
1312 This creates an LVM volume group called C<volgroup>
1313 from the non-empty list of physical volumes C<physvols>.
1315 This function returns 0 on success or -1 on error.
1319 char **guestfs_vgs (guestfs_h *handle);
1321 List all the volumes groups detected. This is the equivalent
1322 of the L<vgs(8)> command.
1324 This returns a list of just the volume group names that were
1325 detected (eg. C<VolGroup00>).
1327 See also C<guestfs_vgs_full>.
1329 This function returns a NULL-terminated array of strings
1330 (like L<environ(3)>), or NULL if there was an error.
1331 I<The caller must free the strings and the array after use>.
1333 =head2 guestfs_vgs_full
1335 struct guestfs_lvm_vg_list *guestfs_vgs_full (guestfs_h *handle);
1337 List all the volumes groups detected. This is the equivalent
1338 of the L<vgs(8)> command. The "full" version includes all fields.
1340 This function returns a C<struct guestfs_lvm_vg_list *>
1341 (see E<lt>guestfs-structs.hE<gt>),
1342 or NULL if there was an error.
1343 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.
1345 =head2 guestfs_wait_ready
1347 int guestfs_wait_ready (guestfs_h *handle);
1349 Internally libguestfs is implemented by running a virtual machine
1352 You should call this after C<guestfs_launch> to wait for the launch
1355 This function returns 0 on success or -1 on error.
1357 =head2 guestfs_write_file
1359 int guestfs_write_file (guestfs_h *handle,
1361 const char *content,
1364 This call creates a file called C<path>. The contents of the
1365 file is the string C<content> (which can contain any 8 bit data),
1366 with length C<size>.
1368 As a special case, if C<size> is C<0>
1369 then the length is calculated using C<strlen> (so in this case
1370 the content cannot contain embedded ASCII NULs).
1372 This function returns 0 on success or -1 on error.
1374 Because of the message protocol, there is a transfer limit
1375 of somewhere between 2MB and 4MB. To transfer large files you should use