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 $content = $h->cat ($path);
250 Return the contents of the file named C<path>.
252 Note that this function cannot correctly handle binary files
253 (specifically, files containing C<\0> character which is treated
254 as end of string). For those you need to use the C<$h-E<gt>read_file>
255 function which has a more complex interface.
257 Because of the message protocol, there is a transfer limit
258 of somewhere between 2MB and 4MB. To transfer large files you should use
261 =item $h->chmod ($mode, $path);
263 Change the mode (permissions) of C<path> to C<mode>. Only
264 numeric modes are supported.
266 =item $h->chown ($owner, $group, $path);
268 Change the file owner to C<owner> and group to C<group>.
270 Only numeric uid and gid are supported. If you want to use
271 names, you will need to locate and parse the password file
272 yourself (Augeas support makes this relatively easy).
274 =item $h->config ($qemuparam, $qemuvalue);
276 This can be used to add arbitrary qemu command line parameters
277 of the form C<-param value>. Actually it's not quite arbitrary - we
278 prevent you from setting some parameters which would interfere with
279 parameters that we use.
281 The first character of C<param> string must be a C<-> (dash).
283 C<value> can be NULL.
285 =item $existsflag = $h->exists ($path);
287 This returns C<true> if and only if there is a file, directory
288 (or anything) with the given C<path> name.
290 See also C<$h-E<gt>is_file>, C<$h-E<gt>is_dir>, C<$h-E<gt>stat>.
292 =item $autosync = $h->get_autosync ();
294 Get the autosync flag.
296 =item $path = $h->get_path ();
298 Return the current search path.
300 This is always non-NULL. If it wasn't set already, then this will
301 return the default path.
303 =item $verbose = $h->get_verbose ();
305 This returns the verbose messages flag.
307 =item $dirflag = $h->is_dir ($path);
309 This returns C<true> if and only if there is a directory
310 with the given C<path> name. Note that it returns false for
311 other objects like files.
313 See also C<$h-E<gt>stat>.
315 =item $fileflag = $h->is_file ($path);
317 This returns C<true> if and only if there is a file
318 with the given C<path> name. Note that it returns false for
319 other objects like directories.
321 See also C<$h-E<gt>stat>.
323 =item $h->kill_subprocess ();
325 This kills the qemu subprocess. You should never need to call this.
329 Internally libguestfs is implemented by running a virtual machine
332 You should call this after configuring the handle
333 (eg. adding drives) but before performing any actions.
335 =item @devices = $h->list_devices ();
337 List all the block devices.
339 The full block device names are returned, eg. C</dev/sda>
341 =item @partitions = $h->list_partitions ();
343 List all the partitions detected on all block devices.
345 The full partition device names are returned, eg. C</dev/sda1>
347 This does not return logical volumes. For that you will need to
350 =item $listing = $h->ll ($directory);
352 List the files in C<directory> (relative to the root directory,
353 there is no cwd) in the format of 'ls -la'.
355 This command is mostly useful for interactive sessions. It
356 is I<not> intended that you try to parse the output string.
358 =item @listing = $h->ls ($directory);
360 List the files in C<directory> (relative to the root directory,
361 there is no cwd). The '.' and '..' entries are not returned, but
362 hidden files are shown.
364 This command is mostly useful for interactive sessions. Programs
365 should probably use C<$h-E<gt>readdir> instead.
367 =item $h->lvcreate ($logvol, $volgroup, $mbytes);
369 This creates an LVM volume group called C<logvol>
370 on the volume group C<volgroup>, with C<size> megabytes.
372 =item $h->lvm_remove_all ();
374 This command removes all LVM logical volumes, volume groups
375 and physical volumes.
377 B<This command is dangerous. Without careful use you
378 can easily destroy all your data>.
380 =item @logvols = $h->lvs ();
382 List all the logical volumes detected. This is the equivalent
383 of the L<lvs(8)> command.
385 This returns a list of the logical volume device names
386 (eg. C</dev/VolGroup00/LogVol00>).
388 See also C<$h-E<gt>lvs_full>.
390 =item @logvols = $h->lvs_full ();
392 List all the logical volumes detected. This is the equivalent
393 of the L<lvs(8)> command. The "full" version includes all fields.
395 =item $h->mkdir ($path);
397 Create a directory named C<path>.
399 =item $h->mkdir_p ($path);
401 Create a directory named C<path>, creating any parent directories
402 as necessary. This is like the C<mkdir -p> shell command.
404 =item $h->mkfs ($fstype, $device);
406 This creates a filesystem on C<device> (usually a partition
407 of LVM logical volume). The filesystem type is C<fstype>, for
410 =item $h->mount ($device, $mountpoint);
412 Mount a guest disk at a position in the filesystem. Block devices
413 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
414 the guest. If those block devices contain partitions, they will have
415 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
418 The rules are the same as for L<mount(2)>: A filesystem must
419 first be mounted on C</> before others can be mounted. Other
420 filesystems can only be mounted on directories which already
423 The mounted filesystem is writable, if we have sufficient permissions
424 on the underlying device.
426 The filesystem options C<sync> and C<noatime> are set with this
427 call, in order to improve reliability.
429 =item @devices = $h->mounts ();
431 This returns the list of currently mounted filesystems. It returns
432 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
434 Some internal mounts are not shown.
436 =item $h->pvcreate ($device);
438 This creates an LVM physical volume on the named C<device>,
439 where C<device> should usually be a partition name such
442 =item @physvols = $h->pvs ();
444 List all the physical volumes detected. This is the equivalent
445 of the L<pvs(8)> command.
447 This returns a list of just the device names that contain
448 PVs (eg. C</dev/sda2>).
450 See also C<$h-E<gt>pvs_full>.
452 =item @physvols = $h->pvs_full ();
454 List all the physical volumes detected. This is the equivalent
455 of the L<pvs(8)> command. The "full" version includes all fields.
457 =item @lines = $h->read_lines ($path);
459 Return the contents of the file named C<path>.
461 The file contents are returned as a list of lines. Trailing
462 C<LF> and C<CRLF> character sequences are I<not> returned.
464 Note that this function cannot correctly handle binary files
465 (specifically, files containing C<\0> character which is treated
466 as end of line). For those you need to use the C<$h-E<gt>read_file>
467 function which has a more complex interface.
469 =item $h->rm ($path);
471 Remove the single file C<path>.
473 =item $h->rm_rf ($path);
475 Remove the file or directory C<path>, recursively removing the
476 contents if its a directory. This is like the C<rm -rf> shell
479 =item $h->rmdir ($path);
481 Remove the single directory C<path>.
483 =item $h->set_autosync ($autosync);
485 If C<autosync> is true, this enables autosync. Libguestfs will make a
486 best effort attempt to run C<$h-E<gt>sync> when the handle is closed
487 (also if the program exits without closing handles).
489 =item $h->set_path ($path);
491 Set the path that libguestfs searches for kernel and initrd.img.
493 The default is C<$libdir/guestfs> unless overridden by setting
494 C<LIBGUESTFS_PATH> environment variable.
496 The string C<path> is stashed in the libguestfs handle, so the caller
497 must make sure it remains valid for the lifetime of the handle.
499 Setting C<path> to C<NULL> restores the default path.
501 =item $h->set_verbose ($verbose);
503 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
505 Verbose messages are disabled unless the environment variable
506 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
508 =item $h->sfdisk ($device, $cyls, $heads, $sectors, \@lines);
510 This is a direct interface to the L<sfdisk(8)> program for creating
511 partitions on block devices.
513 C<device> should be a block device, for example C</dev/sda>.
515 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
516 and sectors on the device, which are passed directly to sfdisk as
517 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
518 of these, then the corresponding parameter is omitted. Usually for
519 'large' disks, you can just pass C<0> for these, but for small
520 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
521 out the right geometry and you will need to tell it.
523 C<lines> is a list of lines that we feed to C<sfdisk>. For more
524 information refer to the L<sfdisk(8)> manpage.
526 To create a single partition occupying the whole disk, you would
527 pass C<lines> as a single element list, when the single element being
528 the string C<,> (comma).
530 B<This command is dangerous. Without careful use you
531 can easily destroy all your data>.
535 This syncs the disk, so that any writes are flushed through to the
536 underlying disk image.
538 You should always call this if you have modified a disk image, before
541 =item $h->touch ($path);
543 Touch acts like the L<touch(1)> command. It can be used to
544 update the timestamps on a file, or, if the file does not exist,
545 to create a new zero-length file.
547 =item $h->umount ($pathordevice);
549 This unmounts the given filesystem. The filesystem may be
550 specified either by its mountpoint (path) or the device which
551 contains the filesystem.
553 =item $h->umount_all ();
555 This unmounts all mounted filesystems.
557 Some internal mounts are not unmounted by this call.
559 =item $h->vgcreate ($volgroup, \@physvols);
561 This creates an LVM volume group called C<volgroup>
562 from the non-empty list of physical volumes C<physvols>.
564 =item @volgroups = $h->vgs ();
566 List all the volumes groups detected. This is the equivalent
567 of the L<vgs(8)> command.
569 This returns a list of just the volume group names that were
570 detected (eg. C<VolGroup00>).
572 See also C<$h-E<gt>vgs_full>.
574 =item @volgroups = $h->vgs_full ();
576 List all the volumes groups detected. This is the equivalent
577 of the L<vgs(8)> command. The "full" version includes all fields.
579 =item $h->wait_ready ();
581 Internally libguestfs is implemented by running a virtual machine
584 You should call this after C<$h-E<gt>launch> to wait for the launch
587 =item $h->write_file ($path, $content, $size);
589 This call creates a file called C<path>. The contents of the
590 file is the string C<content> (which can contain any 8 bit data),
593 As a special case, if C<size> is C<0>
594 then the length is calculated using C<strlen> (so in this case
595 the content cannot contain embedded ASCII NULs).
597 Because of the message protocol, there is a transfer limit
598 of somewhere between 2MB and 4MB. To transfer large files you should use
609 Copyright (C) 2009 Red Hat Inc.
613 Please see the file COPYING.LIB for the full license.
617 L<guestfs(3)>, L<guestfish(1)>.