1 # libguestfs generated file
2 # WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.
3 # ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.
5 # Copyright (C) 2009 Red Hat Inc.
7 # This library is free software; you can redistribute it and/or
8 # modify it under the terms of the GNU Lesser General Public
9 # License as published by the Free Software Foundation; either
10 # version 2 of the License, or (at your option) any later version.
12 # This library is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # Lesser General Public License for more details.
17 # You should have received a copy of the GNU Lesser General Public
18 # License along with this library; if not, write to the Free Software
19 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 Sys::Guestfs - Perl bindings for libguestfs
31 my $h = Sys::Guestfs->new ();
32 $h->add_drive ('guest.img');
35 $h->mount ('/dev/sda1', '/');
41 The C<Sys::Guestfs> module provides a Perl XS binding to the
42 libguestfs API for examining and modifying virtual machine
45 Amongst the things this is good for: making batch configuration
46 changes to guests, getting disk used/free statistics (see also:
47 virt-df), migrating between virtualization systems (see also:
48 virt-p2v), performing partial backups, performing partial guest
49 clones, cloning guests and changing registry/UUID/hostname info, and
52 Libguestfs uses Linux kernel and qemu code, and can access any type of
53 guest filesystem that Linux and qemu can, including but not limited
54 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
55 schemes, qcow, qcow2, vmdk.
57 Libguestfs provides ways to enumerate guest storage (eg. partitions,
58 LVs, what filesystem is in each LV, etc.). It can also run commands
59 in the context of the guest. Also you can access filesystems over FTP.
63 All errors turn into calls to C<croak> (see L<Carp(3)>).
77 XSLoader::load ('Sys::Guestfs');
79 =item $h = Sys::Guestfs->new ();
81 Create a new guestfs handle.
87 my $class = ref ($proto) || $proto;
89 my $self = Sys::Guestfs::_create ();
94 =item $h->add_cdrom ($filename);
96 This function adds a virtual CD-ROM disk image to the guest.
98 This is equivalent to the qemu parameter C<-cdrom filename>.
100 =item $h->add_drive ($filename);
102 This function adds a virtual machine disk image C<filename> to the
103 guest. The first time you call this function, the disk appears as IDE
104 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
107 You don't necessarily need to be root when using libguestfs. However
108 you obviously do need sufficient permissions to access the filename
109 for whatever operations you want to perform (ie. read access if you
110 just want to read the image or write access if you want to modify the
113 This is equivalent to the qemu parameter C<-drive file=filename>.
115 =item $h->aug_close ();
117 Close the current Augeas handle and free up any resources
118 used by it. After calling this, you have to call
119 C<$h-E<gt>aug_init> again before you can use any other
122 =item ($nrnodes, $created) = $h->aug_defnode ($name, $expr, $val);
124 Defines a variable C<name> whose value is the result of
127 If C<expr> evaluates to an empty nodeset, a node is created,
128 equivalent to calling C<$h-E<gt>aug_set> C<expr>, C<value>.
129 C<name> will be the nodeset containing that single node.
131 On success this returns a pair containing the
132 number of nodes in the nodeset, and a boolean flag
133 if a node was created.
135 =item $nrnodes = $h->aug_defvar ($name, $expr);
137 Defines an Augeas variable C<name> whose value is the result
138 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
141 On success this returns the number of nodes in C<expr>, or
142 C<0> if C<expr> evaluates to something which is not a nodeset.
144 =item $val = $h->aug_get ($path);
146 Look up the value associated with C<path>. If C<path>
147 matches exactly one node, the C<value> is returned.
149 =item $h->aug_init ($root, $flags);
151 Create a new Augeas handle for editing configuration files.
152 If there was any previous Augeas handle associated with this
153 guestfs session, then it is closed.
155 You must call this before using any other C<$h-E<gt>aug_*>
158 C<root> is the filesystem root. C<root> must not be NULL,
161 The flags are the same as the flags defined in
162 E<lt>augeas.hE<gt>, the logical I<or> of the following
167 =item C<AUG_SAVE_BACKUP> = 1
169 Keep the original file with a C<.augsave> extension.
171 =item C<AUG_SAVE_NEWFILE> = 2
173 Save changes into a file with extension C<.augnew>, and
174 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
176 =item C<AUG_TYPE_CHECK> = 4
178 Typecheck lenses (can be expensive).
180 =item C<AUG_NO_STDINC> = 8
182 Do not use standard load path for modules.
184 =item C<AUG_SAVE_NOOP> = 16
186 Make save a no-op, just record what would have been changed.
188 =item C<AUG_NO_LOAD> = 32
190 Do not load the tree in C<$h-E<gt>aug_init>.
194 To close the handle, you can call C<$h-E<gt>aug_close>.
196 To find out more about Augeas, see L<http://augeas.net/>.
198 =item $h->aug_insert ($path, $label, $before);
200 Create a new sibling C<label> for C<path>, inserting it into
201 the tree before or after C<path> (depending on the boolean
204 C<path> must match exactly one existing node in the tree, and
205 C<label> must be a label, ie. not contain C</>, C<*> or end
206 with a bracketed index C<[N]>.
208 =item $h->aug_load ();
210 Load files into the tree.
212 See C<aug_load> in the Augeas documentation for the full gory
215 =item @matches = $h->aug_ls ($path);
217 This is just a shortcut for listing C<$h-E<gt>aug_match>
218 C<path/*> and sorting the resulting nodes into alphabetical order.
220 =item @matches = $h->aug_match ($path);
222 Returns a list of paths which match the path expression C<path>.
223 The returned paths are sufficiently qualified so that they match
224 exactly one node in the current tree.
226 =item $h->aug_mv ($src, $dest);
228 Move the node C<src> to C<dest>. C<src> must match exactly
229 one node. C<dest> is overwritten if it exists.
231 =item $nrnodes = $h->aug_rm ($path);
233 Remove C<path> and all of its children.
235 On success this returns the number of entries which were removed.
237 =item $h->aug_save ();
239 This writes all pending changes to disk.
241 The flags which were passed to C<$h-E<gt>aug_init> affect exactly
244 =item $h->aug_set ($path, $val);
246 Set the value associated with C<path> to C<value>.
248 =item $h->blockdev_flushbufs ($device);
250 This tells the kernel to flush internal buffers associated
253 This uses the L<blockdev(8)> command.
255 =item $blocksize = $h->blockdev_getbsz ($device);
257 This returns the block size of a device.
259 (Note this is different from both I<size in blocks> and
260 I<filesystem block size>).
262 This uses the L<blockdev(8)> command.
264 =item $ro = $h->blockdev_getro ($device);
266 Returns a boolean indicating if the block device is read-only
267 (true if read-only, false if not).
269 This uses the L<blockdev(8)> command.
271 =item $sizeinbytes = $h->blockdev_getsize64 ($device);
273 This returns the size of the device in bytes.
275 See also C<$h-E<gt>blockdev_getsz>.
277 This uses the L<blockdev(8)> command.
279 =item $sectorsize = $h->blockdev_getss ($device);
281 This returns the size of sectors on a block device.
282 Usually 512, but can be larger for modern devices.
284 (Note, this is not the size in sectors, use C<$h-E<gt>blockdev_getsz>
287 This uses the L<blockdev(8)> command.
289 =item $sizeinsectors = $h->blockdev_getsz ($device);
291 This returns the size of the device in units of 512-byte sectors
292 (even if the sectorsize isn't 512 bytes ... weird).
294 See also C<$h-E<gt>blockdev_getss> for the real sector size of
295 the device, and C<$h-E<gt>blockdev_getsize64> for the more
296 useful I<size in bytes>.
298 This uses the L<blockdev(8)> command.
300 =item $h->blockdev_rereadpt ($device);
302 Reread the partition table on C<device>.
304 This uses the L<blockdev(8)> command.
306 =item $h->blockdev_setbsz ($device, $blocksize);
308 This sets the block size of a device.
310 (Note this is different from both I<size in blocks> and
311 I<filesystem block size>).
313 This uses the L<blockdev(8)> command.
315 =item $h->blockdev_setro ($device);
317 Sets the block device named C<device> to read-only.
319 This uses the L<blockdev(8)> command.
321 =item $h->blockdev_setrw ($device);
323 Sets the block device named C<device> to read-write.
325 This uses the L<blockdev(8)> command.
327 =item $content = $h->cat ($path);
329 Return the contents of the file named C<path>.
331 Note that this function cannot correctly handle binary files
332 (specifically, files containing C<\0> character which is treated
333 as end of string). For those you need to use the C<$h-E<gt>download>
334 function which has a more complex interface.
336 Because of the message protocol, there is a transfer limit
337 of somewhere between 2MB and 4MB. To transfer large files you should use
340 =item $checksum = $h->checksum ($csumtype, $path);
342 This call computes the MD5, SHAx or CRC checksum of the
345 The type of checksum to compute is given by the C<csumtype>
346 parameter which must have one of the following values:
352 Compute the cyclic redundancy check (CRC) specified by POSIX
353 for the C<cksum> command.
357 Compute the MD5 hash (using the C<md5sum> program).
361 Compute the SHA1 hash (using the C<sha1sum> program).
365 Compute the SHA224 hash (using the C<sha224sum> program).
369 Compute the SHA256 hash (using the C<sha256sum> program).
373 Compute the SHA384 hash (using the C<sha384sum> program).
377 Compute the SHA512 hash (using the C<sha512sum> program).
381 The checksum is returned as a printable string.
383 =item $h->chmod ($mode, $path);
385 Change the mode (permissions) of C<path> to C<mode>. Only
386 numeric modes are supported.
388 =item $h->chown ($owner, $group, $path);
390 Change the file owner to C<owner> and group to C<group>.
392 Only numeric uid and gid are supported. If you want to use
393 names, you will need to locate and parse the password file
394 yourself (Augeas support makes this relatively easy).
396 =item $output = $h->command (\@arguments);
398 This call runs a command from the guest filesystem. The
399 filesystem must be mounted, and must contain a compatible
400 operating system (ie. something Linux, with the same
401 or compatible processor architecture).
403 The single parameter is an argv-style list of arguments.
404 The first element is the name of the program to run.
405 Subsequent elements are parameters. The list must be
406 non-empty (ie. must contain a program name).
408 The return value is anything printed to I<stdout> by
411 If the command returns a non-zero exit status, then
412 this function returns an error message. The error message
413 string is the content of I<stderr> from the command.
415 The C<$PATH> environment variable will contain at least
416 C</usr/bin> and C</bin>. If you require a program from
417 another location, you should provide the full path in the
420 Shared libraries and data files required by the program
421 must be available on filesystems which are mounted in the
422 correct places. It is the caller's responsibility to ensure
423 all filesystems that are needed are mounted at the right
426 Because of the message protocol, there is a transfer limit
427 of somewhere between 2MB and 4MB. To transfer large files you should use
430 =item @lines = $h->command_lines (\@arguments);
432 This is the same as C<$h-E<gt>command>, but splits the
433 result into a list of lines.
435 Because of the message protocol, there is a transfer limit
436 of somewhere between 2MB and 4MB. To transfer large files you should use
439 =item $h->config ($qemuparam, $qemuvalue);
441 This can be used to add arbitrary qemu command line parameters
442 of the form C<-param value>. Actually it's not quite arbitrary - we
443 prevent you from setting some parameters which would interfere with
444 parameters that we use.
446 The first character of C<param> string must be a C<-> (dash).
448 C<value> can be NULL.
450 =item $h->cp ($src, $dest);
452 This copies a file from C<src> to C<dest> where C<dest> is
453 either a destination filename or destination directory.
455 =item $h->cp_a ($src, $dest);
457 This copies a file or directory from C<src> to C<dest>
458 recursively using the C<cp -a> command.
460 =item $result = $h->debug ($subcmd, \@extraargs);
462 The C<$h-E<gt>debug> command exposes some internals of
463 C<guestfsd> (the guestfs daemon) that runs inside the
466 There is no comprehensive help for this command. You have
467 to look at the file C<daemon/debug.c> in the libguestfs source
468 to find out what you can do.
470 =item $kmsgs = $h->dmesg ();
472 This returns the kernel messages (C<dmesg> output) from
473 the guest kernel. This is sometimes useful for extended
474 debugging of problems.
476 Another way to get the same information is to enable
477 verbose messages with C<$h-E<gt>set_verbose> or by setting
478 the environment variable C<LIBGUESTFS_DEBUG=1> before
481 =item $h->download ($remotefilename, $filename);
483 Download file C<remotefilename> and save it as C<filename>
484 on the local machine.
486 C<filename> can also be a named pipe.
488 See also C<$h-E<gt>upload>, C<$h-E<gt>cat>.
490 =item $h->drop_caches ($whattodrop);
492 This instructs the guest kernel to drop its page cache,
493 and/or dentries and inode caches. The parameter C<whattodrop>
494 tells the kernel what precisely to drop, see
495 L<http://linux-mm.org/Drop_Caches>
497 Setting C<whattodrop> to 3 should drop everything.
499 This automatically calls L<sync(2)> before the operation,
500 so that the maximum guest memory is freed.
502 =item $h->end_busy ();
504 This sets the state to C<READY>, or if in C<CONFIG> then it leaves the
505 state as is. This is only used when implementing
506 actions using the low-level API.
508 For more information on states, see L<guestfs(3)>.
510 =item $equality = $h->equal ($file1, $file2);
512 This compares the two files C<file1> and C<file2> and returns
513 true if their content is exactly equal, or false otherwise.
515 The external L<cmp(1)> program is used for the comparison.
517 =item $existsflag = $h->exists ($path);
519 This returns C<true> if and only if there is a file, directory
520 (or anything) with the given C<path> name.
522 See also C<$h-E<gt>is_file>, C<$h-E<gt>is_dir>, C<$h-E<gt>stat>.
524 =item $description = $h->file ($path);
526 This call uses the standard L<file(1)> command to determine
527 the type or contents of the file. This also works on devices,
528 for example to find out whether a partition contains a filesystem.
530 The exact command which runs is C<file -bsL path>. Note in
531 particular that the filename is not prepended to the output
534 =item $status = $h->fsck ($fstype, $device);
536 This runs the filesystem checker (fsck) on C<device> which
537 should have filesystem type C<fstype>.
539 The returned integer is the status. See L<fsck(8)> for the
540 list of status codes from C<fsck>.
548 Multiple status codes can be summed together.
552 A non-zero return code can mean "success", for example if
553 errors have been corrected on the filesystem.
557 Checking or repairing NTFS volumes is not supported
562 This command is entirely equivalent to running C<fsck -a -t fstype device>.
564 =item $append = $h->get_append ();
566 Return the additional kernel options which are added to the
567 guest kernel command line.
569 If C<NULL> then no options are added.
571 =item $autosync = $h->get_autosync ();
573 Get the autosync flag.
575 =item $label = $h->get_e2label ($device);
577 This returns the ext2/3/4 filesystem label of the filesystem on
580 =item $uuid = $h->get_e2uuid ($device);
582 This returns the ext2/3/4 filesystem UUID of the filesystem on
585 =item $path = $h->get_path ();
587 Return the current search path.
589 This is always non-NULL. If it wasn't set already, then this will
590 return the default path.
592 =item $qemu = $h->get_qemu ();
594 Return the current qemu binary.
596 This is always non-NULL. If it wasn't set already, then this will
597 return the default qemu binary name.
599 =item $state = $h->get_state ();
601 This returns the current state as an opaque integer. This is
602 only useful for printing debug and internal error messages.
604 For more information on states, see L<guestfs(3)>.
606 =item $verbose = $h->get_verbose ();
608 This returns the verbose messages flag.
610 =item $h->grub_install ($root, $device);
612 This command installs GRUB (the Grand Unified Bootloader) on
613 C<device>, with the root directory being C<root>.
615 =item $dump = $h->hexdump ($path);
617 This runs C<hexdump -C> on the given C<path>. The result is
618 the human-readable, canonical hex dump of the file.
620 Because of the message protocol, there is a transfer limit
621 of somewhere between 2MB and 4MB. To transfer large files you should use
624 =item $busy = $h->is_busy ();
626 This returns true iff this handle is busy processing a command
627 (in the C<BUSY> state).
629 For more information on states, see L<guestfs(3)>.
631 =item $config = $h->is_config ();
633 This returns true iff this handle is being configured
634 (in the C<CONFIG> state).
636 For more information on states, see L<guestfs(3)>.
638 =item $dirflag = $h->is_dir ($path);
640 This returns C<true> if and only if there is a directory
641 with the given C<path> name. Note that it returns false for
642 other objects like files.
644 See also C<$h-E<gt>stat>.
646 =item $fileflag = $h->is_file ($path);
648 This returns C<true> if and only if there is a file
649 with the given C<path> name. Note that it returns false for
650 other objects like directories.
652 See also C<$h-E<gt>stat>.
654 =item $launching = $h->is_launching ();
656 This returns true iff this handle is launching the subprocess
657 (in the C<LAUNCHING> state).
659 For more information on states, see L<guestfs(3)>.
661 =item $ready = $h->is_ready ();
663 This returns true iff this handle is ready to accept commands
664 (in the C<READY> state).
666 For more information on states, see L<guestfs(3)>.
668 =item $h->kill_subprocess ();
670 This kills the qemu subprocess. You should never need to call this.
674 Internally libguestfs is implemented by running a virtual machine
677 You should call this after configuring the handle
678 (eg. adding drives) but before performing any actions.
680 =item @devices = $h->list_devices ();
682 List all the block devices.
684 The full block device names are returned, eg. C</dev/sda>
686 =item @partitions = $h->list_partitions ();
688 List all the partitions detected on all block devices.
690 The full partition device names are returned, eg. C</dev/sda1>
692 This does not return logical volumes. For that you will need to
695 =item $listing = $h->ll ($directory);
697 List the files in C<directory> (relative to the root directory,
698 there is no cwd) in the format of 'ls -la'.
700 This command is mostly useful for interactive sessions. It
701 is I<not> intended that you try to parse the output string.
703 =item @listing = $h->ls ($directory);
705 List the files in C<directory> (relative to the root directory,
706 there is no cwd). The '.' and '..' entries are not returned, but
707 hidden files are shown.
709 This command is mostly useful for interactive sessions. Programs
710 should probably use C<$h-E<gt>readdir> instead.
712 =item %statbuf = $h->lstat ($path);
714 Returns file information for the given C<path>.
716 This is the same as C<$h-E<gt>stat> except that if C<path>
717 is a symbolic link, then the link is stat-ed, not the file it
720 This is the same as the C<lstat(2)> system call.
722 =item $h->lvcreate ($logvol, $volgroup, $mbytes);
724 This creates an LVM volume group called C<logvol>
725 on the volume group C<volgroup>, with C<size> megabytes.
727 =item $h->lvm_remove_all ();
729 This command removes all LVM logical volumes, volume groups
730 and physical volumes.
732 B<This command is dangerous. Without careful use you
733 can easily destroy all your data>.
735 =item $h->lvremove ($device);
737 Remove an LVM logical volume C<device>, where C<device> is
738 the path to the LV, such as C</dev/VG/LV>.
740 You can also remove all LVs in a volume group by specifying
741 the VG name, C</dev/VG>.
743 =item $h->lvresize ($device, $mbytes);
745 This resizes (expands or shrinks) an existing LVM logical
746 volume to C<mbytes>. When reducing, data in the reduced part
749 =item @logvols = $h->lvs ();
751 List all the logical volumes detected. This is the equivalent
752 of the L<lvs(8)> command.
754 This returns a list of the logical volume device names
755 (eg. C</dev/VolGroup00/LogVol00>).
757 See also C<$h-E<gt>lvs_full>.
759 =item @logvols = $h->lvs_full ();
761 List all the logical volumes detected. This is the equivalent
762 of the L<lvs(8)> command. The "full" version includes all fields.
764 =item $h->mkdir ($path);
766 Create a directory named C<path>.
768 =item $h->mkdir_p ($path);
770 Create a directory named C<path>, creating any parent directories
771 as necessary. This is like the C<mkdir -p> shell command.
773 =item $h->mkfs ($fstype, $device);
775 This creates a filesystem on C<device> (usually a partition
776 or LVM logical volume). The filesystem type is C<fstype>, for
779 =item $h->mount ($device, $mountpoint);
781 Mount a guest disk at a position in the filesystem. Block devices
782 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
783 the guest. If those block devices contain partitions, they will have
784 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
787 The rules are the same as for L<mount(2)>: A filesystem must
788 first be mounted on C</> before others can be mounted. Other
789 filesystems can only be mounted on directories which already
792 The mounted filesystem is writable, if we have sufficient permissions
793 on the underlying device.
795 The filesystem options C<sync> and C<noatime> are set with this
796 call, in order to improve reliability.
798 =item $h->mount_options ($options, $device, $mountpoint);
800 This is the same as the C<$h-E<gt>mount> command, but it
801 allows you to set the mount options as for the
802 L<mount(8)> I<-o> flag.
804 =item $h->mount_ro ($device, $mountpoint);
806 This is the same as the C<$h-E<gt>mount> command, but it
807 mounts the filesystem with the read-only (I<-o ro>) flag.
809 =item $h->mount_vfs ($options, $vfstype, $device, $mountpoint);
811 This is the same as the C<$h-E<gt>mount> command, but it
812 allows you to set both the mount options and the vfstype
813 as for the L<mount(8)> I<-o> and I<-t> flags.
815 =item @devices = $h->mounts ();
817 This returns the list of currently mounted filesystems. It returns
818 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
820 Some internal mounts are not shown.
822 =item $h->mv ($src, $dest);
824 This moves a file from C<src> to C<dest> where C<dest> is
825 either a destination filename or destination directory.
827 =item $h->ping_daemon ();
829 This is a test probe into the guestfs daemon running inside
830 the qemu subprocess. Calling this function checks that the
831 daemon responds to the ping message, without affecting the daemon
832 or attached block device(s) in any other way.
834 =item $h->pvcreate ($device);
836 This creates an LVM physical volume on the named C<device>,
837 where C<device> should usually be a partition name such
840 =item $h->pvremove ($device);
842 This wipes a physical volume C<device> so that LVM will no longer
845 The implementation uses the C<pvremove> command which refuses to
846 wipe physical volumes that contain any volume groups, so you have
847 to remove those first.
849 =item $h->pvresize ($device);
851 This resizes (expands or shrinks) an existing LVM physical
852 volume to match the new size of the underlying device.
854 =item @physvols = $h->pvs ();
856 List all the physical volumes detected. This is the equivalent
857 of the L<pvs(8)> command.
859 This returns a list of just the device names that contain
860 PVs (eg. C</dev/sda2>).
862 See also C<$h-E<gt>pvs_full>.
864 =item @physvols = $h->pvs_full ();
866 List all the physical volumes detected. This is the equivalent
867 of the L<pvs(8)> command. The "full" version includes all fields.
869 =item @lines = $h->read_lines ($path);
871 Return the contents of the file named C<path>.
873 The file contents are returned as a list of lines. Trailing
874 C<LF> and C<CRLF> character sequences are I<not> returned.
876 Note that this function cannot correctly handle binary files
877 (specifically, files containing C<\0> character which is treated
878 as end of line). For those you need to use the C<$h-E<gt>read_file>
879 function which has a more complex interface.
881 =item $h->resize2fs ($device);
883 This resizes an ext2 or ext3 filesystem to match the size of
884 the underlying device.
886 =item $h->rm ($path);
888 Remove the single file C<path>.
890 =item $h->rm_rf ($path);
892 Remove the file or directory C<path>, recursively removing the
893 contents if its a directory. This is like the C<rm -rf> shell
896 =item $h->rmdir ($path);
898 Remove the single directory C<path>.
900 =item $h->set_append ($append);
902 This function is used to add additional options to the
903 guest kernel command line.
905 The default is C<NULL> unless overridden by setting
906 C<LIBGUESTFS_APPEND> environment variable.
908 Setting C<append> to C<NULL> means I<no> additional options
909 are passed (libguestfs always adds a few of its own).
911 =item $h->set_autosync ($autosync);
913 If C<autosync> is true, this enables autosync. Libguestfs will make a
914 best effort attempt to run C<$h-E<gt>umount_all> followed by
915 C<$h-E<gt>sync> when the handle is closed
916 (also if the program exits without closing handles).
918 This is disabled by default (except in guestfish where it is
921 =item $h->set_busy ();
923 This sets the state to C<BUSY>. This is only used when implementing
924 actions using the low-level API.
926 For more information on states, see L<guestfs(3)>.
928 =item $h->set_e2label ($device, $label);
930 This sets the ext2/3/4 filesystem label of the filesystem on
931 C<device> to C<label>. Filesystem labels are limited to
934 You can use either C<$h-E<gt>tune2fs_l> or C<$h-E<gt>get_e2label>
935 to return the existing label on a filesystem.
937 =item $h->set_e2uuid ($device, $uuid);
939 This sets the ext2/3/4 filesystem UUID of the filesystem on
940 C<device> to C<uuid>. The format of the UUID and alternatives
941 such as C<clear>, C<random> and C<time> are described in the
942 L<tune2fs(8)> manpage.
944 You can use either C<$h-E<gt>tune2fs_l> or C<$h-E<gt>get_e2uuid>
945 to return the existing UUID of a filesystem.
947 =item $h->set_path ($path);
949 Set the path that libguestfs searches for kernel and initrd.img.
951 The default is C<$libdir/guestfs> unless overridden by setting
952 C<LIBGUESTFS_PATH> environment variable.
954 Setting C<path> to C<NULL> restores the default path.
956 =item $h->set_qemu ($qemu);
958 Set the qemu binary that we will use.
960 The default is chosen when the library was compiled by the
963 You can also override this by setting the C<LIBGUESTFS_QEMU>
964 environment variable.
966 Setting C<qemu> to C<NULL> restores the default qemu binary.
968 =item $h->set_ready ();
970 This sets the state to C<READY>. This is only used when implementing
971 actions using the low-level API.
973 For more information on states, see L<guestfs(3)>.
975 =item $h->set_verbose ($verbose);
977 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
979 Verbose messages are disabled unless the environment variable
980 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
982 =item $h->sfdisk ($device, $cyls, $heads, $sectors, \@lines);
984 This is a direct interface to the L<sfdisk(8)> program for creating
985 partitions on block devices.
987 C<device> should be a block device, for example C</dev/sda>.
989 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
990 and sectors on the device, which are passed directly to sfdisk as
991 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
992 of these, then the corresponding parameter is omitted. Usually for
993 'large' disks, you can just pass C<0> for these, but for small
994 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
995 out the right geometry and you will need to tell it.
997 C<lines> is a list of lines that we feed to C<sfdisk>. For more
998 information refer to the L<sfdisk(8)> manpage.
1000 To create a single partition occupying the whole disk, you would
1001 pass C<lines> as a single element list, when the single element being
1002 the string C<,> (comma).
1004 See also: C<$h-E<gt>sfdisk_l>, C<$h-E<gt>sfdisk_N>
1006 B<This command is dangerous. Without careful use you
1007 can easily destroy all your data>.
1009 =item $h->sfdisk_N ($device, $n, $cyls, $heads, $sectors, $line);
1011 This runs L<sfdisk(8)> option to modify just the single
1012 partition C<n> (note: C<n> counts from 1).
1014 For other parameters, see C<$h-E<gt>sfdisk>. You should usually
1015 pass C<0> for the cyls/heads/sectors parameters.
1017 B<This command is dangerous. Without careful use you
1018 can easily destroy all your data>.
1020 =item $partitions = $h->sfdisk_disk_geometry ($device);
1022 This displays the disk geometry of C<device> read from the
1023 partition table. Especially in the case where the underlying
1024 block device has been resized, this can be different from the
1025 kernel's idea of the geometry (see C<$h-E<gt>sfdisk_kernel_geometry>).
1027 The result is in human-readable format, and not designed to
1030 =item $partitions = $h->sfdisk_kernel_geometry ($device);
1032 This displays the kernel's idea of the geometry of C<device>.
1034 The result is in human-readable format, and not designed to
1037 =item $partitions = $h->sfdisk_l ($device);
1039 This displays the partition table on C<device>, in the
1040 human-readable output of the L<sfdisk(8)> command. It is
1041 not intended to be parsed.
1043 =item %statbuf = $h->stat ($path);
1045 Returns file information for the given C<path>.
1047 This is the same as the C<stat(2)> system call.
1049 =item %statbuf = $h->statvfs ($path);
1051 Returns file system statistics for any mounted file system.
1052 C<path> should be a file or directory in the mounted file system
1053 (typically it is the mount point itself, but it doesn't need to be).
1055 This is the same as the C<statvfs(2)> system call.
1057 =item @stringsout = $h->strings ($path);
1059 This runs the L<strings(1)> command on a file and returns
1060 the list of printable strings found.
1062 Because of the message protocol, there is a transfer limit
1063 of somewhere between 2MB and 4MB. To transfer large files you should use
1066 =item @stringsout = $h->strings_e ($encoding, $path);
1068 This is like the C<$h-E<gt>strings> command, but allows you to
1069 specify the encoding.
1071 See the L<strings(1)> manpage for the full list of encodings.
1073 Commonly useful encodings are C<l> (lower case L) which will
1074 show strings inside Windows/x86 files.
1076 The returned strings are transcoded to UTF-8.
1078 Because of the message protocol, there is a transfer limit
1079 of somewhere between 2MB and 4MB. To transfer large files you should use
1084 This syncs the disk, so that any writes are flushed through to the
1085 underlying disk image.
1087 You should always call this if you have modified a disk image, before
1090 =item $h->tar_in ($tarfile, $directory);
1092 This command uploads and unpacks local file C<tarfile> (an
1093 I<uncompressed> tar file) into C<directory>.
1095 To upload a compressed tarball, use C<$h-E<gt>tgz_in>.
1097 =item $h->tar_out ($directory, $tarfile);
1099 This command packs the contents of C<directory> and downloads
1100 it to local file C<tarfile>.
1102 To download a compressed tarball, use C<$h-E<gt>tgz_out>.
1104 =item $h->tgz_in ($tarball, $directory);
1106 This command uploads and unpacks local file C<tarball> (a
1107 I<gzip compressed> tar file) into C<directory>.
1109 To upload an uncompressed tarball, use C<$h-E<gt>tar_in>.
1111 =item $h->tgz_out ($directory, $tarball);
1113 This command packs the contents of C<directory> and downloads
1114 it to local file C<tarball>.
1116 To download an uncompressed tarball, use C<$h-E<gt>tar_out>.
1118 =item $h->touch ($path);
1120 Touch acts like the L<touch(1)> command. It can be used to
1121 update the timestamps on a file, or, if the file does not exist,
1122 to create a new zero-length file.
1124 =item %superblock = $h->tune2fs_l ($device);
1126 This returns the contents of the ext2, ext3 or ext4 filesystem
1127 superblock on C<device>.
1129 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1130 manpage for more details. The list of fields returned isn't
1131 clearly defined, and depends on both the version of C<tune2fs>
1132 that libguestfs was built against, and the filesystem itself.
1134 =item $h->umount ($pathordevice);
1136 This unmounts the given filesystem. The filesystem may be
1137 specified either by its mountpoint (path) or the device which
1138 contains the filesystem.
1140 =item $h->umount_all ();
1142 This unmounts all mounted filesystems.
1144 Some internal mounts are not unmounted by this call.
1146 =item $h->upload ($filename, $remotefilename);
1148 Upload local file C<filename> to C<remotefilename> on the
1151 C<filename> can also be a named pipe.
1153 See also C<$h-E<gt>download>.
1155 =item $h->vg_activate ($activate, \@volgroups);
1157 This command activates or (if C<activate> is false) deactivates
1158 all logical volumes in the listed volume groups C<volgroups>.
1159 If activated, then they are made known to the
1160 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
1161 then those devices disappear.
1163 This command is the same as running C<vgchange -a y|n volgroups...>
1165 Note that if C<volgroups> is an empty list then B<all> volume groups
1166 are activated or deactivated.
1168 =item $h->vg_activate_all ($activate);
1170 This command activates or (if C<activate> is false) deactivates
1171 all logical volumes in all volume groups.
1172 If activated, then they are made known to the
1173 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
1174 then those devices disappear.
1176 This command is the same as running C<vgchange -a y|n>
1178 =item $h->vgcreate ($volgroup, \@physvols);
1180 This creates an LVM volume group called C<volgroup>
1181 from the non-empty list of physical volumes C<physvols>.
1183 =item $h->vgremove ($vgname);
1185 Remove an LVM volume group C<vgname>, (for example C<VG>).
1187 This also forcibly removes all logical volumes in the volume
1190 =item @volgroups = $h->vgs ();
1192 List all the volumes groups detected. This is the equivalent
1193 of the L<vgs(8)> command.
1195 This returns a list of just the volume group names that were
1196 detected (eg. C<VolGroup00>).
1198 See also C<$h-E<gt>vgs_full>.
1200 =item @volgroups = $h->vgs_full ();
1202 List all the volumes groups detected. This is the equivalent
1203 of the L<vgs(8)> command. The "full" version includes all fields.
1205 =item $h->wait_ready ();
1207 Internally libguestfs is implemented by running a virtual machine
1210 You should call this after C<$h-E<gt>launch> to wait for the launch
1213 =item $h->write_file ($path, $content, $size);
1215 This call creates a file called C<path>. The contents of the
1216 file is the string C<content> (which can contain any 8 bit data),
1217 with length C<size>.
1219 As a special case, if C<size> is C<0>
1220 then the length is calculated using C<strlen> (so in this case
1221 the content cannot contain embedded ASCII NULs).
1223 I<NB.> Owing to a bug, writing content containing ASCII NUL
1224 characters does I<not> work, even if the length is specified.
1225 We hope to resolve this bug in a future version. In the meantime
1226 use C<$h-E<gt>upload>.
1228 Because of the message protocol, there is a transfer limit
1229 of somewhere between 2MB and 4MB. To transfer large files you should use
1232 =item $h->zero ($device);
1234 This command writes zeroes over the first few blocks of C<device>.
1236 How many blocks are zeroed isn't specified (but it's I<not> enough
1237 to securely wipe the device). It should be sufficient to remove
1238 any partition tables, filesystem superblocks and so on.
1240 =item $h->zerofree ($device);
1242 This runs the I<zerofree> program on C<device>. This program
1243 claims to zero unused inodes and disk blocks on an ext2/3
1244 filesystem, thus making it possible to compress the filesystem
1247 You should B<not> run this program if the filesystem is
1250 It is possible that using this program can damage the filesystem
1251 or data on the filesystem.
1261 Copyright (C) 2009 Red Hat Inc.
1265 Please see the file COPYING.LIB for the full license.
1269 L<guestfs(3)>, L<guestfish(1)>.