1 =head2 guestfs_add_cdrom
3 int guestfs_add_cdrom (guestfs_h *handle,
6 This function adds a virtual CD-ROM disk image to the guest.
8 This is equivalent to the qemu parameter C<-cdrom filename>.
10 This function returns 0 on success or -1 on error.
12 =head2 guestfs_add_drive
14 int guestfs_add_drive (guestfs_h *handle,
15 const char *filename);
17 This function adds a virtual machine disk image C<filename> to the
18 guest. The first time you call this function, the disk appears as IDE
19 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
22 You don't necessarily need to be root when using libguestfs. However
23 you obviously do need sufficient permissions to access the filename
24 for whatever operations you want to perform (ie. read access if you
25 just want to read the image or write access if you want to modify the
28 This is equivalent to the qemu parameter C<-drive file=filename>.
30 This function returns 0 on success or -1 on error.
32 =head2 guestfs_aug_close
34 int guestfs_aug_close (guestfs_h *handle);
36 Close the current Augeas handle and free up any resources
37 used by it. After calling this, you have to call
38 C<guestfs_aug_init> again before you can use any other
41 This function returns 0 on success or -1 on error.
43 =head2 guestfs_aug_defnode
45 struct guestfs_int_bool *guestfs_aug_defnode (guestfs_h *handle,
50 Defines a variable C<name> whose value is the result of
53 If C<expr> evaluates to an empty nodeset, a node is created,
54 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
55 C<name> will be the nodeset containing that single node.
57 On success this returns a pair containing the
58 number of nodes in the nodeset, and a boolean flag
59 if a node was created.
61 This function returns a C<struct guestfs_int_bool *>,
62 or NULL if there was an error.
63 I<The caller must call C<guestfs_free_int_bool> after use>.
65 =head2 guestfs_aug_defvar
67 int guestfs_aug_defvar (guestfs_h *handle,
71 Defines an Augeas variable C<name> whose value is the result
72 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
75 On success this returns the number of nodes in C<expr>, or
76 C<0> if C<expr> evaluates to something which is not a nodeset.
78 On error this function returns -1.
80 =head2 guestfs_aug_get
82 char *guestfs_aug_get (guestfs_h *handle,
85 Look up the value associated with C<path>. If C<path>
86 matches exactly one node, the C<value> is returned.
88 This function returns a string, or NULL on error.
89 I<The caller must free the returned string after use>.
91 =head2 guestfs_aug_init
93 int guestfs_aug_init (guestfs_h *handle,
97 Create a new Augeas handle for editing configuration files.
98 If there was any previous Augeas handle associated with this
99 guestfs session, then it is closed.
101 You must call this before using any other C<guestfs_aug_*>
104 C<root> is the filesystem root. C<root> must not be NULL,
107 The flags are the same as the flags defined in
108 E<lt>augeas.hE<gt>, the logical I<or> of the following
113 =item C<AUG_SAVE_BACKUP> = 1
115 Keep the original file with a C<.augsave> extension.
117 =item C<AUG_SAVE_NEWFILE> = 2
119 Save changes into a file with extension C<.augnew>, and
120 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
122 =item C<AUG_TYPE_CHECK> = 4
124 Typecheck lenses (can be expensive).
126 =item C<AUG_NO_STDINC> = 8
128 Do not use standard load path for modules.
130 =item C<AUG_SAVE_NOOP> = 16
132 Make save a no-op, just record what would have been changed.
134 =item C<AUG_NO_LOAD> = 32
136 Do not load the tree in C<guestfs_aug_init>.
140 To close the handle, you can call C<guestfs_aug_close>.
142 To find out more about Augeas, see L<http://augeas.net/>.
144 This function returns 0 on success or -1 on error.
146 =head2 guestfs_aug_insert
148 int guestfs_aug_insert (guestfs_h *handle,
153 Create a new sibling C<label> for C<path>, inserting it into
154 the tree before or after C<path> (depending on the boolean
157 C<path> must match exactly one existing node in the tree, and
158 C<label> must be a label, ie. not contain C</>, C<*> or end
159 with a bracketed index C<[N]>.
161 This function returns 0 on success or -1 on error.
163 =head2 guestfs_aug_load
165 int guestfs_aug_load (guestfs_h *handle);
167 Load files into the tree.
169 See C<aug_load> in the Augeas documentation for the full gory
172 This function returns 0 on success or -1 on error.
174 =head2 guestfs_aug_ls
176 char **guestfs_aug_ls (guestfs_h *handle,
179 This is just a shortcut for listing C<guestfs_aug_match>
180 C<path/*> and sorting the resulting nodes into alphabetical order.
182 This function returns a NULL-terminated array of strings
183 (like L<environ(3)>), or NULL if there was an error.
184 I<The caller must free the strings and the array after use>.
186 =head2 guestfs_aug_match
188 char **guestfs_aug_match (guestfs_h *handle,
191 Returns a list of paths which match the path expression C<path>.
192 The returned paths are sufficiently qualified so that they match
193 exactly one node in the current tree.
195 This function returns a NULL-terminated array of strings
196 (like L<environ(3)>), or NULL if there was an error.
197 I<The caller must free the strings and the array after use>.
199 =head2 guestfs_aug_mv
201 int guestfs_aug_mv (guestfs_h *handle,
205 Move the node C<src> to C<dest>. C<src> must match exactly
206 one node. C<dest> is overwritten if it exists.
208 This function returns 0 on success or -1 on error.
210 =head2 guestfs_aug_rm
212 int guestfs_aug_rm (guestfs_h *handle,
215 Remove C<path> and all of its children.
217 On success this returns the number of entries which were removed.
219 On error this function returns -1.
221 =head2 guestfs_aug_save
223 int guestfs_aug_save (guestfs_h *handle);
225 This writes all pending changes to disk.
227 The flags which were passed to C<guestfs_aug_init> affect exactly
230 This function returns 0 on success or -1 on error.
232 =head2 guestfs_aug_set
234 int guestfs_aug_set (guestfs_h *handle,
238 Set the value associated with C<path> to C<value>.
240 This function returns 0 on success or -1 on error.
242 =head2 guestfs_blockdev_flushbufs
244 int guestfs_blockdev_flushbufs (guestfs_h *handle,
247 This tells the kernel to flush internal buffers associated
250 This uses the L<blockdev(8)> command.
252 This function returns 0 on success or -1 on error.
254 =head2 guestfs_blockdev_getbsz
256 int guestfs_blockdev_getbsz (guestfs_h *handle,
259 This returns the block size of a device.
261 (Note this is different from both I<size in blocks> and
262 I<filesystem block size>).
264 This uses the L<blockdev(8)> command.
266 On error this function returns -1.
268 =head2 guestfs_blockdev_getro
270 int guestfs_blockdev_getro (guestfs_h *handle,
273 Returns a boolean indicating if the block device is read-only
274 (true if read-only, false if not).
276 This uses the L<blockdev(8)> command.
278 This function returns a C truth value on success or -1 on error.
280 =head2 guestfs_blockdev_getsize64
282 int64_t guestfs_blockdev_getsize64 (guestfs_h *handle,
285 This returns the size of the device in bytes.
287 See also C<guestfs_blockdev_getsz>.
289 This uses the L<blockdev(8)> command.
291 On error this function returns -1.
293 =head2 guestfs_blockdev_getss
295 int guestfs_blockdev_getss (guestfs_h *handle,
298 This returns the size of sectors on a block device.
299 Usually 512, but can be larger for modern devices.
301 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
304 This uses the L<blockdev(8)> command.
306 On error this function returns -1.
308 =head2 guestfs_blockdev_getsz
310 int64_t guestfs_blockdev_getsz (guestfs_h *handle,
313 This returns the size of the device in units of 512-byte sectors
314 (even if the sectorsize isn't 512 bytes ... weird).
316 See also C<guestfs_blockdev_getss> for the real sector size of
317 the device, and C<guestfs_blockdev_getsize64> for the more
318 useful I<size in bytes>.
320 This uses the L<blockdev(8)> command.
322 On error this function returns -1.
324 =head2 guestfs_blockdev_rereadpt
326 int guestfs_blockdev_rereadpt (guestfs_h *handle,
329 Reread the partition table on C<device>.
331 This uses the L<blockdev(8)> command.
333 This function returns 0 on success or -1 on error.
335 =head2 guestfs_blockdev_setbsz
337 int guestfs_blockdev_setbsz (guestfs_h *handle,
341 This sets the block size of a device.
343 (Note this is different from both I<size in blocks> and
344 I<filesystem block size>).
346 This uses the L<blockdev(8)> command.
348 This function returns 0 on success or -1 on error.
350 =head2 guestfs_blockdev_setro
352 int guestfs_blockdev_setro (guestfs_h *handle,
355 Sets the block device named C<device> to read-only.
357 This uses the L<blockdev(8)> command.
359 This function returns 0 on success or -1 on error.
361 =head2 guestfs_blockdev_setrw
363 int guestfs_blockdev_setrw (guestfs_h *handle,
366 Sets the block device named C<device> to read-write.
368 This uses the L<blockdev(8)> command.
370 This function returns 0 on success or -1 on error.
374 char *guestfs_cat (guestfs_h *handle,
377 Return the contents of the file named C<path>.
379 Note that this function cannot correctly handle binary files
380 (specifically, files containing C<\0> character which is treated
381 as end of string). For those you need to use the C<guestfs_download>
382 function which has a more complex interface.
384 This function returns a string, or NULL on error.
385 I<The caller must free the returned string after use>.
387 Because of the message protocol, there is a transfer limit
388 of somewhere between 2MB and 4MB. To transfer large files you should use
391 =head2 guestfs_checksum
393 char *guestfs_checksum (guestfs_h *handle,
394 const char *csumtype,
397 This call computes the MD5, SHAx or CRC checksum of the
400 The type of checksum to compute is given by the C<csumtype>
401 parameter which must have one of the following values:
407 Compute the cyclic redundancy check (CRC) specified by POSIX
408 for the C<cksum> command.
412 Compute the MD5 hash (using the C<md5sum> program).
416 Compute the SHA1 hash (using the C<sha1sum> program).
420 Compute the SHA224 hash (using the C<sha224sum> program).
424 Compute the SHA256 hash (using the C<sha256sum> program).
428 Compute the SHA384 hash (using the C<sha384sum> program).
432 Compute the SHA512 hash (using the C<sha512sum> program).
436 The checksum is returned as a printable string.
438 This function returns a string, or NULL on error.
439 I<The caller must free the returned string after use>.
443 int guestfs_chmod (guestfs_h *handle,
447 Change the mode (permissions) of C<path> to C<mode>. Only
448 numeric modes are supported.
450 This function returns 0 on success or -1 on error.
454 int guestfs_chown (guestfs_h *handle,
459 Change the file owner to C<owner> and group to C<group>.
461 Only numeric uid and gid are supported. If you want to use
462 names, you will need to locate and parse the password file
463 yourself (Augeas support makes this relatively easy).
465 This function returns 0 on success or -1 on error.
467 =head2 guestfs_command
469 char *guestfs_command (guestfs_h *handle,
470 char * const* const arguments);
472 This call runs a command from the guest filesystem. The
473 filesystem must be mounted, and must contain a compatible
474 operating system (ie. something Linux, with the same
475 or compatible processor architecture).
477 The single parameter is an argv-style list of arguments.
478 The first element is the name of the program to run.
479 Subsequent elements are parameters. The list must be
480 non-empty (ie. must contain a program name).
482 The C<$PATH> environment variable will contain at least
483 C</usr/bin> and C</bin>. If you require a program from
484 another location, you should provide the full path in the
487 Shared libraries and data files required by the program
488 must be available on filesystems which are mounted in the
489 correct places. It is the caller's responsibility to ensure
490 all filesystems that are needed are mounted at the right
493 This function returns a string, or NULL on error.
494 I<The caller must free the returned string after use>.
496 =head2 guestfs_command_lines
498 char **guestfs_command_lines (guestfs_h *handle,
499 char * const* const arguments);
501 This is the same as C<guestfs_command>, but splits the
502 result into a list of lines.
504 This function returns a NULL-terminated array of strings
505 (like L<environ(3)>), or NULL if there was an error.
506 I<The caller must free the strings and the array after use>.
508 =head2 guestfs_config
510 int guestfs_config (guestfs_h *handle,
511 const char *qemuparam,
512 const char *qemuvalue);
514 This can be used to add arbitrary qemu command line parameters
515 of the form C<-param value>. Actually it's not quite arbitrary - we
516 prevent you from setting some parameters which would interfere with
517 parameters that we use.
519 The first character of C<param> string must be a C<-> (dash).
521 C<value> can be NULL.
523 This function returns 0 on success or -1 on error.
527 char *guestfs_debug (guestfs_h *handle,
529 char * const* const extraargs);
531 The C<guestfs_debug> command exposes some internals of
532 C<guestfsd> (the guestfs daemon) that runs inside the
535 There is no comprehensive help for this command. You have
536 to look at the file C<daemon/debug.c> in the libguestfs source
537 to find out what you can do.
539 This function returns a string, or NULL on error.
540 I<The caller must free the returned string after use>.
542 =head2 guestfs_download
544 int guestfs_download (guestfs_h *handle,
545 const char *remotefilename,
546 const char *filename);
548 Download file C<remotefilename> and save it as C<filename>
549 on the local machine.
551 C<filename> can also be a named pipe.
553 See also C<guestfs_upload>, C<guestfs_cat>.
555 This function returns 0 on success or -1 on error.
557 =head2 guestfs_exists
559 int guestfs_exists (guestfs_h *handle,
562 This returns C<true> if and only if there is a file, directory
563 (or anything) with the given C<path> name.
565 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.
567 This function returns a C truth value on success or -1 on error.
571 char *guestfs_file (guestfs_h *handle,
574 This call uses the standard L<file(1)> command to determine
575 the type or contents of the file. This also works on devices,
576 for example to find out whether a partition contains a filesystem.
578 The exact command which runs is C<file -bsL path>. Note in
579 particular that the filename is not prepended to the output
582 This function returns a string, or NULL on error.
583 I<The caller must free the returned string after use>.
585 =head2 guestfs_get_autosync
587 int guestfs_get_autosync (guestfs_h *handle);
589 Get the autosync flag.
591 This function returns a C truth value on success or -1 on error.
593 =head2 guestfs_get_path
595 const char *guestfs_get_path (guestfs_h *handle);
597 Return the current search path.
599 This is always non-NULL. If it wasn't set already, then this will
600 return the default path.
602 This function returns a string, or NULL on error.
603 The string is owned by the guest handle and must I<not> be freed.
605 =head2 guestfs_get_qemu
607 const char *guestfs_get_qemu (guestfs_h *handle);
609 Return the current qemu binary.
611 This is always non-NULL. If it wasn't set already, then this will
612 return the default qemu binary name.
614 This function returns a string, or NULL on error.
615 The string is owned by the guest handle and must I<not> be freed.
617 =head2 guestfs_get_state
619 int guestfs_get_state (guestfs_h *handle);
621 This returns the current state as an opaque integer. This is
622 only useful for printing debug and internal error messages.
624 For more information on states, see L<guestfs(3)>.
626 On error this function returns -1.
628 =head2 guestfs_get_verbose
630 int guestfs_get_verbose (guestfs_h *handle);
632 This returns the verbose messages flag.
634 This function returns a C truth value on success or -1 on error.
636 =head2 guestfs_is_busy
638 int guestfs_is_busy (guestfs_h *handle);
640 This returns true iff this handle is busy processing a command
641 (in the C<BUSY> state).
643 For more information on states, see L<guestfs(3)>.
645 This function returns a C truth value on success or -1 on error.
647 =head2 guestfs_is_config
649 int guestfs_is_config (guestfs_h *handle);
651 This returns true iff this handle is being configured
652 (in the C<CONFIG> state).
654 For more information on states, see L<guestfs(3)>.
656 This function returns a C truth value on success or -1 on error.
658 =head2 guestfs_is_dir
660 int guestfs_is_dir (guestfs_h *handle,
663 This returns C<true> if and only if there is a directory
664 with the given C<path> name. Note that it returns false for
665 other objects like files.
667 See also C<guestfs_stat>.
669 This function returns a C truth value on success or -1 on error.
671 =head2 guestfs_is_file
673 int guestfs_is_file (guestfs_h *handle,
676 This returns C<true> if and only if there is a file
677 with the given C<path> name. Note that it returns false for
678 other objects like directories.
680 See also C<guestfs_stat>.
682 This function returns a C truth value on success or -1 on error.
684 =head2 guestfs_is_launching
686 int guestfs_is_launching (guestfs_h *handle);
688 This returns true iff this handle is launching the subprocess
689 (in the C<LAUNCHING> state).
691 For more information on states, see L<guestfs(3)>.
693 This function returns a C truth value on success or -1 on error.
695 =head2 guestfs_is_ready
697 int guestfs_is_ready (guestfs_h *handle);
699 This returns true iff this handle is ready to accept commands
700 (in the C<READY> state).
702 For more information on states, see L<guestfs(3)>.
704 This function returns a C truth value on success or -1 on error.
706 =head2 guestfs_kill_subprocess
708 int guestfs_kill_subprocess (guestfs_h *handle);
710 This kills the qemu subprocess. You should never need to call this.
712 This function returns 0 on success or -1 on error.
714 =head2 guestfs_launch
716 int guestfs_launch (guestfs_h *handle);
718 Internally libguestfs is implemented by running a virtual machine
721 You should call this after configuring the handle
722 (eg. adding drives) but before performing any actions.
724 This function returns 0 on success or -1 on error.
726 =head2 guestfs_list_devices
728 char **guestfs_list_devices (guestfs_h *handle);
730 List all the block devices.
732 The full block device names are returned, eg. C</dev/sda>
734 This function returns a NULL-terminated array of strings
735 (like L<environ(3)>), or NULL if there was an error.
736 I<The caller must free the strings and the array after use>.
738 =head2 guestfs_list_partitions
740 char **guestfs_list_partitions (guestfs_h *handle);
742 List all the partitions detected on all block devices.
744 The full partition device names are returned, eg. C</dev/sda1>
746 This does not return logical volumes. For that you will need to
749 This function returns a NULL-terminated array of strings
750 (like L<environ(3)>), or NULL if there was an error.
751 I<The caller must free the strings and the array after use>.
755 char *guestfs_ll (guestfs_h *handle,
756 const char *directory);
758 List the files in C<directory> (relative to the root directory,
759 there is no cwd) in the format of 'ls -la'.
761 This command is mostly useful for interactive sessions. It
762 is I<not> intended that you try to parse the output string.
764 This function returns a string, or NULL on error.
765 I<The caller must free the returned string after use>.
769 char **guestfs_ls (guestfs_h *handle,
770 const char *directory);
772 List the files in C<directory> (relative to the root directory,
773 there is no cwd). The '.' and '..' entries are not returned, but
774 hidden files are shown.
776 This command is mostly useful for interactive sessions. Programs
777 should probably use C<guestfs_readdir> instead.
779 This function returns a NULL-terminated array of strings
780 (like L<environ(3)>), or NULL if there was an error.
781 I<The caller must free the strings and the array after use>.
785 struct guestfs_stat *guestfs_lstat (guestfs_h *handle,
788 Returns file information for the given C<path>.
790 This is the same as C<guestfs_stat> except that if C<path>
791 is a symbolic link, then the link is stat-ed, not the file it
794 This is the same as the C<lstat(2)> system call.
796 This function returns a C<struct guestfs_stat *>
797 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
798 or NULL if there was an error.
799 I<The caller must call C<free> after use>.
801 =head2 guestfs_lvcreate
803 int guestfs_lvcreate (guestfs_h *handle,
805 const char *volgroup,
808 This creates an LVM volume group called C<logvol>
809 on the volume group C<volgroup>, with C<size> megabytes.
811 This function returns 0 on success or -1 on error.
813 =head2 guestfs_lvm_remove_all
815 int guestfs_lvm_remove_all (guestfs_h *handle);
817 This command removes all LVM logical volumes, volume groups
818 and physical volumes.
820 This function returns 0 on success or -1 on error.
822 B<This command is dangerous. Without careful use you
823 can easily destroy all your data>.
827 char **guestfs_lvs (guestfs_h *handle);
829 List all the logical volumes detected. This is the equivalent
830 of the L<lvs(8)> command.
832 This returns a list of the logical volume device names
833 (eg. C</dev/VolGroup00/LogVol00>).
835 See also C<guestfs_lvs_full>.
837 This function returns a NULL-terminated array of strings
838 (like L<environ(3)>), or NULL if there was an error.
839 I<The caller must free the strings and the array after use>.
841 =head2 guestfs_lvs_full
843 struct guestfs_lvm_lv_list *guestfs_lvs_full (guestfs_h *handle);
845 List all the logical volumes detected. This is the equivalent
846 of the L<lvs(8)> command. The "full" version includes all fields.
848 This function returns a C<struct guestfs_lvm_lv_list *>
849 (see E<lt>guestfs-structs.hE<gt>),
850 or NULL if there was an error.
851 I<The caller must call C<guestfs_free_lvm_lv_list> after use>.
855 int guestfs_mkdir (guestfs_h *handle,
858 Create a directory named C<path>.
860 This function returns 0 on success or -1 on error.
862 =head2 guestfs_mkdir_p
864 int guestfs_mkdir_p (guestfs_h *handle,
867 Create a directory named C<path>, creating any parent directories
868 as necessary. This is like the C<mkdir -p> shell command.
870 This function returns 0 on success or -1 on error.
874 int guestfs_mkfs (guestfs_h *handle,
878 This creates a filesystem on C<device> (usually a partition
879 of LVM logical volume). The filesystem type is C<fstype>, for
882 This function returns 0 on success or -1 on error.
886 int guestfs_mount (guestfs_h *handle,
888 const char *mountpoint);
890 Mount a guest disk at a position in the filesystem. Block devices
891 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
892 the guest. If those block devices contain partitions, they will have
893 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
896 The rules are the same as for L<mount(2)>: A filesystem must
897 first be mounted on C</> before others can be mounted. Other
898 filesystems can only be mounted on directories which already
901 The mounted filesystem is writable, if we have sufficient permissions
902 on the underlying device.
904 The filesystem options C<sync> and C<noatime> are set with this
905 call, in order to improve reliability.
907 This function returns 0 on success or -1 on error.
909 =head2 guestfs_mount_options
911 int guestfs_mount_options (guestfs_h *handle,
914 const char *mountpoint);
916 This is the same as the C<guestfs_mount> command, but it
917 allows you to set the mount options as for the
918 L<mount(8)> I<-o> flag.
920 This function returns 0 on success or -1 on error.
922 =head2 guestfs_mount_ro
924 int guestfs_mount_ro (guestfs_h *handle,
926 const char *mountpoint);
928 This is the same as the C<guestfs_mount> command, but it
929 mounts the filesystem with the read-only (I<-o ro>) flag.
931 This function returns 0 on success or -1 on error.
933 =head2 guestfs_mount_vfs
935 int guestfs_mount_vfs (guestfs_h *handle,
939 const char *mountpoint);
941 This is the same as the C<guestfs_mount> command, but it
942 allows you to set both the mount options and the vfstype
943 as for the L<mount(8)> I<-o> and I<-t> flags.
945 This function returns 0 on success or -1 on error.
947 =head2 guestfs_mounts
949 char **guestfs_mounts (guestfs_h *handle);
951 This returns the list of currently mounted filesystems. It returns
952 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
954 Some internal mounts are not shown.
956 This function returns a NULL-terminated array of strings
957 (like L<environ(3)>), or NULL if there was an error.
958 I<The caller must free the strings and the array after use>.
960 =head2 guestfs_pvcreate
962 int guestfs_pvcreate (guestfs_h *handle,
965 This creates an LVM physical volume on the named C<device>,
966 where C<device> should usually be a partition name such
969 This function returns 0 on success or -1 on error.
973 char **guestfs_pvs (guestfs_h *handle);
975 List all the physical volumes detected. This is the equivalent
976 of the L<pvs(8)> command.
978 This returns a list of just the device names that contain
979 PVs (eg. C</dev/sda2>).
981 See also C<guestfs_pvs_full>.
983 This function returns a NULL-terminated array of strings
984 (like L<environ(3)>), or NULL if there was an error.
985 I<The caller must free the strings and the array after use>.
987 =head2 guestfs_pvs_full
989 struct guestfs_lvm_pv_list *guestfs_pvs_full (guestfs_h *handle);
991 List all the physical volumes detected. This is the equivalent
992 of the L<pvs(8)> command. The "full" version includes all fields.
994 This function returns a C<struct guestfs_lvm_pv_list *>
995 (see E<lt>guestfs-structs.hE<gt>),
996 or NULL if there was an error.
997 I<The caller must call C<guestfs_free_lvm_pv_list> after use>.
999 =head2 guestfs_read_lines
1001 char **guestfs_read_lines (guestfs_h *handle,
1004 Return the contents of the file named C<path>.
1006 The file contents are returned as a list of lines. Trailing
1007 C<LF> and C<CRLF> character sequences are I<not> returned.
1009 Note that this function cannot correctly handle binary files
1010 (specifically, files containing C<\0> character which is treated
1011 as end of line). For those you need to use the C<guestfs_read_file>
1012 function which has a more complex interface.
1014 This function returns a NULL-terminated array of strings
1015 (like L<environ(3)>), or NULL if there was an error.
1016 I<The caller must free the strings and the array after use>.
1020 int guestfs_rm (guestfs_h *handle,
1023 Remove the single file C<path>.
1025 This function returns 0 on success or -1 on error.
1027 =head2 guestfs_rm_rf
1029 int guestfs_rm_rf (guestfs_h *handle,
1032 Remove the file or directory C<path>, recursively removing the
1033 contents if its a directory. This is like the C<rm -rf> shell
1036 This function returns 0 on success or -1 on error.
1038 =head2 guestfs_rmdir
1040 int guestfs_rmdir (guestfs_h *handle,
1043 Remove the single directory C<path>.
1045 This function returns 0 on success or -1 on error.
1047 =head2 guestfs_set_autosync
1049 int guestfs_set_autosync (guestfs_h *handle,
1052 If C<autosync> is true, this enables autosync. Libguestfs will make a
1053 best effort attempt to run C<guestfs_sync> when the handle is closed
1054 (also if the program exits without closing handles).
1056 This function returns 0 on success or -1 on error.
1058 =head2 guestfs_set_busy
1060 int guestfs_set_busy (guestfs_h *handle);
1062 This sets the state to C<BUSY>. This is only used when implementing
1063 actions using the low-level API.
1065 For more information on states, see L<guestfs(3)>.
1067 This function returns 0 on success or -1 on error.
1069 =head2 guestfs_set_path
1071 int guestfs_set_path (guestfs_h *handle,
1074 Set the path that libguestfs searches for kernel and initrd.img.
1076 The default is C<$libdir/guestfs> unless overridden by setting
1077 C<LIBGUESTFS_PATH> environment variable.
1079 The string C<path> is stashed in the libguestfs handle, so the caller
1080 must make sure it remains valid for the lifetime of the handle.
1082 Setting C<path> to C<NULL> restores the default path.
1084 This function returns 0 on success or -1 on error.
1086 =head2 guestfs_set_qemu
1088 int guestfs_set_qemu (guestfs_h *handle,
1091 Set the qemu binary that we will use.
1093 The default is chosen when the library was compiled by the
1096 You can also override this by setting the C<LIBGUESTFS_QEMU>
1097 environment variable.
1099 The string C<qemu> is stashed in the libguestfs handle, so the caller
1100 must make sure it remains valid for the lifetime of the handle.
1102 Setting C<qemu> to C<NULL> restores the default qemu binary.
1104 This function returns 0 on success or -1 on error.
1106 =head2 guestfs_set_ready
1108 int guestfs_set_ready (guestfs_h *handle);
1110 This sets the state to C<READY>. This is only used when implementing
1111 actions using the low-level API.
1113 For more information on states, see L<guestfs(3)>.
1115 This function returns 0 on success or -1 on error.
1117 =head2 guestfs_set_verbose
1119 int guestfs_set_verbose (guestfs_h *handle,
1122 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
1124 Verbose messages are disabled unless the environment variable
1125 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
1127 This function returns 0 on success or -1 on error.
1129 =head2 guestfs_sfdisk
1131 int guestfs_sfdisk (guestfs_h *handle,
1136 char * const* const lines);
1138 This is a direct interface to the L<sfdisk(8)> program for creating
1139 partitions on block devices.
1141 C<device> should be a block device, for example C</dev/sda>.
1143 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1144 and sectors on the device, which are passed directly to sfdisk as
1145 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1146 of these, then the corresponding parameter is omitted. Usually for
1147 'large' disks, you can just pass C<0> for these, but for small
1148 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1149 out the right geometry and you will need to tell it.
1151 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1152 information refer to the L<sfdisk(8)> manpage.
1154 To create a single partition occupying the whole disk, you would
1155 pass C<lines> as a single element list, when the single element being
1156 the string C<,> (comma).
1158 This function returns 0 on success or -1 on error.
1160 B<This command is dangerous. Without careful use you
1161 can easily destroy all your data>.
1165 struct guestfs_stat *guestfs_stat (guestfs_h *handle,
1168 Returns file information for the given C<path>.
1170 This is the same as the C<stat(2)> system call.
1172 This function returns a C<struct guestfs_stat *>
1173 (see L<stat(2)> and E<lt>guestfs-structs.hE<gt>),
1174 or NULL if there was an error.
1175 I<The caller must call C<free> after use>.
1177 =head2 guestfs_statvfs
1179 struct guestfs_statvfs *guestfs_statvfs (guestfs_h *handle,
1182 Returns file system statistics for any mounted file system.
1183 C<path> should be a file or directory in the mounted file system
1184 (typically it is the mount point itself, but it doesn't need to be).
1186 This is the same as the C<statvfs(2)> system call.
1188 This function returns a C<struct guestfs_statvfs *>
1189 (see L<statvfs(2)> and E<lt>guestfs-structs.hE<gt>),
1190 or NULL if there was an error.
1191 I<The caller must call C<free> after use>.
1195 int guestfs_sync (guestfs_h *handle);
1197 This syncs the disk, so that any writes are flushed through to the
1198 underlying disk image.
1200 You should always call this if you have modified a disk image, before
1203 This function returns 0 on success or -1 on error.
1205 =head2 guestfs_tar_in
1207 int guestfs_tar_in (guestfs_h *handle,
1208 const char *tarfile,
1209 const char *directory);
1211 This command uploads and unpacks local file C<tarfile> (an
1212 I<uncompressed> tar file) into C<directory>.
1214 To upload a compressed tarball, use C<guestfs_tgz_in>.
1216 This function returns 0 on success or -1 on error.
1218 =head2 guestfs_tar_out
1220 int guestfs_tar_out (guestfs_h *handle,
1221 const char *directory,
1222 const char *tarfile);
1224 This command packs the contents of C<directory> and downloads
1225 it to local file C<tarfile>.
1227 To download a compressed tarball, use C<guestfs_tgz_out>.
1229 This function returns 0 on success or -1 on error.
1231 =head2 guestfs_tgz_in
1233 int guestfs_tgz_in (guestfs_h *handle,
1234 const char *tarball,
1235 const char *directory);
1237 This command uploads and unpacks local file C<tarball> (a
1238 I<gzip compressed> tar file) into C<directory>.
1240 To upload an uncompressed tarball, use C<guestfs_tar_in>.
1242 This function returns 0 on success or -1 on error.
1244 =head2 guestfs_tgz_out
1246 int guestfs_tgz_out (guestfs_h *handle,
1247 const char *directory,
1248 const char *tarball);
1250 This command packs the contents of C<directory> and downloads
1251 it to local file C<tarball>.
1253 To download an uncompressed tarball, use C<guestfs_tar_out>.
1255 This function returns 0 on success or -1 on error.
1257 =head2 guestfs_touch
1259 int guestfs_touch (guestfs_h *handle,
1262 Touch acts like the L<touch(1)> command. It can be used to
1263 update the timestamps on a file, or, if the file does not exist,
1264 to create a new zero-length file.
1266 This function returns 0 on success or -1 on error.
1268 =head2 guestfs_tune2fs_l
1270 char **guestfs_tune2fs_l (guestfs_h *handle,
1271 const char *device);
1273 This returns the contents of the ext2 or ext3 filesystem superblock
1276 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1277 manpage for more details. The list of fields returned isn't
1278 clearly defined, and depends on both the version of C<tune2fs>
1279 that libguestfs was built against, and the filesystem itself.
1281 This function returns a NULL-terminated array of
1282 strings, or NULL if there was an error.
1283 The array of strings will always have length C<2n+1>, where
1284 C<n> keys and values alternate, followed by the trailing NULL entry.
1285 I<The caller must free the strings and the array after use>.
1287 =head2 guestfs_umount
1289 int guestfs_umount (guestfs_h *handle,
1290 const char *pathordevice);
1292 This unmounts the given filesystem. The filesystem may be
1293 specified either by its mountpoint (path) or the device which
1294 contains the filesystem.
1296 This function returns 0 on success or -1 on error.
1298 =head2 guestfs_umount_all
1300 int guestfs_umount_all (guestfs_h *handle);
1302 This unmounts all mounted filesystems.
1304 Some internal mounts are not unmounted by this call.
1306 This function returns 0 on success or -1 on error.
1308 =head2 guestfs_upload
1310 int guestfs_upload (guestfs_h *handle,
1311 const char *filename,
1312 const char *remotefilename);
1314 Upload local file C<filename> to C<remotefilename> on the
1317 C<filename> can also be a named pipe.
1319 See also C<guestfs_download>.
1321 This function returns 0 on success or -1 on error.
1323 =head2 guestfs_vgcreate
1325 int guestfs_vgcreate (guestfs_h *handle,
1326 const char *volgroup,
1327 char * const* const physvols);
1329 This creates an LVM volume group called C<volgroup>
1330 from the non-empty list of physical volumes C<physvols>.
1332 This function returns 0 on success or -1 on error.
1336 char **guestfs_vgs (guestfs_h *handle);
1338 List all the volumes groups detected. This is the equivalent
1339 of the L<vgs(8)> command.
1341 This returns a list of just the volume group names that were
1342 detected (eg. C<VolGroup00>).
1344 See also C<guestfs_vgs_full>.
1346 This function returns a NULL-terminated array of strings
1347 (like L<environ(3)>), or NULL if there was an error.
1348 I<The caller must free the strings and the array after use>.
1350 =head2 guestfs_vgs_full
1352 struct guestfs_lvm_vg_list *guestfs_vgs_full (guestfs_h *handle);
1354 List all the volumes groups detected. This is the equivalent
1355 of the L<vgs(8)> command. The "full" version includes all fields.
1357 This function returns a C<struct guestfs_lvm_vg_list *>
1358 (see E<lt>guestfs-structs.hE<gt>),
1359 or NULL if there was an error.
1360 I<The caller must call C<guestfs_free_lvm_vg_list> after use>.
1362 =head2 guestfs_wait_ready
1364 int guestfs_wait_ready (guestfs_h *handle);
1366 Internally libguestfs is implemented by running a virtual machine
1369 You should call this after C<guestfs_launch> to wait for the launch
1372 This function returns 0 on success or -1 on error.
1374 =head2 guestfs_write_file
1376 int guestfs_write_file (guestfs_h *handle,
1378 const char *content,
1381 This call creates a file called C<path>. The contents of the
1382 file is the string C<content> (which can contain any 8 bit data),
1383 with length C<size>.
1385 As a special case, if C<size> is C<0>
1386 then the length is calculated using C<strlen> (so in this case
1387 the content cannot contain embedded ASCII NULs).
1389 This function returns 0 on success or -1 on error.
1391 Because of the message protocol, there is a transfer limit
1392 of somewhere between 2MB and 4MB. To transfer large files you should use