X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=perl%2Flib%2FSys%2FGuestfs.pm;h=63a49259320e6d79f9ebc733a28f765a9255cab8;hp=c9caf0888a3f07c9661b077e9d89b8db05a8001c;hb=9222136ac9b2e404dba128b1ac74dacaa8bf1038;hpb=5a563bbd9b2779640e3358f4bf1eaac622b58cae diff --git a/perl/lib/Sys/Guestfs.pm b/perl/lib/Sys/Guestfs.pm index c9caf08..63a4925 100644 --- a/perl/lib/Sys/Guestfs.pm +++ b/perl/lib/Sys/Guestfs.pm @@ -245,19 +245,141 @@ how files are saved. Set the value associated with C to C. +=item $h->blockdev_flushbufs ($device); + +This tells the kernel to flush internal buffers associated +with C. + +This uses the L command. + +=item $blocksize = $h->blockdev_getbsz ($device); + +This returns the block size of a device. + +(Note this is different from both I and +I). + +This uses the L command. + +=item $ro = $h->blockdev_getro ($device); + +Returns a boolean indicating if the block device is read-only +(true if read-only, false if not). + +This uses the L command. + +=item $sizeinbytes = $h->blockdev_getsize64 ($device); + +This returns the size of the device in bytes. + +See also C<$h-Eblockdev_getsz>. + +This uses the L command. + +=item $sectorsize = $h->blockdev_getss ($device); + +This returns the size of sectors on a block device. +Usually 512, but can be larger for modern devices. + +(Note, this is not the size in sectors, use C<$h-Eblockdev_getsz> +for that). + +This uses the L command. + +=item $sizeinsectors = $h->blockdev_getsz ($device); + +This returns the size of the device in units of 512-byte sectors +(even if the sectorsize isn't 512 bytes ... weird). + +See also C<$h-Eblockdev_getss> for the real sector size of +the device, and C<$h-Eblockdev_getsize64> for the more +useful I. + +This uses the L command. + +=item $h->blockdev_rereadpt ($device); + +Reread the partition table on C. + +This uses the L command. + +=item $h->blockdev_setbsz ($device, $blocksize); + +This sets the block size of a device. + +(Note this is different from both I and +I). + +This uses the L command. + +=item $h->blockdev_setro ($device); + +Sets the block device named C to read-only. + +This uses the L command. + +=item $h->blockdev_setrw ($device); + +Sets the block device named C to read-write. + +This uses the L command. + =item $content = $h->cat ($path); Return the contents of the file named C. Note that this function cannot correctly handle binary files (specifically, files containing C<\0> character which is treated -as end of string). For those you need to use the C<$h-Eread_file> +as end of string). For those you need to use the C<$h-Edownload> function which has a more complex interface. 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 $checksum = $h->checksum ($csumtype, $path); + +This call computes the MD5, SHAx or CRC checksum of the +file named C. + +The type of checksum to compute is given by the C +parameter which must have one of the following values: + +=over 4 + +=item C + +Compute the cyclic redundancy check (CRC) specified by POSIX +for the C command. + +=item C + +Compute the MD5 hash (using the C program). + +=item C + +Compute the SHA1 hash (using the C program). + +=item C + +Compute the SHA224 hash (using the C program). + +=item C + +Compute the SHA256 hash (using the C program). + +=item C + +Compute the SHA384 hash (using the C program). + +=item C + +Compute the SHA512 hash (using the C program). + +=back + +The checksum is returned as a printable string. + =item $h->chmod ($mode, $path); Change the mode (permissions) of C to C. Only @@ -310,6 +432,47 @@ 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 $h->download ($remotefilename, $filename); + +Download file C and save it as C +on the local machine. + +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 $existsflag = $h->exists ($path); This returns C if and only if there is a file, directory @@ -327,10 +490,50 @@ The exact command which runs is C. Note in particular that the filename is not prepended to the output (the C<-b> option). +=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 $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. @@ -338,10 +541,43 @@ Return the current search path. This is always non-NULL. If it wasn't set already, then this will return the default path. +=item $qemu = $h->get_qemu (); + +Return the current qemu binary. + +This is always non-NULL. If it wasn't set already, then this will +return the default qemu binary name. + +=item $state = $h->get_state (); + +This returns the current state as an opaque integer. This is +only useful for printing debug and internal error messages. + +For more information on states, see L. + =item $verbose = $h->get_verbose (); 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 $busy = $h->is_busy (); + +This returns true iff this handle is busy processing a command +(in the C state). + +For more information on states, see L. + +=item $config = $h->is_config (); + +This returns true iff this handle is being configured +(in the C state). + +For more information on states, see L. + =item $dirflag = $h->is_dir ($path); This returns C if and only if there is a directory @@ -358,6 +594,20 @@ other objects like directories. See also C<$h-Estat>. +=item $launching = $h->is_launching (); + +This returns true iff this handle is launching the subprocess +(in the C state). + +For more information on states, see L. + +=item $ready = $h->is_ready (); + +This returns true iff this handle is ready to accept commands +(in the C state). + +For more information on states, see L. + =item $h->kill_subprocess (); This kills the qemu subprocess. You should never need to call this. @@ -402,6 +652,16 @@ hidden files are shown. This command is mostly useful for interactive sessions. Programs should probably use C<$h-Ereaddir> instead. +=item %statbuf = $h->lstat ($path); + +Returns file information for the given C. + +This is the same as C<$h-Estat> except that if C +is a symbolic link, then the link is stat-ed, not the file it +refers to. + +This is the same as the C system call. + =item $h->lvcreate ($logvol, $volgroup, $mbytes); This creates an LVM volume group called C @@ -415,6 +675,14 @@ 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 @logvols = $h->lvs (); List all the logical volumes detected. This is the equivalent @@ -464,6 +732,23 @@ on the underlying device. The filesystem options C and C are set with this call, in order to improve reliability. +=item $h->mount_options ($options, $device, $mountpoint); + +This is the same as the C<$h-Emount> command, but it +allows you to set the mount options as for the +L I<-o> flag. + +=item $h->mount_ro ($device, $mountpoint); + +This is the same as the C<$h-Emount> command, but it +mounts the filesystem with the read-only (I<-o ro>) flag. + +=item $h->mount_vfs ($options, $vfstype, $device, $mountpoint); + +This is the same as the C<$h-Emount> command, but it +allows you to set both the mount options and the vfstype +as for the L I<-o> and I<-t> flags. + =item @devices = $h->mounts (); This returns the list of currently mounted filesystems. It returns @@ -471,12 +756,26 @@ 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->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 @physvols = $h->pvs (); List all the physical volumes detected. This is the equivalent @@ -521,9 +820,39 @@ Remove the single directory C. =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 +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