X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=perl%2Flib%2FSys%2FGuestfs.pm;h=05adfcb470117b8f480889fdb746b8fe33b86b6b;hp=ea82659256c01f5e1bba0cde3ef36afe9c1c9918;hb=460d139e6a52da67a4f1947035b1978610349f78;hpb=79cdf81e2fb717ea4372a55170d16800cdbddf23 diff --git a/perl/lib/Sys/Guestfs.pm b/perl/lib/Sys/Guestfs.pm index ea82659..05adfcb 100644 --- a/perl/lib/Sys/Guestfs.pm +++ b/perl/lib/Sys/Guestfs.pm @@ -97,6 +97,11 @@ This function adds a virtual CD-ROM disk image to the guest. This is equivalent to the qemu parameter C<-cdrom filename>. +Note that this call checks for the existence of C. This +stops you from specifying other types of drive which are supported +by qemu such as C and C URLs. To specify those, use +the general C<$h-Econfig> call instead. + =item $h->add_drive ($filename); This function adds a virtual machine disk image C to the @@ -112,6 +117,30 @@ image). This is equivalent to the qemu parameter C<-drive file=filename>. +Note that this call checks for the existence of C. This +stops you from specifying other types of drive which are supported +by qemu such as C and C URLs. To specify those, use +the general C<$h-Econfig> call instead. + +=item $h->add_drive_ro ($filename); + +This adds a drive in snapshot mode, making it effectively +read-only. + +Note that writes to the device are allowed, and will be seen for +the duration of the guestfs handle, but they are written +to a temporary file which is discarded as soon as the guestfs +handle is closed. We don't currently have any method to enable +changes to be committed, although qemu can support this. + +This is equivalent to the qemu parameter +C<-drive file=filename,snapshot=on>. + +Note that this call checks for the existence of C. This +stops you from specifying other types of drive which are supported +by qemu such as C and C URLs. To specify those, use +the general C<$h-Econfig> call instead. + =item $h->aug_close (); Close the current Augeas handle and free up any resources @@ -405,6 +434,13 @@ The first element is the name of the program to run. Subsequent elements are parameters. The list must be non-empty (ie. must contain a program name). +The return value is anything printed to I by +the command. + +If the command returns a non-zero exit status, then +this function returns an error message. The error message +string is the content of I from the command. + The C<$PATH> environment variable will contain at least C and C. If you require a program from another location, you should provide the full path in the @@ -416,11 +452,19 @@ correct places. It is the caller's responsibility to ensure all filesystems that are needed are mounted at the right locations. +Because of the message protocol, there is a transfer limit +of somewhere between 2MB and 4MB. To transfer large files you should use +FTP. + =item @lines = $h->command_lines (\@arguments); This is the same as C<$h-Ecommand>, but splits the result into a list of lines. +Because of the message protocol, there is a transfer limit +of somewhere between 2MB and 4MB. To transfer large files you should use +FTP. + =item $h->config ($qemuparam, $qemuvalue); This can be used to add arbitrary qemu command line parameters @@ -432,6 +476,37 @@ The first character of C string must be a C<-> (dash). C can be NULL. +=item $h->cp ($src, $dest); + +This copies a file from C to C where C is +either a destination filename or destination directory. + +=item $h->cp_a ($src, $dest); + +This copies a file or directory from C to C +recursively using the C command. + +=item $result = $h->debug ($subcmd, \@extraargs); + +The C<$h-Edebug> command exposes some internals of +C (the guestfs daemon) that runs inside the +qemu subprocess. + +There is no comprehensive help for this command. You have +to look at the file C in the libguestfs source +to find out what you can do. + +=item $kmsgs = $h->dmesg (); + +This returns the kernel messages (C output) from +the guest kernel. This is sometimes useful for extended +debugging of problems. + +Another way to get the same information is to enable +verbose messages with C<$h-Eset_verbose> or by setting +the environment variable C before +running the program. + =item $h->download ($remotefilename, $filename); Download file C and save it as C @@ -441,6 +516,42 @@ C can also be a named pipe. See also C<$h-Eupload>, C<$h-Ecat>. +=item $h->drop_caches ($whattodrop); + +This instructs the guest kernel to drop its page cache, +and/or dentries and inode caches. The parameter C +tells the kernel what precisely to drop, see +L + +Setting C to 3 should drop everything. + +This automatically calls L before the operation, +so that the maximum guest memory is freed. + +=item $h->e2fsck_f ($device); + +This runs C, ie. runs the ext2/ext3 +filesystem checker on C, noninteractively (C<-p>), +even if the filesystem appears to be clean (C<-f>). + +This command is only needed because of C<$h-Eresize2fs> +(q.v.). Normally you should use C<$h-Efsck>. + +=item $h->end_busy (); + +This sets the state to C, or if in C then it leaves the +state as is. This is only used when implementing +actions using the low-level API. + +For more information on states, see L. + +=item $equality = $h->equal ($file1, $file2); + +This compares the two files C and C and returns +true if their content is exactly equal, or false otherwise. + +The external L program is used for the comparison. + =item $existsflag = $h->exists ($path); This returns C if and only if there is a file, directory @@ -458,10 +569,84 @@ The exact command which runs is C. Note in particular that the filename is not prepended to the output (the C<-b> option). +=item @names = $h->find ($directory); + +This command lists out all files and directories, recursively, +starting at C. It is essentially equivalent to +running the shell command C but some +post-processing happens on the output, described below. + +This returns a list of strings I. Thus +if the directory structure was: + + /tmp/a + /tmp/b + /tmp/c/d + +then the returned list from C<$h-Efind> C would be +4 elements: + + a + b + c + c/d + +If C is not a directory, then this command returns +an error. + +The returned list is sorted. + +=item $status = $h->fsck ($fstype, $device); + +This runs the filesystem checker (fsck) on C which +should have filesystem type C. + +The returned integer is the status. See L for the +list of status codes from C. + +Notes: + +=over 4 + +=item * + +Multiple status codes can be summed together. + +=item * + +A non-zero return code can mean "success", for example if +errors have been corrected on the filesystem. + +=item * + +Checking or repairing NTFS volumes is not supported +(by linux-ntfs). + +=back + +This command is entirely equivalent to running C. + +=item $append = $h->get_append (); + +Return the additional kernel options which are added to the +guest kernel command line. + +If C then no options are added. + =item $autosync = $h->get_autosync (); Get the autosync flag. +=item $label = $h->get_e2label ($device); + +This returns the ext2/3/4 filesystem label of the filesystem on +C. + +=item $uuid = $h->get_e2uuid ($device); + +This returns the ext2/3/4 filesystem UUID of the filesystem on +C. + =item $path = $h->get_path (); Return the current search path. @@ -487,6 +672,20 @@ For more information on states, see L. This returns the verbose messages flag. +=item $h->grub_install ($root, $device); + +This command installs GRUB (the Grand Unified Bootloader) on +C, with the root directory being C. + +=item $dump = $h->hexdump ($path); + +This runs C on the given C. The result is +the human-readable, canonical hex dump of the file. + +Because of the message protocol, there is a transfer limit +of somewhere between 2MB and 4MB. To transfer large files you should use +FTP. + =item $busy = $h->is_busy (); This returns true iff this handle is busy processing a command @@ -598,6 +797,20 @@ and physical volumes. B. +=item $h->lvremove ($device); + +Remove an LVM logical volume C, where C is +the path to the LV, such as C. + +You can also remove all LVs in a volume group by specifying +the VG name, C. + +=item $h->lvresize ($device, $mbytes); + +This resizes (expands or shrinks) an existing LVM logical +volume to C. When reducing, data in the reduced part +is lost. + =item @logvols = $h->lvs (); List all the logical volumes detected. This is the equivalent @@ -625,7 +838,7 @@ as necessary. This is like the C shell command. =item $h->mkfs ($fstype, $device); This creates a filesystem on C (usually a partition -of LVM logical volume). The filesystem type is C, for +or LVM logical volume). The filesystem type is C, for example C. =item $h->mount ($device, $mountpoint); @@ -671,12 +884,52 @@ the list of devices (eg. C, C). Some internal mounts are not shown. +=item $h->mv ($src, $dest); + +This moves a file from C to C where C is +either a destination filename or destination directory. + +=item $status = $h->ntfs_3g_probe ($rw, $device); + +This command runs the L command which probes +an NTFS C for mountability. (Not all NTFS volumes can +be mounted read-write, and some cannot be mounted at all). + +C is a boolean flag. Set it to true if you want to test +if the volume can be mounted read-write. Set it to false if +you want to test if the volume can be mounted read-only. + +The return value is an integer which C<0> if the operation +would succeed, or some non-zero value documented in the +L manual page. + +=item $h->ping_daemon (); + +This is a test probe into the guestfs daemon running inside +the qemu subprocess. Calling this function checks that the +daemon responds to the ping message, without affecting the daemon +or attached block device(s) in any other way. + =item $h->pvcreate ($device); This creates an LVM physical volume on the named C, where C should usually be a partition name such as C. +=item $h->pvremove ($device); + +This wipes a physical volume C so that LVM will no longer +recognise it. + +The implementation uses the C command which refuses to +wipe physical volumes that contain any volume groups, so you have +to remove those first. + +=item $h->pvresize ($device); + +This resizes (expands or shrinks) an existing LVM physical +volume to match the new size of the underlying device. + =item @physvols = $h->pvs (); List all the physical volumes detected. This is the equivalent @@ -704,6 +957,17 @@ Note that this function cannot correctly handle binary files as end of line). For those you need to use the C<$h-Eread_file> function which has a more complex interface. +=item $h->resize2fs ($device); + +This resizes an ext2 or ext3 filesystem to match the size of +the underlying device. + +I It is sometimes required that you run C<$h-Ee2fsck_f> +on the C before calling this command. For unknown reasons +C sometimes gives an error about this and sometimes not. +In any case, it is always safe to call C<$h-Ee2fsck_f> before +calling this function. + =item $h->rm ($path); Remove the single file C. @@ -718,12 +982,27 @@ command. Remove the single directory C. +=item $h->set_append ($append); + +This function is used to add additional options to the +guest kernel command line. + +The default is C unless overridden by setting +C environment variable. + +Setting C to C means I additional options +are passed (libguestfs always adds a few of its own). + =item $h->set_autosync ($autosync); If C is true, this enables autosync. Libguestfs will make a -best effort attempt to run C<$h-Esync> when the handle is closed +best effort attempt to run C<$h-Eumount_all> followed by +C<$h-Esync> when the handle is closed (also if the program exits without closing handles). +This is disabled by default (except in guestfish where it is +enabled by default). + =item $h->set_busy (); This sets the state to C. This is only used when implementing @@ -731,6 +1010,25 @@ actions using the low-level API. For more information on states, see L. +=item $h->set_e2label ($device, $label); + +This sets the ext2/3/4 filesystem label of the filesystem on +C to C