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 1 C<AUG_SAVE_BACKUP>
169 Keep the original file with a C<.augsave> extension.
171 =item 2 C<AUG_SAVE_NEWFILE>
173 Save changes into a file with extension C<.augnew>, and
174 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
176 =item 4 C<AUG_TYPE_CHECK>
178 Typecheck lenses (can be expensive).
180 =item 8 C<AUG_NO_STDINC>
182 Do not use standard load path for modules.
184 =item 16 C<AUG_SAVE_NOOP>
186 Make save a no-op, just record what would have been changed.
188 =item 32 C<AUG_NO_LOAD>
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_match (path);
217 Returns a list of paths which match the path expression C<path>.
218 The returned paths are sufficiently qualified so that they match
219 exactly one node in the current tree.
221 =item $h->aug_mv (src, dest);
223 Move the node C<src> to C<dest>. C<src> must match exactly
224 one node. C<dest> is overwritten if it exists.
226 =item $nrnodes = $h->aug_rm (path);
228 Remove C<path> and all of its children.
230 On success this returns the number of entries which were removed.
232 =item $h->aug_save ();
234 This writes all pending changes to disk.
236 The flags which were passed to C<$h-E<gt>aug_init> affect exactly
239 =item $h->aug_set (path, val);
241 Set the value associated with C<path> to C<value>.
243 =item $content = $h->cat (path);
245 Return the contents of the file named C<path>.
247 Note that this function cannot correctly handle binary files
248 (specifically, files containing C<\0> character which is treated
249 as end of string). For those you need to use the C<$h-E<gt>read_file>
250 function which has a more complex interface.
252 Because of the message protocol, there is a transfer limit
253 of somewhere between 2MB and 4MB. To transfer large files you should use
256 =item $h->config (qemuparam, qemuvalue);
258 This can be used to add arbitrary qemu command line parameters
259 of the form C<-param value>. Actually it's not quite arbitrary - we
260 prevent you from setting some parameters which would interfere with
261 parameters that we use.
263 The first character of C<param> string must be a C<-> (dash).
265 C<value> can be NULL.
267 =item $autosync = $h->get_autosync ();
269 Get the autosync flag.
271 =item $path = $h->get_path ();
273 Return the current search path.
275 This is always non-NULL. If it wasn't set already, then this will
276 return the default path.
278 =item $verbose = $h->get_verbose ();
280 This returns the verbose messages flag.
282 =item $h->kill_subprocess ();
284 This kills the qemu subprocess. You should never need to call this.
288 Internally libguestfs is implemented by running a virtual machine
291 You should call this after configuring the handle
292 (eg. adding drives) but before performing any actions.
294 =item @devices = $h->list_devices ();
296 List all the block devices.
298 The full block device names are returned, eg. C</dev/sda>
300 =item @partitions = $h->list_partitions ();
302 List all the partitions detected on all block devices.
304 The full partition device names are returned, eg. C</dev/sda1>
306 This does not return logical volumes. For that you will need to
309 =item $listing = $h->ll (directory);
311 List the files in C<directory> (relative to the root directory,
312 there is no cwd) in the format of 'ls -la'.
314 This command is mostly useful for interactive sessions. It
315 is I<not> intended that you try to parse the output string.
317 =item @listing = $h->ls (directory);
319 List the files in C<directory> (relative to the root directory,
320 there is no cwd). The '.' and '..' entries are not returned, but
321 hidden files are shown.
323 This command is mostly useful for interactive sessions. Programs
324 should probably use C<$h-E<gt>readdir> instead.
326 =item @logvols = $h->lvs ();
328 List all the logical volumes detected. This is the equivalent
329 of the L<lvs(8)> command.
331 This returns a list of the logical volume device names
332 (eg. C</dev/VolGroup00/LogVol00>).
334 See also C<$h-E<gt>lvs_full>.
336 =item @logvols = $h->lvs_full ();
338 List all the logical volumes detected. This is the equivalent
339 of the L<lvs(8)> command. The "full" version includes all fields.
341 =item $h->mount (device, mountpoint);
343 Mount a guest disk at a position in the filesystem. Block devices
344 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
345 the guest. If those block devices contain partitions, they will have
346 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
349 The rules are the same as for L<mount(2)>: A filesystem must
350 first be mounted on C</> before others can be mounted. Other
351 filesystems can only be mounted on directories which already
354 The mounted filesystem is writable, if we have sufficient permissions
355 on the underlying device.
357 The filesystem options C<sync> and C<noatime> are set with this
358 call, in order to improve reliability.
360 =item @physvols = $h->pvs ();
362 List all the physical volumes detected. This is the equivalent
363 of the L<pvs(8)> command.
365 This returns a list of just the device names that contain
366 PVs (eg. C</dev/sda2>).
368 See also C<$h-E<gt>pvs_full>.
370 =item @physvols = $h->pvs_full ();
372 List all the physical volumes detected. This is the equivalent
373 of the L<pvs(8)> command. The "full" version includes all fields.
375 =item @lines = $h->read_lines (path);
377 Return the contents of the file named C<path>.
379 The file contents are returned as a list of lines. Trailing
380 C<LF> and C<CRLF> character sequences are I<not> returned.
382 Note that this function cannot correctly handle binary files
383 (specifically, files containing C<\0> character which is treated
384 as end of line). For those you need to use the C<$h-E<gt>read_file>
385 function which has a more complex interface.
387 =item $h->set_autosync (autosync);
389 If C<autosync> is true, this enables autosync. Libguestfs will make a
390 best effort attempt to run C<$h-E<gt>sync> when the handle is closed
391 (also if the program exits without closing handles).
393 =item $h->set_path (path);
395 Set the path that libguestfs searches for kernel and initrd.img.
397 The default is C<$libdir/guestfs> unless overridden by setting
398 C<LIBGUESTFS_PATH> environment variable.
400 The string C<path> is stashed in the libguestfs handle, so the caller
401 must make sure it remains valid for the lifetime of the handle.
403 Setting C<path> to C<NULL> restores the default path.
405 =item $h->set_verbose (verbose);
407 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
409 Verbose messages are disabled unless the environment variable
410 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
414 This syncs the disk, so that any writes are flushed through to the
415 underlying disk image.
417 You should always call this if you have modified a disk image, before
420 =item $h->touch (path);
422 Touch acts like the L<touch(1)> command. It can be used to
423 update the timestamps on a file, or, if the file does not exist,
424 to create a new zero-length file.
426 =item @volgroups = $h->vgs ();
428 List all the volumes groups detected. This is the equivalent
429 of the L<vgs(8)> command.
431 This returns a list of just the volume group names that were
432 detected (eg. C<VolGroup00>).
434 See also C<$h-E<gt>vgs_full>.
436 =item @volgroups = $h->vgs_full ();
438 List all the volumes groups detected. This is the equivalent
439 of the L<vgs(8)> command. The "full" version includes all fields.
441 =item $h->wait_ready ();
443 Internally libguestfs is implemented by running a virtual machine
446 You should call this after C<$h-E<gt>launch> to wait for the launch
457 Copyright (C) 2009 Red Hat Inc.
461 Please see the file COPYING.LIB for the full license.
465 L<guestfs(3)>, L<guestfish(1)>.