X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=perl%2Flib%2FSys%2FGuestfs.pm;h=0e4dde4d855c89efc7800b9952666a0eb583eac3;hp=2d75b69fe978d63eb4642670a9f9a00f482ae924;hb=85ed8cef99c19b4143844991d14e0b848fecc5da;hpb=62df226f26bd6ac3c481a7790eb89d760d2f0386 diff --git a/perl/lib/Sys/Guestfs.pm b/perl/lib/Sys/Guestfs.pm index 2d75b69..0e4dde4 100644 --- a/perl/lib/Sys/Guestfs.pm +++ b/perl/lib/Sys/Guestfs.pm @@ -405,6 +405,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 +423,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 +447,16 @@ 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 @@ -442,6 +467,17 @@ 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 @@ -451,6 +487,33 @@ 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->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 @@ -474,13 +537,37 @@ 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, and note that multiple -status codes can be summed together. +list of status codes from C. + +Notes: + +=over 4 + +=item * + +Multiple status codes can be summed together. -It is entirely equivalent to running C. -Note that checking or repairing NTFS volumes is not supported +=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. @@ -520,6 +607,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 @@ -666,7 +767,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); @@ -712,6 +813,18 @@ 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 $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, @@ -727,6 +840,11 @@ 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 @@ -768,6 +886,17 @@ 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 @@ -811,9 +940,6 @@ Set the path that libguestfs searches for kernel and initrd.img. The default is C<$libdir/guestfs> unless overridden by setting C environment variable. -The string C is stashed in the libguestfs handle, so the caller -must make sure it remains valid for the lifetime of the handle. - Setting C to C restores the default path. =item $h->set_qemu ($qemu); @@ -826,9 +952,6 @@ configure script. You can also override this by setting the C environment variable. -The string C is stashed in the libguestfs handle, so the caller -must make sure it remains valid for the lifetime of the handle. - Setting C to C restores the default qemu binary. =item $h->set_ready (); @@ -867,9 +990,45 @@ To create a single partition occupying the whole disk, you would pass C as a single element list, when the single element being the string C<,> (comma). +See also: C<$h-Esfdisk_l>, C<$h-Esfdisk_N> + +B. + +=item $h->sfdisk_N ($device, $n, $cyls, $heads, $sectors, $line); + +This runs L option to modify just the single +partition C (note: C counts from 1). + +For other parameters, see C<$h-Esfdisk>. You should usually +pass C<0> for the cyls/heads/sectors parameters. + B. +=item $partitions = $h->sfdisk_disk_geometry ($device); + +This displays the disk geometry of C read from the +partition table. Especially in the case where the underlying +block device has been resized, this can be different from the +kernel's idea of the geometry (see C<$h-Esfdisk_kernel_geometry>). + +The result is in human-readable format, and not designed to +be parsed. + +=item $partitions = $h->sfdisk_kernel_geometry ($device); + +This displays the kernel's idea of the geometry of C. + +The result is in human-readable format, and not designed to +be parsed. + +=item $partitions = $h->sfdisk_l ($device); + +This displays the partition table on C, in the +human-readable output of the L command. It is +not intended to be parsed. + =item %statbuf = $h->stat ($path); Returns file information for the given C. @@ -884,6 +1043,31 @@ C should be a file or directory in the mounted file system This is the same as the C system call. +=item @stringsout = $h->strings ($path); + +This runs the L command on a file and returns +the list of printable strings found. + +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 @stringsout = $h->strings_e ($encoding, $path); + +This is like the C<$h-Estrings> command, but allows you to +specify the encoding. + +See the L manpage for the full list of encodings. + +Commonly useful encodings are C (lower case L) which will +show strings inside Windows/x86 files. + +The returned strings are transcoded to UTF-8. + +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->sync (); This syncs the disk, so that any writes are flushed through to the @@ -957,6 +1141,29 @@ C can also be a named pipe. See also C<$h-Edownload>. +=item $h->vg_activate ($activate, \@volgroups); + +This command activates or (if C is false) deactivates +all logical volumes in the listed volume groups C. +If activated, then they are made known to the +kernel, ie. they appear as C devices. If deactivated, +then those devices disappear. + +This command is the same as running C + +Note that if C is an empty list then B volume groups +are activated or deactivated. + +=item $h->vg_activate_all ($activate); + +This command activates or (if C is false) deactivates +all logical volumes in all volume groups. +If activated, then they are made known to the +kernel, ie. they appear as C devices. If deactivated, +then those devices disappear. + +This command is the same as running C + =item $h->vgcreate ($volgroup, \@physvols); This creates an LVM volume group called C @@ -1002,6 +1209,11 @@ As a special case, if C is C<0> then the length is calculated using C (so in this case the content cannot contain embedded ASCII NULs). +I Owing to a bug, writing content containing ASCII NUL +characters does I work, even if the length is specified. +We hope to resolve this bug in a future version. In the meantime +use C<$h-Eupload>. + Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. To transfer large files you should use FTP. @@ -1014,6 +1226,19 @@ How many blocks are zeroed isn't specified (but it's I enough to securely wipe the device). It should be sufficient to remove any partition tables, filesystem superblocks and so on. +=item $h->zerofree ($device); + +This runs the I program on C. This program +claims to zero unused inodes and disk blocks on an ext2/3 +filesystem, thus making it possible to compress the filesystem +more effectively. + +You should B run this program if the filesystem is +mounted. + +It is possible that using this program can damage the filesystem +or data on the filesystem. + =cut 1;