116f7163a58a9b310ad69728cc668f495fba46bb
[libguestfs.git] / perl / lib / Sys / Guestfs.pm
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.
4 #
5 # Copyright (C) 2009 Red Hat Inc.
6 #
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.
11 #
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.
16 #
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
20
21 =pod
22
23 =head1 NAME
24
25 Sys::Guestfs - Perl bindings for libguestfs
26
27 =head1 SYNOPSIS
28
29  use Sys::Guestfs;
30  
31  my $h = Sys::Guestfs->new ();
32  $h->add_drive ('guest.img');
33  $h->launch ();
34  $h->wait_ready ();
35  $h->mount ('/dev/sda1', '/');
36  $h->touch ('/hello');
37  $h->sync ();
38
39 =head1 DESCRIPTION
40
41 The C<Sys::Guestfs> module provides a Perl XS binding to the
42 libguestfs API for examining and modifying virtual machine
43 disk images.
44
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
50 much else besides.
51
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.
56
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.
60
61 =head1 ERRORS
62
63 All errors turn into calls to C<croak> (see L<Carp(3)>).
64
65 =head1 METHODS
66
67 =over 4
68
69 =cut
70
71 package Sys::Guestfs;
72
73 use strict;
74 use warnings;
75
76 require XSLoader;
77 XSLoader::load ('Sys::Guestfs');
78
79 =item $h = Sys::Guestfs->new ();
80
81 Create a new guestfs handle.
82
83 =cut
84
85 sub new {
86   my $proto = shift;
87   my $class = ref ($proto) || $proto;
88
89   my $self = Sys::Guestfs::_create ();
90   bless $self, $class;
91   return $self;
92 }
93
94 =item $h->add_cdrom ($filename);
95
96 This function adds a virtual CD-ROM disk image to the guest.
97
98 This is equivalent to the qemu parameter C<-cdrom filename>.
99
100 =item $h->add_drive ($filename);
101
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
105 so on.
106
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
111 image).
112
113 This is equivalent to the qemu parameter C<-drive file=filename>.
114
115 =item $h->aug_close ();
116
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
120 Augeas functions.
121
122 =item ($nrnodes, $created) = $h->aug_defnode ($name, $expr, $val);
123
124 Defines a variable C<name> whose value is the result of
125 evaluating C<expr>.
126
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.
130
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.
134
135 =item $nrnodes = $h->aug_defvar ($name, $expr);
136
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
139 undefined.
140
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.
143
144 =item $val = $h->aug_get ($path);
145
146 Look up the value associated with C<path>.  If C<path>
147 matches exactly one node, the C<value> is returned.
148
149 =item $h->aug_init ($root, $flags);
150
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.
154
155 You must call this before using any other C<$h-E<gt>aug_*>
156 commands.
157
158 C<root> is the filesystem root.  C<root> must not be NULL,
159 use C</> instead.
160
161 The flags are the same as the flags defined in
162 E<lt>augeas.hE<gt>, the logical I<or> of the following
163 integers:
164
165 =over 4
166
167 =item C<AUG_SAVE_BACKUP> = 1
168
169 Keep the original file with a C<.augsave> extension.
170
171 =item C<AUG_SAVE_NEWFILE> = 2
172
173 Save changes into a file with extension C<.augnew>, and
174 do not overwrite original.  Overrides C<AUG_SAVE_BACKUP>.
175
176 =item C<AUG_TYPE_CHECK> = 4
177
178 Typecheck lenses (can be expensive).
179
180 =item C<AUG_NO_STDINC> = 8
181
182 Do not use standard load path for modules.
183
184 =item C<AUG_SAVE_NOOP> = 16
185
186 Make save a no-op, just record what would have been changed.
187
188 =item C<AUG_NO_LOAD> = 32
189
190 Do not load the tree in C<$h-E<gt>aug_init>.
191
192 =back
193
194 To close the handle, you can call C<$h-E<gt>aug_close>.
195
196 To find out more about Augeas, see L<http://augeas.net/>.
197
198 =item $h->aug_insert ($path, $label, $before);
199
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
202 flag C<before>).
203
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]>.
207
208 =item $h->aug_load ();
209
210 Load files into the tree.
211
212 See C<aug_load> in the Augeas documentation for the full gory
213 details.
214
215 =item @matches = $h->aug_ls ($path);
216
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.
219
220 =item @matches = $h->aug_match ($path);
221
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.
225
226 =item $h->aug_mv ($src, $dest);
227
228 Move the node C<src> to C<dest>.  C<src> must match exactly
229 one node.  C<dest> is overwritten if it exists.
230
231 =item $nrnodes = $h->aug_rm ($path);
232
233 Remove C<path> and all of its children.
234
235 On success this returns the number of entries which were removed.
236
237 =item $h->aug_save ();
238
239 This writes all pending changes to disk.
240
241 The flags which were passed to C<$h-E<gt>aug_init> affect exactly
242 how files are saved.
243
244 =item $h->aug_set ($path, $val);
245
246 Set the value associated with C<path> to C<value>.
247
248 =item $h->blockdev_flushbufs ($device);
249
250 This tells the kernel to flush internal buffers associated
251 with C<device>.
252
253 This uses the L<blockdev(8)> command.
254
255 =item $blocksize = $h->blockdev_getbsz ($device);
256
257 This returns the block size of a device.
258
259 (Note this is different from both I<size in blocks> and
260 I<filesystem block size>).
261
262 This uses the L<blockdev(8)> command.
263
264 =item $ro = $h->blockdev_getro ($device);
265
266 Returns a boolean indicating if the block device is read-only
267 (true if read-only, false if not).
268
269 This uses the L<blockdev(8)> command.
270
271 =item $sizeinbytes = $h->blockdev_getsize64 ($device);
272
273 This returns the size of the device in bytes.
274
275 See also C<$h-E<gt>blockdev_getsz>.
276
277 This uses the L<blockdev(8)> command.
278
279 =item $sectorsize = $h->blockdev_getss ($device);
280
281 This returns the size of sectors on a block device.
282 Usually 512, but can be larger for modern devices.
283
284 (Note, this is not the size in sectors, use C<$h-E<gt>blockdev_getsz>
285 for that).
286
287 This uses the L<blockdev(8)> command.
288
289 =item $sizeinsectors = $h->blockdev_getsz ($device);
290
291 This returns the size of the device in units of 512-byte sectors
292 (even if the sectorsize isn't 512 bytes ... weird).
293
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>.
297
298 This uses the L<blockdev(8)> command.
299
300 =item $h->blockdev_rereadpt ($device);
301
302 Reread the partition table on C<device>.
303
304 This uses the L<blockdev(8)> command.
305
306 =item $h->blockdev_setbsz ($device, $blocksize);
307
308 This sets the block size of a device.
309
310 (Note this is different from both I<size in blocks> and
311 I<filesystem block size>).
312
313 This uses the L<blockdev(8)> command.
314
315 =item $h->blockdev_setro ($device);
316
317 Sets the block device named C<device> to read-only.
318
319 This uses the L<blockdev(8)> command.
320
321 =item $h->blockdev_setrw ($device);
322
323 Sets the block device named C<device> to read-write.
324
325 This uses the L<blockdev(8)> command.
326
327 =item $content = $h->cat ($path);
328
329 Return the contents of the file named C<path>.
330
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.
335
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
338 FTP.
339
340 =item $checksum = $h->checksum ($csumtype, $path);
341
342 This call computes the MD5, SHAx or CRC checksum of the
343 file named C<path>.
344
345 The type of checksum to compute is given by the C<csumtype>
346 parameter which must have one of the following values:
347
348 =over 4
349
350 =item C<crc>
351
352 Compute the cyclic redundancy check (CRC) specified by POSIX
353 for the C<cksum> command.
354
355 =item C<md5>
356
357 Compute the MD5 hash (using the C<md5sum> program).
358
359 =item C<sha1>
360
361 Compute the SHA1 hash (using the C<sha1sum> program).
362
363 =item C<sha224>
364
365 Compute the SHA224 hash (using the C<sha224sum> program).
366
367 =item C<sha256>
368
369 Compute the SHA256 hash (using the C<sha256sum> program).
370
371 =item C<sha384>
372
373 Compute the SHA384 hash (using the C<sha384sum> program).
374
375 =item C<sha512>
376
377 Compute the SHA512 hash (using the C<sha512sum> program).
378
379 =back
380
381 The checksum is returned as a printable string.
382
383 =item $h->chmod ($mode, $path);
384
385 Change the mode (permissions) of C<path> to C<mode>.  Only
386 numeric modes are supported.
387
388 =item $h->chown ($owner, $group, $path);
389
390 Change the file owner to C<owner> and group to C<group>.
391
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).
395
396 =item $output = $h->command (\@arguments);
397
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).
402
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).
407
408 The C<$PATH> environment variable will contain at least
409 C</usr/bin> and C</bin>.  If you require a program from
410 another location, you should provide the full path in the
411 first parameter.
412
413 Shared libraries and data files required by the program
414 must be available on filesystems which are mounted in the
415 correct places.  It is the caller's responsibility to ensure
416 all filesystems that are needed are mounted at the right
417 locations.
418
419 =item @lines = $h->command_lines (\@arguments);
420
421 This is the same as C<$h-E<gt>command>, but splits the
422 result into a list of lines.
423
424 =item $h->config ($qemuparam, $qemuvalue);
425
426 This can be used to add arbitrary qemu command line parameters
427 of the form C<-param value>.  Actually it's not quite arbitrary - we
428 prevent you from setting some parameters which would interfere with
429 parameters that we use.
430
431 The first character of C<param> string must be a C<-> (dash).
432
433 C<value> can be NULL.
434
435 =item $h->cp ($src, $dest);
436
437 This copies a file from C<src> to C<dest> where C<dest> is
438 either a destination filename or destination directory.
439
440 =item $h->cp_a ($src, $dest);
441
442 This copies a file or directory from C<src> to C<dest>
443 recursively using the C<cp -a> command.
444
445 =item $result = $h->debug ($subcmd, \@extraargs);
446
447 The C<$h-E<gt>debug> command exposes some internals of
448 C<guestfsd> (the guestfs daemon) that runs inside the
449 qemu subprocess.
450
451 There is no comprehensive help for this command.  You have
452 to look at the file C<daemon/debug.c> in the libguestfs source
453 to find out what you can do.
454
455 =item $kmsgs = $h->dmesg ();
456
457 This returns the kernel messages (C<dmesg> output) from
458 the guest kernel.  This is sometimes useful for extended
459 debugging of problems.
460
461 Another way to get the same information is to enable
462 verbose messages with C<$h-E<gt>set_verbose> or by setting
463 the environment variable C<LIBGUESTFS_DEBUG=1> before
464 running the program.
465
466 =item $h->download ($remotefilename, $filename);
467
468 Download file C<remotefilename> and save it as C<filename>
469 on the local machine.
470
471 C<filename> can also be a named pipe.
472
473 See also C<$h-E<gt>upload>, C<$h-E<gt>cat>.
474
475 =item $h->drop_caches ($whattodrop);
476
477 This instructs the guest kernel to drop its page cache,
478 and/or dentries and inode caches.  The parameter C<whattodrop>
479 tells the kernel what precisely to drop, see
480 L<http://linux-mm.org/Drop_Caches>
481
482 Setting C<whattodrop> to 3 should drop everything.
483
484 This automatically calls L<sync(2)> before the operation,
485 so that the maximum guest memory is freed.
486
487 =item $equality = $h->equal ($file1, $file2);
488
489 This compares the two files C<file1> and C<file2> and returns
490 true if their content is exactly equal, or false otherwise.
491
492 The external L<cmp(1)> program is used for the comparison.
493
494 =item $existsflag = $h->exists ($path);
495
496 This returns C<true> if and only if there is a file, directory
497 (or anything) with the given C<path> name.
498
499 See also C<$h-E<gt>is_file>, C<$h-E<gt>is_dir>, C<$h-E<gt>stat>.
500
501 =item $description = $h->file ($path);
502
503 This call uses the standard L<file(1)> command to determine
504 the type or contents of the file.  This also works on devices,
505 for example to find out whether a partition contains a filesystem.
506
507 The exact command which runs is C<file -bsL path>.  Note in
508 particular that the filename is not prepended to the output
509 (the C<-b> option).
510
511 =item $status = $h->fsck ($fstype, $device);
512
513 This runs the filesystem checker (fsck) on C<device> which
514 should have filesystem type C<fstype>.
515
516 The returned integer is the status.  See L<fsck(8)> for the
517 list of status codes from C<fsck>.
518
519 Notes:
520
521 =over 4
522
523 =item *
524
525 Multiple status codes can be summed together.
526
527 =item *
528
529 A non-zero return code can mean "success", for example if
530 errors have been corrected on the filesystem.
531
532 =item *
533
534 Checking or repairing NTFS volumes is not supported
535 (by linux-ntfs).
536
537 =back
538
539 This command is entirely equivalent to running C<fsck -a -t fstype device>.
540
541 =item $autosync = $h->get_autosync ();
542
543 Get the autosync flag.
544
545 =item $label = $h->get_e2label ($device);
546
547 This returns the ext2/3/4 filesystem label of the filesystem on
548 C<device>.
549
550 =item $uuid = $h->get_e2uuid ($device);
551
552 This returns the ext2/3/4 filesystem UUID of the filesystem on
553 C<device>.
554
555 =item $path = $h->get_path ();
556
557 Return the current search path.
558
559 This is always non-NULL.  If it wasn't set already, then this will
560 return the default path.
561
562 =item $qemu = $h->get_qemu ();
563
564 Return the current qemu binary.
565
566 This is always non-NULL.  If it wasn't set already, then this will
567 return the default qemu binary name.
568
569 =item $state = $h->get_state ();
570
571 This returns the current state as an opaque integer.  This is
572 only useful for printing debug and internal error messages.
573
574 For more information on states, see L<guestfs(3)>.
575
576 =item $verbose = $h->get_verbose ();
577
578 This returns the verbose messages flag.
579
580 =item $h->grub_install ($root, $device);
581
582 This command installs GRUB (the Grand Unified Bootloader) on
583 C<device>, with the root directory being C<root>.
584
585 =item $busy = $h->is_busy ();
586
587 This returns true iff this handle is busy processing a command
588 (in the C<BUSY> state).
589
590 For more information on states, see L<guestfs(3)>.
591
592 =item $config = $h->is_config ();
593
594 This returns true iff this handle is being configured
595 (in the C<CONFIG> state).
596
597 For more information on states, see L<guestfs(3)>.
598
599 =item $dirflag = $h->is_dir ($path);
600
601 This returns C<true> if and only if there is a directory
602 with the given C<path> name.  Note that it returns false for
603 other objects like files.
604
605 See also C<$h-E<gt>stat>.
606
607 =item $fileflag = $h->is_file ($path);
608
609 This returns C<true> if and only if there is a file
610 with the given C<path> name.  Note that it returns false for
611 other objects like directories.
612
613 See also C<$h-E<gt>stat>.
614
615 =item $launching = $h->is_launching ();
616
617 This returns true iff this handle is launching the subprocess
618 (in the C<LAUNCHING> state).
619
620 For more information on states, see L<guestfs(3)>.
621
622 =item $ready = $h->is_ready ();
623
624 This returns true iff this handle is ready to accept commands
625 (in the C<READY> state).
626
627 For more information on states, see L<guestfs(3)>.
628
629 =item $h->kill_subprocess ();
630
631 This kills the qemu subprocess.  You should never need to call this.
632
633 =item $h->launch ();
634
635 Internally libguestfs is implemented by running a virtual machine
636 using L<qemu(1)>.
637
638 You should call this after configuring the handle
639 (eg. adding drives) but before performing any actions.
640
641 =item @devices = $h->list_devices ();
642
643 List all the block devices.
644
645 The full block device names are returned, eg. C</dev/sda>
646
647 =item @partitions = $h->list_partitions ();
648
649 List all the partitions detected on all block devices.
650
651 The full partition device names are returned, eg. C</dev/sda1>
652
653 This does not return logical volumes.  For that you will need to
654 call C<$h-E<gt>lvs>.
655
656 =item $listing = $h->ll ($directory);
657
658 List the files in C<directory> (relative to the root directory,
659 there is no cwd) in the format of 'ls -la'.
660
661 This command is mostly useful for interactive sessions.  It
662 is I<not> intended that you try to parse the output string.
663
664 =item @listing = $h->ls ($directory);
665
666 List the files in C<directory> (relative to the root directory,
667 there is no cwd).  The '.' and '..' entries are not returned, but
668 hidden files are shown.
669
670 This command is mostly useful for interactive sessions.  Programs
671 should probably use C<$h-E<gt>readdir> instead.
672
673 =item %statbuf = $h->lstat ($path);
674
675 Returns file information for the given C<path>.
676
677 This is the same as C<$h-E<gt>stat> except that if C<path>
678 is a symbolic link, then the link is stat-ed, not the file it
679 refers to.
680
681 This is the same as the C<lstat(2)> system call.
682
683 =item $h->lvcreate ($logvol, $volgroup, $mbytes);
684
685 This creates an LVM volume group called C<logvol>
686 on the volume group C<volgroup>, with C<size> megabytes.
687
688 =item $h->lvm_remove_all ();
689
690 This command removes all LVM logical volumes, volume groups
691 and physical volumes.
692
693 B<This command is dangerous.  Without careful use you
694 can easily destroy all your data>.
695
696 =item $h->lvremove ($device);
697
698 Remove an LVM logical volume C<device>, where C<device> is
699 the path to the LV, such as C</dev/VG/LV>.
700
701 You can also remove all LVs in a volume group by specifying
702 the VG name, C</dev/VG>.
703
704 =item @logvols = $h->lvs ();
705
706 List all the logical volumes detected.  This is the equivalent
707 of the L<lvs(8)> command.
708
709 This returns a list of the logical volume device names
710 (eg. C</dev/VolGroup00/LogVol00>).
711
712 See also C<$h-E<gt>lvs_full>.
713
714 =item @logvols = $h->lvs_full ();
715
716 List all the logical volumes detected.  This is the equivalent
717 of the L<lvs(8)> command.  The "full" version includes all fields.
718
719 =item $h->mkdir ($path);
720
721 Create a directory named C<path>.
722
723 =item $h->mkdir_p ($path);
724
725 Create a directory named C<path>, creating any parent directories
726 as necessary.  This is like the C<mkdir -p> shell command.
727
728 =item $h->mkfs ($fstype, $device);
729
730 This creates a filesystem on C<device> (usually a partition
731 or LVM logical volume).  The filesystem type is C<fstype>, for
732 example C<ext3>.
733
734 =item $h->mount ($device, $mountpoint);
735
736 Mount a guest disk at a position in the filesystem.  Block devices
737 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
738 the guest.  If those block devices contain partitions, they will have
739 the usual names (eg. C</dev/sda1>).  Also LVM C</dev/VG/LV>-style
740 names can be used.
741
742 The rules are the same as for L<mount(2)>:  A filesystem must
743 first be mounted on C</> before others can be mounted.  Other
744 filesystems can only be mounted on directories which already
745 exist.
746
747 The mounted filesystem is writable, if we have sufficient permissions
748 on the underlying device.
749
750 The filesystem options C<sync> and C<noatime> are set with this
751 call, in order to improve reliability.
752
753 =item $h->mount_options ($options, $device, $mountpoint);
754
755 This is the same as the C<$h-E<gt>mount> command, but it
756 allows you to set the mount options as for the
757 L<mount(8)> I<-o> flag.
758
759 =item $h->mount_ro ($device, $mountpoint);
760
761 This is the same as the C<$h-E<gt>mount> command, but it
762 mounts the filesystem with the read-only (I<-o ro>) flag.
763
764 =item $h->mount_vfs ($options, $vfstype, $device, $mountpoint);
765
766 This is the same as the C<$h-E<gt>mount> command, but it
767 allows you to set both the mount options and the vfstype
768 as for the L<mount(8)> I<-o> and I<-t> flags.
769
770 =item @devices = $h->mounts ();
771
772 This returns the list of currently mounted filesystems.  It returns
773 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
774
775 Some internal mounts are not shown.
776
777 =item $h->mv ($src, $dest);
778
779 This moves a file from C<src> to C<dest> where C<dest> is
780 either a destination filename or destination directory.
781
782 =item $h->ping_daemon ();
783
784 This is a test probe into the guestfs daemon running inside
785 the qemu subprocess.  Calling this function checks that the
786 daemon responds to the ping message, without affecting the daemon
787 or attached block device(s) in any other way.
788
789 =item $h->pvcreate ($device);
790
791 This creates an LVM physical volume on the named C<device>,
792 where C<device> should usually be a partition name such
793 as C</dev/sda1>.
794
795 =item $h->pvremove ($device);
796
797 This wipes a physical volume C<device> so that LVM will no longer
798 recognise it.
799
800 The implementation uses the C<pvremove> command which refuses to
801 wipe physical volumes that contain any volume groups, so you have
802 to remove those first.
803
804 =item @physvols = $h->pvs ();
805
806 List all the physical volumes detected.  This is the equivalent
807 of the L<pvs(8)> command.
808
809 This returns a list of just the device names that contain
810 PVs (eg. C</dev/sda2>).
811
812 See also C<$h-E<gt>pvs_full>.
813
814 =item @physvols = $h->pvs_full ();
815
816 List all the physical volumes detected.  This is the equivalent
817 of the L<pvs(8)> command.  The "full" version includes all fields.
818
819 =item @lines = $h->read_lines ($path);
820
821 Return the contents of the file named C<path>.
822
823 The file contents are returned as a list of lines.  Trailing
824 C<LF> and C<CRLF> character sequences are I<not> returned.
825
826 Note that this function cannot correctly handle binary files
827 (specifically, files containing C<\0> character which is treated
828 as end of line).  For those you need to use the C<$h-E<gt>read_file>
829 function which has a more complex interface.
830
831 =item $h->rm ($path);
832
833 Remove the single file C<path>.
834
835 =item $h->rm_rf ($path);
836
837 Remove the file or directory C<path>, recursively removing the
838 contents if its a directory.  This is like the C<rm -rf> shell
839 command.
840
841 =item $h->rmdir ($path);
842
843 Remove the single directory C<path>.
844
845 =item $h->set_autosync ($autosync);
846
847 If C<autosync> is true, this enables autosync.  Libguestfs will make a
848 best effort attempt to run C<$h-E<gt>umount_all> followed by
849 C<$h-E<gt>sync> when the handle is closed
850 (also if the program exits without closing handles).
851
852 This is disabled by default (except in guestfish where it is
853 enabled by default).
854
855 =item $h->set_busy ();
856
857 This sets the state to C<BUSY>.  This is only used when implementing
858 actions using the low-level API.
859
860 For more information on states, see L<guestfs(3)>.
861
862 =item $h->set_e2label ($device, $label);
863
864 This sets the ext2/3/4 filesystem label of the filesystem on
865 C<device> to C<label>.  Filesystem labels are limited to
866 16 characters.
867
868 You can use either C<$h-E<gt>tune2fs_l> or C<$h-E<gt>get_e2label>
869 to return the existing label on a filesystem.
870
871 =item $h->set_e2uuid ($device, $uuid);
872
873 This sets the ext2/3/4 filesystem UUID of the filesystem on
874 C<device> to C<uuid>.  The format of the UUID and alternatives
875 such as C<clear>, C<random> and C<time> are described in the
876 L<tune2fs(8)> manpage.
877
878 You can use either C<$h-E<gt>tune2fs_l> or C<$h-E<gt>get_e2uuid>
879 to return the existing UUID of a filesystem.
880
881 =item $h->set_path ($path);
882
883 Set the path that libguestfs searches for kernel and initrd.img.
884
885 The default is C<$libdir/guestfs> unless overridden by setting
886 C<LIBGUESTFS_PATH> environment variable.
887
888 The string C<path> is stashed in the libguestfs handle, so the caller
889 must make sure it remains valid for the lifetime of the handle.
890
891 Setting C<path> to C<NULL> restores the default path.
892
893 =item $h->set_qemu ($qemu);
894
895 Set the qemu binary that we will use.
896
897 The default is chosen when the library was compiled by the
898 configure script.
899
900 You can also override this by setting the C<LIBGUESTFS_QEMU>
901 environment variable.
902
903 The string C<qemu> is stashed in the libguestfs handle, so the caller
904 must make sure it remains valid for the lifetime of the handle.
905
906 Setting C<qemu> to C<NULL> restores the default qemu binary.
907
908 =item $h->set_ready ();
909
910 This sets the state to C<READY>.  This is only used when implementing
911 actions using the low-level API.
912
913 For more information on states, see L<guestfs(3)>.
914
915 =item $h->set_verbose ($verbose);
916
917 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
918
919 Verbose messages are disabled unless the environment variable
920 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.
921
922 =item $h->sfdisk ($device, $cyls, $heads, $sectors, \@lines);
923
924 This is a direct interface to the L<sfdisk(8)> program for creating
925 partitions on block devices.
926
927 C<device> should be a block device, for example C</dev/sda>.
928
929 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
930 and sectors on the device, which are passed directly to sfdisk as
931 the I<-C>, I<-H> and I<-S> parameters.  If you pass C<0> for any
932 of these, then the corresponding parameter is omitted.  Usually for
933 'large' disks, you can just pass C<0> for these, but for small
934 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
935 out the right geometry and you will need to tell it.
936
937 C<lines> is a list of lines that we feed to C<sfdisk>.  For more
938 information refer to the L<sfdisk(8)> manpage.
939
940 To create a single partition occupying the whole disk, you would
941 pass C<lines> as a single element list, when the single element being
942 the string C<,> (comma).
943
944 B<This command is dangerous.  Without careful use you
945 can easily destroy all your data>.
946
947 =item %statbuf = $h->stat ($path);
948
949 Returns file information for the given C<path>.
950
951 This is the same as the C<stat(2)> system call.
952
953 =item %statbuf = $h->statvfs ($path);
954
955 Returns file system statistics for any mounted file system.
956 C<path> should be a file or directory in the mounted file system
957 (typically it is the mount point itself, but it doesn't need to be).
958
959 This is the same as the C<statvfs(2)> system call.
960
961 =item $h->sync ();
962
963 This syncs the disk, so that any writes are flushed through to the
964 underlying disk image.
965
966 You should always call this if you have modified a disk image, before
967 closing the handle.
968
969 =item $h->tar_in ($tarfile, $directory);
970
971 This command uploads and unpacks local file C<tarfile> (an
972 I<uncompressed> tar file) into C<directory>.
973
974 To upload a compressed tarball, use C<$h-E<gt>tgz_in>.
975
976 =item $h->tar_out ($directory, $tarfile);
977
978 This command packs the contents of C<directory> and downloads
979 it to local file C<tarfile>.
980
981 To download a compressed tarball, use C<$h-E<gt>tgz_out>.
982
983 =item $h->tgz_in ($tarball, $directory);
984
985 This command uploads and unpacks local file C<tarball> (a
986 I<gzip compressed> tar file) into C<directory>.
987
988 To upload an uncompressed tarball, use C<$h-E<gt>tar_in>.
989
990 =item $h->tgz_out ($directory, $tarball);
991
992 This command packs the contents of C<directory> and downloads
993 it to local file C<tarball>.
994
995 To download an uncompressed tarball, use C<$h-E<gt>tar_out>.
996
997 =item $h->touch ($path);
998
999 Touch acts like the L<touch(1)> command.  It can be used to
1000 update the timestamps on a file, or, if the file does not exist,
1001 to create a new zero-length file.
1002
1003 =item %superblock = $h->tune2fs_l ($device);
1004
1005 This returns the contents of the ext2, ext3 or ext4 filesystem
1006 superblock on C<device>.
1007
1008 It is the same as running C<tune2fs -l device>.  See L<tune2fs(8)>
1009 manpage for more details.  The list of fields returned isn't
1010 clearly defined, and depends on both the version of C<tune2fs>
1011 that libguestfs was built against, and the filesystem itself.
1012
1013 =item $h->umount ($pathordevice);
1014
1015 This unmounts the given filesystem.  The filesystem may be
1016 specified either by its mountpoint (path) or the device which
1017 contains the filesystem.
1018
1019 =item $h->umount_all ();
1020
1021 This unmounts all mounted filesystems.
1022
1023 Some internal mounts are not unmounted by this call.
1024
1025 =item $h->upload ($filename, $remotefilename);
1026
1027 Upload local file C<filename> to C<remotefilename> on the
1028 filesystem.
1029
1030 C<filename> can also be a named pipe.
1031
1032 See also C<$h-E<gt>download>.
1033
1034 =item $h->vgcreate ($volgroup, \@physvols);
1035
1036 This creates an LVM volume group called C<volgroup>
1037 from the non-empty list of physical volumes C<physvols>.
1038
1039 =item $h->vgremove ($vgname);
1040
1041 Remove an LVM volume group C<vgname>, (for example C<VG>).
1042
1043 This also forcibly removes all logical volumes in the volume
1044 group (if any).
1045
1046 =item @volgroups = $h->vgs ();
1047
1048 List all the volumes groups detected.  This is the equivalent
1049 of the L<vgs(8)> command.
1050
1051 This returns a list of just the volume group names that were
1052 detected (eg. C<VolGroup00>).
1053
1054 See also C<$h-E<gt>vgs_full>.
1055
1056 =item @volgroups = $h->vgs_full ();
1057
1058 List all the volumes groups detected.  This is the equivalent
1059 of the L<vgs(8)> command.  The "full" version includes all fields.
1060
1061 =item $h->wait_ready ();
1062
1063 Internally libguestfs is implemented by running a virtual machine
1064 using L<qemu(1)>.
1065
1066 You should call this after C<$h-E<gt>launch> to wait for the launch
1067 to complete.
1068
1069 =item $h->write_file ($path, $content, $size);
1070
1071 This call creates a file called C<path>.  The contents of the
1072 file is the string C<content> (which can contain any 8 bit data),
1073 with length C<size>.
1074
1075 As a special case, if C<size> is C<0>
1076 then the length is calculated using C<strlen> (so in this case
1077 the content cannot contain embedded ASCII NULs).
1078
1079 Because of the message protocol, there is a transfer limit 
1080 of somewhere between 2MB and 4MB.  To transfer large files you should use
1081 FTP.
1082
1083 =item $h->zero ($device);
1084
1085 This command writes zeroes over the first few blocks of C<device>.
1086
1087 How many blocks are zeroed isn't specified (but it's I<not> enough
1088 to securely wipe the device).  It should be sufficient to remove
1089 any partition tables, filesystem superblocks and so on.
1090
1091 =cut
1092
1093 1;
1094
1095 =back
1096
1097 =head1 COPYRIGHT
1098
1099 Copyright (C) 2009 Red Hat Inc.
1100
1101 =head1 LICENSE
1102
1103 Please see the file COPYING.LIB for the full license.
1104
1105 =head1 SEE ALSO
1106
1107 L<guestfs(3)>, L<guestfish(1)>.
1108
1109 =cut