+ def upload (self, filename, remotefilename):
+ u"""Upload local file "filename" to "remotefilename" on the
+ filesystem.
+
+ "filename" can also be a named pipe.
+
+ See also "g.download".
+ """
+ return libguestfsmod.upload (self._o, filename, remotefilename)
+
+ def download (self, remotefilename, filename):
+ u"""Download file "remotefilename" and save it as "filename"
+ on the local machine.
+
+ "filename" can also be a named pipe.
+
+ See also "g.upload", "g.cat".
+ """
+ return libguestfsmod.download (self._o, remotefilename, filename)
+
+ def checksum (self, csumtype, path):
+ u"""This call computes the MD5, SHAx or CRC checksum of the
+ file named "path".
+
+ The type of checksum to compute is given by the
+ "csumtype" parameter which must have one of the
+ following values:
+
+ "crc"
+ Compute the cyclic redundancy check (CRC) specified
+ by POSIX for the "cksum" command.
+
+ "md5"
+ Compute the MD5 hash (using the "md5sum" program).
+
+ "sha1"
+ Compute the SHA1 hash (using the "sha1sum" program).
+
+ "sha224"
+ Compute the SHA224 hash (using the "sha224sum"
+ program).
+
+ "sha256"
+ Compute the SHA256 hash (using the "sha256sum"
+ program).
+
+ "sha384"
+ Compute the SHA384 hash (using the "sha384sum"
+ program).
+
+ "sha512"
+ Compute the SHA512 hash (using the "sha512sum"
+ program).
+
+ The checksum is returned as a printable string.
+ """
+ return libguestfsmod.checksum (self._o, csumtype, path)
+
+ def tar_in (self, tarfile, directory):
+ u"""This command uploads and unpacks local file "tarfile"
+ (an *uncompressed* tar file) into "directory".
+
+ To upload a compressed tarball, use "g.tgz_in".
+ """
+ return libguestfsmod.tar_in (self._o, tarfile, directory)
+
+ def tar_out (self, directory, tarfile):
+ u"""This command packs the contents of "directory" and
+ downloads it to local file "tarfile".
+
+ To download a compressed tarball, use "g.tgz_out".
+ """
+ return libguestfsmod.tar_out (self._o, directory, tarfile)
+
+ def tgz_in (self, tarball, directory):
+ u"""This command uploads and unpacks local file "tarball" (a
+ *gzip compressed* tar file) into "directory".
+
+ To upload an uncompressed tarball, use "g.tar_in".
+ """
+ return libguestfsmod.tgz_in (self._o, tarball, directory)
+
+ def tgz_out (self, directory, tarball):
+ u"""This command packs the contents of "directory" and
+ downloads it to local file "tarball".
+
+ To download an uncompressed tarball, use "g.tar_out".
+ """
+ return libguestfsmod.tgz_out (self._o, directory, tarball)
+
+ def mount_ro (self, device, mountpoint):
+ u"""This is the same as the "g.mount" command, but it mounts
+ the filesystem with the read-only (*-o ro*) flag.
+ """
+ return libguestfsmod.mount_ro (self._o, device, mountpoint)
+
+ def mount_options (self, options, device, mountpoint):
+ u"""This is the same as the "g.mount" command, but it allows
+ you to set the mount options as for the mount(8) *-o*
+ flag.
+ """
+ return libguestfsmod.mount_options (self._o, options, device, mountpoint)
+
+ def mount_vfs (self, options, vfstype, device, mountpoint):
+ u"""This is the same as the "g.mount" command, but it allows
+ you to set both the mount options and the vfstype as for
+ the mount(8) *-o* and *-t* flags.
+ """
+ return libguestfsmod.mount_vfs (self._o, options, vfstype, device, mountpoint)
+
+ def debug (self, subcmd, extraargs):
+ u"""The "g.debug" command exposes some internals of
+ "guestfsd" (the guestfs daemon) that runs inside the
+ qemu subprocess.
+
+ There is no comprehensive help for this command. You
+ have to look at the file "daemon/debug.c" in the
+ libguestfs source to find out what you can do.
+ """
+ return libguestfsmod.debug (self._o, subcmd, extraargs)
+
+ def lvremove (self, device):
+ u"""Remove an LVM logical volume "device", where "device" is
+ the path to the LV, such as "/dev/VG/LV".
+
+ You can also remove all LVs in a volume group by
+ specifying the VG name, "/dev/VG".
+ """
+ return libguestfsmod.lvremove (self._o, device)
+
+ def vgremove (self, vgname):
+ u"""Remove an LVM volume group "vgname", (for example "VG").
+
+ This also forcibly removes all logical volumes in the
+ volume group (if any).
+ """
+ return libguestfsmod.vgremove (self._o, vgname)
+
+ def pvremove (self, device):
+ u"""This wipes a physical volume "device" so that LVM will
+ no longer recognise it.
+
+ The implementation uses the "pvremove" command which
+ refuses to wipe physical volumes that contain any volume
+ groups, so you have to remove those first.
+ """
+ return libguestfsmod.pvremove (self._o, device)
+
+ def set_e2label (self, device, label):
+ u"""This sets the ext2/3/4 filesystem label of the
+ filesystem on "device" to "label". Filesystem labels are
+ limited to 16 characters.
+
+ You can use either "g.tune2fs_l" or "g.get_e2label" to
+ return the existing label on a filesystem.
+ """
+ return libguestfsmod.set_e2label (self._o, device, label)
+
+ def get_e2label (self, device):
+ u"""This returns the ext2/3/4 filesystem label of the
+ filesystem on "device".
+ """
+ return libguestfsmod.get_e2label (self._o, device)
+
+ def set_e2uuid (self, device, uuid):
+ u"""This sets the ext2/3/4 filesystem UUID of the filesystem
+ on "device" to "uuid". The format of the UUID and
+ alternatives such as "clear", "random" and "time" are
+ described in the tune2fs(8) manpage.
+
+ You can use either "g.tune2fs_l" or "g.get_e2uuid" to
+ return the existing UUID of a filesystem.
+ """
+ return libguestfsmod.set_e2uuid (self._o, device, uuid)
+
+ def get_e2uuid (self, device):
+ u"""This returns the ext2/3/4 filesystem UUID of the
+ filesystem on "device".
+ """
+ return libguestfsmod.get_e2uuid (self._o, device)
+
+ def fsck (self, fstype, device):
+ u"""This runs the filesystem checker (fsck) on "device"
+ which should have filesystem type "fstype".
+
+ The returned integer is the status. See fsck(8) for the
+ list of status codes from "fsck".
+
+ Notes:
+
+ * Multiple status codes can be summed together.
+
+ * A non-zero return code can mean "success", for
+ example if errors have been corrected on the
+ filesystem.
+
+ * Checking or repairing NTFS volumes is not supported
+ (by linux-ntfs).
+
+ This command is entirely equivalent to running "fsck -a
+ -t fstype device".
+ """
+ return libguestfsmod.fsck (self._o, fstype, device)
+
+ def zero (self, device):
+ u"""This command writes zeroes over the first few blocks of
+ "device".
+
+ How many blocks are zeroed isn't specified (but it's
+ *not* enough to securely wipe the device). It should be
+ sufficient to remove any partition tables, filesystem
+ superblocks and so on.
+ """
+ return libguestfsmod.zero (self._o, device)
+
+ def grub_install (self, root, device):
+ u"""This command installs GRUB (the Grand Unified
+ Bootloader) on "device", with the root directory being
+ "root".
+ """
+ return libguestfsmod.grub_install (self._o, root, device)
+
+ def cp (self, src, dest):
+ u"""This copies a file from "src" to "dest" where "dest" is
+ either a destination filename or destination directory.
+ """
+ return libguestfsmod.cp (self._o, src, dest)
+
+ def cp_a (self, src, dest):
+ u"""This copies a file or directory from "src" to "dest"
+ recursively using the "cp -a" command.
+ """
+ return libguestfsmod.cp_a (self._o, src, dest)
+
+ def mv (self, src, dest):
+ u"""This moves a file from "src" to "dest" where "dest" is
+ either a destination filename or destination directory.
+ """
+ return libguestfsmod.mv (self._o, src, dest)
+
+ def drop_caches (self, whattodrop):
+ u"""This instructs the guest kernel to drop its page cache,
+ and/or dentries and inode caches. The parameter
+ "whattodrop" tells the kernel what precisely to drop,
+ see <http://linux-mm.org/Drop_Caches>
+
+ Setting "whattodrop" to 3 should drop everything.
+
+ This automatically calls sync(2) before the operation,
+ so that the maximum guest memory is freed.
+ """
+ return libguestfsmod.drop_caches (self._o, whattodrop)
+
+ def dmesg (self):
+ u"""This returns the kernel messages ("dmesg" 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 "g.set_verbose" or by setting the
+ environment variable "LIBGUESTFS_DEBUG=1" before running
+ the program.
+ """
+ return libguestfsmod.dmesg (self._o)
+
+ def ping_daemon (self):
+ u"""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.
+ """
+ return libguestfsmod.ping_daemon (self._o)
+
+ def equal (self, file1, file2):
+ u"""This compares the two files "file1" and "file2" and
+ returns true if their content is exactly equal, or false
+ otherwise.
+
+ The external cmp(1) program is used for the comparison.
+ """
+ return libguestfsmod.equal (self._o, file1, file2)
+
+ def strings (self, path):
+ u"""This runs the strings(1) command on a file and returns
+ the list of printable strings found.
+
+ This function returns a list of strings.
+
+ Because of the message protocol, there is a transfer
+ limit of somewhere between 2MB and 4MB. To transfer
+ large files you should use FTP.
+ """
+ return libguestfsmod.strings (self._o, path)
+
+ def strings_e (self, encoding, path):
+ u"""This is like the "g.strings" command, but allows you to
+ specify the encoding.
+
+ See the strings(1) manpage for the full list of
+ encodings.
+
+ Commonly useful encodings are "l" (lower case L) which
+ will show strings inside Windows/x86 files.
+
+ The returned strings are transcoded to UTF-8.
+
+ This function returns a list of strings.
+
+ Because of the message protocol, there is a transfer
+ limit of somewhere between 2MB and 4MB. To transfer
+ large files you should use FTP.
+ """
+ return libguestfsmod.strings_e (self._o, encoding, path)
+
+ def hexdump (self, path):
+ u"""This runs "hexdump -C" on the given "path". 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.
+ """
+ return libguestfsmod.hexdump (self._o, path)
+
+ def zerofree (self, device):
+ u"""This runs the *zerofree* program on "device". 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 not run this program if the filesystem is
+ mounted.
+
+ It is possible that using this program can damage the
+ filesystem or data on the filesystem.
+ """
+ return libguestfsmod.zerofree (self._o, device)
+
+ def pvresize (self, device):
+ u"""This resizes (expands or shrinks) an existing LVM
+ physical volume to match the new size of the underlying
+ device.
+ """
+ return libguestfsmod.pvresize (self._o, device)
+
+ def sfdisk_N (self, device, n, cyls, heads, sectors, line):
+ u"""This runs sfdisk(8) option to modify just the single
+ partition "n" (note: "n" counts from 1).
+
+ For other parameters, see "g.sfdisk". You should usually
+ pass 0 for the cyls/heads/sectors parameters.
+
+ This command is dangerous. Without careful use you can
+ easily destroy all your data.
+ """
+ return libguestfsmod.sfdisk_N (self._o, device, n, cyls, heads, sectors, line)
+
+ def sfdisk_l (self, device):
+ u"""This displays the partition table on "device", in the
+ human-readable output of the sfdisk(8) command. It is
+ not intended to be parsed.
+ """
+ return libguestfsmod.sfdisk_l (self._o, device)
+
+ def sfdisk_kernel_geometry (self, device):
+ u"""This displays the kernel's idea of the geometry of
+ "device".
+
+ The result is in human-readable format, and not designed
+ to be parsed.
+ """
+ return libguestfsmod.sfdisk_kernel_geometry (self._o, device)
+
+ def sfdisk_disk_geometry (self, device):
+ u"""This displays the disk geometry of "device" 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
+ "g.sfdisk_kernel_geometry").
+
+ The result is in human-readable format, and not designed
+ to be parsed.
+ """
+ return libguestfsmod.sfdisk_disk_geometry (self._o, device)
+
+ def vg_activate_all (self, activate):
+ u"""This command activates or (if "activate" is false)
+ deactivates all logical volumes in all volume groups. If
+ activated, then they are made known to the kernel, ie.
+ they appear as "/dev/mapper" devices. If deactivated,
+ then those devices disappear.
+
+ This command is the same as running "vgchange -a y|n"
+ """
+ return libguestfsmod.vg_activate_all (self._o, activate)
+
+ def vg_activate (self, activate, volgroups):
+ u"""This command activates or (if "activate" is false)
+ deactivates all logical volumes in the listed volume
+ groups "volgroups". If activated, then they are made
+ known to the kernel, ie. they appear as "/dev/mapper"
+ devices. If deactivated, then those devices disappear.
+
+ This command is the same as running "vgchange -a y|n
+ volgroups..."
+
+ Note that if "volgroups" is an empty list then all
+ volume groups are activated or deactivated.
+ """
+ return libguestfsmod.vg_activate (self._o, activate, volgroups)
+
+ def lvresize (self, device, mbytes):
+ u"""This resizes (expands or shrinks) an existing LVM
+ logical volume to "mbytes". When reducing, data in the
+ reduced part is lost.
+ """
+ return libguestfsmod.lvresize (self._o, device, mbytes)
+
+ def resize2fs (self, device):
+ u"""This resizes an ext2 or ext3 filesystem to match the
+ size of the underlying device.
+
+ *Note:* It is sometimes required that you run
+ "g.e2fsck_f" on the "device" before calling this
+ command. For unknown reasons "resize2fs" sometimes gives
+ an error about this and sometimes not. In any case, it
+ is always safe to call "g.e2fsck_f" before calling this
+ function.
+ """
+ return libguestfsmod.resize2fs (self._o, device)
+
+ def find (self, directory):
+ u"""This command lists out all files and directories,
+ recursively, starting at "directory". It is essentially
+ equivalent to running the shell command "find directory
+ -print" but some post-processing happens on the output,
+ described below.
+
+ This returns a list of strings *without any prefix*.
+ Thus if the directory structure was:
+
+ /tmp/a
+ /tmp/b
+ /tmp/c/d
+
+ then the returned list from "g.find" "/tmp" would be 4
+ elements:
+
+ a
+ b
+ c
+ c/d
+
+ If "directory" is not a directory, then this command
+ returns an error.
+
+ The returned list is sorted.
+
+ This function returns a list of strings.
+ """
+ return libguestfsmod.find (self._o, directory)
+
+ def e2fsck_f (self, device):
+ u"""This runs "e2fsck -p -f device", ie. runs the ext2/ext3
+ filesystem checker on "device", noninteractively ("-p"),
+ even if the filesystem appears to be clean ("-f").
+
+ This command is only needed because of "g.resize2fs"
+ (q.v.). Normally you should use "g.fsck".
+ """
+ return libguestfsmod.e2fsck_f (self._o, device)
+
+ def sleep (self, secs):
+ u"""Sleep for "secs" seconds.
+ """
+ return libguestfsmod.sleep (self._o, secs)
+
+ def ntfs_3g_probe (self, rw, device):
+ u"""This command runs the ntfs-3g.probe(8) command which
+ probes an NTFS "device" for mountability. (Not all NTFS
+ volumes can be mounted read-write, and some cannot be
+ mounted at all).
+
+ "rw" 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 0 if the operation
+ would succeed, or some non-zero value documented in the
+ ntfs-3g.probe(8) manual page.
+ """
+ return libguestfsmod.ntfs_3g_probe (self._o, rw, device)
+