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 $h->chmod ($mode, $path);
342 Change the mode (permissions) of C<path> to C<mode>. Only
343 numeric modes are supported.
345 =item $h->chown ($owner, $group, $path);
347 Change the file owner to C<owner> and group to C<group>.
349 Only numeric uid and gid are supported. If you want to use
350 names, you will need to locate and parse the password file
351 yourself (Augeas support makes this relatively easy).
353 =item $output = $h->command (\@arguments);
355 This call runs a command from the guest filesystem. The
356 filesystem must be mounted, and must contain a compatible
357 operating system (ie. something Linux, with the same
358 or compatible processor architecture).
360 The single parameter is an argv-style list of arguments.
361 The first element is the name of the program to run.
362 Subsequent elements are parameters. The list must be
363 non-empty (ie. must contain a program name).
365 The C<$PATH> environment variable will contain at least
366 C</usr/bin> and C</bin>. If you require a program from
367 another location, you should provide the full path in the
370 Shared libraries and data files required by the program
371 must be available on filesystems which are mounted in the
372 correct places. It is the caller's responsibility to ensure
373 all filesystems that are needed are mounted at the right
376 =item @lines = $h->command_lines (\@arguments);
378 This is the same as C<$h-E<gt>command>, but splits the
379 result into a list of lines.
381 =item $h->config ($qemuparam, $qemuvalue);
383 This can be used to add arbitrary qemu command line parameters
384 of the form C<-param value>. Actually it's not quite arbitrary - we
385 prevent you from setting some parameters which would interfere with
386 parameters that we use.
388 The first character of C<param> string must be a C<-> (dash).
390 C<value> can be NULL.
392 =item $existsflag = $h->exists ($path);
394 This returns C<true> if and only if there is a file, directory
395 (or anything) with the given C<path> name.
397 See also C<$h-E<gt>is_file>, C<$h-E<gt>is_dir>, C<$h-E<gt>stat>.
399 =item $description = $h->file ($path);
401 This call uses the standard L<file(1)> command to determine
402 the type or contents of the file. This also works on devices,
403 for example to find out whether a partition contains a filesystem.
405 The exact command which runs is C<file -bsL path>. Note in
406 particular that the filename is not prepended to the output
409 =item $autosync = $h->get_autosync ();
411 Get the autosync flag.
413 =item $path = $h->get_path ();
415 Return the current search path.
417 This is always non-NULL. If it wasn't set already, then this will
418 return the default path.
420 =item $state = $h->get_state ();
422 This returns the current state as an opaque integer. This is
423 only useful for printing debug and internal error messages.
425 For more information on states, see L<guestfs(3)>.
427 =item $verbose = $h->get_verbose ();
429 This returns the verbose messages flag.
431 =item $busy = $h->is_busy ();
433 This returns true iff this handle is busy processing a command
434 (in the C<BUSY> state).
436 For more information on states, see L<guestfs(3)>.
438 =item $config = $h->is_config ();
440 This returns true iff this handle is being configured
441 (in the C<CONFIG> state).
443 For more information on states, see L<guestfs(3)>.
445 =item $dirflag = $h->is_dir ($path);
447 This returns C<true> if and only if there is a directory
448 with the given C<path> name. Note that it returns false for
449 other objects like files.
451 See also C<$h-E<gt>stat>.
453 =item $fileflag = $h->is_file ($path);
455 This returns C<true> if and only if there is a file
456 with the given C<path> name. Note that it returns false for
457 other objects like directories.
459 See also C<$h-E<gt>stat>.
461 =item $launching = $h->is_launching ();
463 This returns true iff this handle is launching the subprocess
464 (in the C<LAUNCHING> state).
466 For more information on states, see L<guestfs(3)>.
468 =item $ready = $h->is_ready ();
470 This returns true iff this handle is ready to accept commands
471 (in the C<READY> state).
473 For more information on states, see L<guestfs(3)>.
475 =item $h->kill_subprocess ();
477 This kills the qemu subprocess. You should never need to call this.
481 Internally libguestfs is implemented by running a virtual machine
484 You should call this after configuring the handle
485 (eg. adding drives) but before performing any actions.
487 =item @devices = $h->list_devices ();
489 List all the block devices.
491 The full block device names are returned, eg. C</dev/sda>
493 =item @partitions = $h->list_partitions ();
495 List all the partitions detected on all block devices.
497 The full partition device names are returned, eg. C</dev/sda1>
499 This does not return logical volumes. For that you will need to
502 =item $listing = $h->ll ($directory);
504 List the files in C<directory> (relative to the root directory,
505 there is no cwd) in the format of 'ls -la'.
507 This command is mostly useful for interactive sessions. It
508 is I<not> intended that you try to parse the output string.
510 =item @listing = $h->ls ($directory);
512 List the files in C<directory> (relative to the root directory,
513 there is no cwd). The '.' and '..' entries are not returned, but
514 hidden files are shown.
516 This command is mostly useful for interactive sessions. Programs
517 should probably use C<$h-E<gt>readdir> instead.
519 =item %statbuf = $h->lstat ($path);
521 Returns file information for the given C<path>.
523 This is the same as C<$h-E<gt>stat> except that if C<path>
524 is a symbolic link, then the link is stat-ed, not the file it
527 This is the same as the C<lstat(2)> system call.
529 =item $h->lvcreate ($logvol, $volgroup, $mbytes);
531 This creates an LVM volume group called C<logvol>
532 on the volume group C<volgroup>, with C<size> megabytes.
534 =item $h->lvm_remove_all ();
536 This command removes all LVM logical volumes, volume groups
537 and physical volumes.
539 B<This command is dangerous. Without careful use you
540 can easily destroy all your data>.
542 =item @logvols = $h->lvs ();
544 List all the logical volumes detected. This is the equivalent
545 of the L<lvs(8)> command.
547 This returns a list of the logical volume device names
548 (eg. C</dev/VolGroup00/LogVol00>).
550 See also C<$h-E<gt>lvs_full>.
552 =item @logvols = $h->lvs_full ();
554 List all the logical volumes detected. This is the equivalent
555 of the L<lvs(8)> command. The "full" version includes all fields.
557 =item $h->mkdir ($path);
559 Create a directory named C<path>.
561 =item $h->mkdir_p ($path);
563 Create a directory named C<path>, creating any parent directories
564 as necessary. This is like the C<mkdir -p> shell command.
566 =item $h->mkfs ($fstype, $device);
568 This creates a filesystem on C<device> (usually a partition
569 of LVM logical volume). The filesystem type is C<fstype>, for
572 =item $h->mount ($device, $mountpoint);
574 Mount a guest disk at a position in the filesystem. Block devices
575 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
576 the guest. If those block devices contain partitions, they will have
577 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
580 The rules are the same as for L<mount(2)>: A filesystem must
581 first be mounted on C</> before others can be mounted. Other
582 filesystems can only be mounted on directories which already
585 The mounted filesystem is writable, if we have sufficient permissions
586 on the underlying device.
588 The filesystem options C<sync> and C<noatime> are set with this
589 call, in order to improve reliability.
591 =item @devices = $h->mounts ();
593 This returns the list of currently mounted filesystems. It returns
594 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
596 Some internal mounts are not shown.
598 =item $h->pvcreate ($device);
600 This creates an LVM physical volume on the named C<device>,
601 where C<device> should usually be a partition name such
604 =item @physvols = $h->pvs ();
606 List all the physical volumes detected. This is the equivalent
607 of the L<pvs(8)> command.
609 This returns a list of just the device names that contain
610 PVs (eg. C</dev/sda2>).
612 See also C<$h-E<gt>pvs_full>.
614 =item @physvols = $h->pvs_full ();
616 List all the physical volumes detected. This is the equivalent
617 of the L<pvs(8)> command. The "full" version includes all fields.
619 =item @lines = $h->read_lines ($path);
621 Return the contents of the file named C<path>.
623 The file contents are returned as a list of lines. Trailing
624 C<LF> and C<CRLF> character sequences are I<not> returned.
626 Note that this function cannot correctly handle binary files
627 (specifically, files containing C<\0> character which is treated
628 as end of line). For those you need to use the C<$h-E<gt>read_file>
629 function which has a more complex interface.
631 =item $h->rm ($path);
633 Remove the single file C<path>.
635 =item $h->rm_rf ($path);
637 Remove the file or directory C<path>, recursively removing the
638 contents if its a directory. This is like the C<rm -rf> shell
641 =item $h->rmdir ($path);
643 Remove the single directory C<path>.
645 =item $h->set_autosync ($autosync);
647 If C<autosync> is true, this enables autosync. Libguestfs will make a
648 best effort attempt to run C<$h-E<gt>sync> when the handle is closed
649 (also if the program exits without closing handles).
651 =item $h->set_path ($path);
653 Set the path that libguestfs searches for kernel and initrd.img.
655 The default is C<$libdir/guestfs> unless overridden by setting
656 C<LIBGUESTFS_PATH> environment variable.
658 The string C<path> is stashed in the libguestfs handle, so the caller
659 must make sure it remains valid for the lifetime of the handle.
661 Setting C<path> to C<NULL> restores the default path.
663 =item $h->set_verbose ($verbose);
665 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
667 Verbose messages are disabled unless the environment variable
668 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
670 =item $h->sfdisk ($device, $cyls, $heads, $sectors, \@lines);
672 This is a direct interface to the L<sfdisk(8)> program for creating
673 partitions on block devices.
675 C<device> should be a block device, for example C</dev/sda>.
677 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
678 and sectors on the device, which are passed directly to sfdisk as
679 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
680 of these, then the corresponding parameter is omitted. Usually for
681 'large' disks, you can just pass C<0> for these, but for small
682 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
683 out the right geometry and you will need to tell it.
685 C<lines> is a list of lines that we feed to C<sfdisk>. For more
686 information refer to the L<sfdisk(8)> manpage.
688 To create a single partition occupying the whole disk, you would
689 pass C<lines> as a single element list, when the single element being
690 the string C<,> (comma).
692 B<This command is dangerous. Without careful use you
693 can easily destroy all your data>.
695 =item %statbuf = $h->stat ($path);
697 Returns file information for the given C<path>.
699 This is the same as the C<stat(2)> system call.
701 =item %statbuf = $h->statvfs ($path);
703 Returns file system statistics for any mounted file system.
704 C<path> should be a file or directory in the mounted file system
705 (typically it is the mount point itself, but it doesn't need to be).
707 This is the same as the C<statvfs(2)> system call.
711 This syncs the disk, so that any writes are flushed through to the
712 underlying disk image.
714 You should always call this if you have modified a disk image, before
717 =item $h->touch ($path);
719 Touch acts like the L<touch(1)> command. It can be used to
720 update the timestamps on a file, or, if the file does not exist,
721 to create a new zero-length file.
723 =item %superblock = $h->tune2fs_l ($device);
725 This returns the contents of the ext2 or ext3 filesystem superblock
728 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
729 manpage for more details. The list of fields returned isn't
730 clearly defined, and depends on both the version of C<tune2fs>
731 that libguestfs was built against, and the filesystem itself.
733 =item $h->umount ($pathordevice);
735 This unmounts the given filesystem. The filesystem may be
736 specified either by its mountpoint (path) or the device which
737 contains the filesystem.
739 =item $h->umount_all ();
741 This unmounts all mounted filesystems.
743 Some internal mounts are not unmounted by this call.
745 =item $h->vgcreate ($volgroup, \@physvols);
747 This creates an LVM volume group called C<volgroup>
748 from the non-empty list of physical volumes C<physvols>.
750 =item @volgroups = $h->vgs ();
752 List all the volumes groups detected. This is the equivalent
753 of the L<vgs(8)> command.
755 This returns a list of just the volume group names that were
756 detected (eg. C<VolGroup00>).
758 See also C<$h-E<gt>vgs_full>.
760 =item @volgroups = $h->vgs_full ();
762 List all the volumes groups detected. This is the equivalent
763 of the L<vgs(8)> command. The "full" version includes all fields.
765 =item $h->wait_ready ();
767 Internally libguestfs is implemented by running a virtual machine
770 You should call this after C<$h-E<gt>launch> to wait for the launch
773 =item $h->write_file ($path, $content, $size);
775 This call creates a file called C<path>. The contents of the
776 file is the string C<content> (which can contain any 8 bit data),
779 As a special case, if C<size> is C<0>
780 then the length is calculated using C<strlen> (so in this case
781 the content cannot contain embedded ASCII NULs).
783 Because of the message protocol, there is a transfer limit
784 of somewhere between 2MB and 4MB. To transfer large files you should use
795 Copyright (C) 2009 Red Hat Inc.
799 Please see the file COPYING.LIB for the full license.
803 L<guestfs(3)>, L<guestfish(1)>.