+ def file (self, path):
+ u"""This call uses the standard file(1) command to determine
+ the type or contents of the file. This also works on
+ devices, for example to find out whether a partition
+ contains a filesystem.
+
+ The exact command which runs is "file -bsL path". Note
+ in particular that the filename is not prepended to the
+ output (the "-b" option).
+ """
+ return libguestfsmod.file (self._o, path)
+
+ def command (self, arguments):
+ u"""This call runs a command from the guest filesystem. The
+ filesystem must be mounted, and must contain a
+ compatible operating system (ie. something Linux, with
+ the same or compatible processor architecture).
+
+ The single parameter is an argv-style list of arguments.
+ 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 $PATH environment variable will contain at least
+ "/usr/bin" and "/bin". If you require a program from
+ another location, you should provide the full path in
+ the first parameter.
+
+ Shared libraries and data files required by the program
+ must be available on filesystems which are mounted in
+ the correct places. It is the caller's responsibility to
+ ensure all filesystems that are needed are mounted at
+ the right locations.
+ """
+ return libguestfsmod.command (self._o, arguments)
+
+ def command_lines (self, arguments):
+ u"""This is the same as "g.command", but splits the result
+ into a list of lines.
+
+ This function returns a list of strings.
+ """
+ return libguestfsmod.command_lines (self._o, arguments)
+
+ def stat (self, path):
+ u"""Returns file information for the given "path".
+
+ This is the same as the stat(2) system call.
+
+ This function returns a dictionary, with keys matching
+ the various fields in the stat structure.
+ """
+ return libguestfsmod.stat (self._o, path)
+
+ def lstat (self, path):
+ u"""Returns file information for the given "path".
+
+ This is the same as "g.stat" except that if "path" is a
+ symbolic link, then the link is stat-ed, not the file it
+ refers to.
+
+ This is the same as the lstat(2) system call.
+
+ This function returns a dictionary, with keys matching
+ the various fields in the stat structure.
+ """
+ return libguestfsmod.lstat (self._o, path)
+
+ def statvfs (self, path):
+ u"""Returns file system statistics for any mounted file
+ system. "path" should be a file or directory in the
+ mounted file system (typically it is the mount point
+ itself, but it doesn't need to be).
+
+ This is the same as the statvfs(2) system call.
+
+ This function returns a dictionary, with keys matching
+ the various fields in the statvfs structure.
+ """
+ return libguestfsmod.statvfs (self._o, path)
+
+ def tune2fs_l (self, device):
+ u"""This returns the contents of the ext2, ext3 or ext4
+ filesystem superblock on "device".
+
+ It is the same as running "tune2fs -l device". See
+ tune2fs(8) manpage for more details. The list of fields
+ returned isn't clearly defined, and depends on both the
+ version of "tune2fs" that libguestfs was built against,
+ and the filesystem itself.
+
+ This function returns a dictionary.
+ """
+ return libguestfsmod.tune2fs_l (self._o, device)
+
+ def blockdev_setro (self, device):
+ u"""Sets the block device named "device" to read-only.
+
+ This uses the blockdev(8) command.
+ """
+ return libguestfsmod.blockdev_setro (self._o, device)
+
+ def blockdev_setrw (self, device):
+ u"""Sets the block device named "device" to read-write.
+
+ This uses the blockdev(8) command.
+ """
+ return libguestfsmod.blockdev_setrw (self._o, device)
+
+ def blockdev_getro (self, device):
+ u"""Returns a boolean indicating if the block device is
+ read-only (true if read-only, false if not).
+
+ This uses the blockdev(8) command.
+ """
+ return libguestfsmod.blockdev_getro (self._o, device)
+
+ def blockdev_getss (self, device):
+ u"""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
+ "g.blockdev_getsz" for that).
+
+ This uses the blockdev(8) command.
+ """
+ return libguestfsmod.blockdev_getss (self._o, device)
+
+ def blockdev_getbsz (self, device):
+ u"""This returns the block size of a device.
+
+ (Note this is different from both *size in blocks* and
+ *filesystem block size*).
+
+ This uses the blockdev(8) command.
+ """
+ return libguestfsmod.blockdev_getbsz (self._o, device)
+
+ def blockdev_setbsz (self, device, blocksize):
+ u"""This sets the block size of a device.
+
+ (Note this is different from both *size in blocks* and
+ *filesystem block size*).
+
+ This uses the blockdev(8) command.
+ """
+ return libguestfsmod.blockdev_setbsz (self._o, device, blocksize)
+
+ def blockdev_getsz (self, device):
+ u"""This returns the size of the device in units of 512-byte
+ sectors (even if the sectorsize isn't 512 bytes ...
+ weird).
+
+ See also "g.blockdev_getss" for the real sector size of
+ the device, and "g.blockdev_getsize64" for the more
+ useful *size in bytes*.
+
+ This uses the blockdev(8) command.
+ """
+ return libguestfsmod.blockdev_getsz (self._o, device)
+
+ def blockdev_getsize64 (self, device):
+ u"""This returns the size of the device in bytes.
+
+ See also "g.blockdev_getsz".
+
+ This uses the blockdev(8) command.
+ """
+ return libguestfsmod.blockdev_getsize64 (self._o, device)
+
+ def blockdev_flushbufs (self, device):
+ u"""This tells the kernel to flush internal buffers
+ associated with "device".
+
+ This uses the blockdev(8) command.
+ """
+ return libguestfsmod.blockdev_flushbufs (self._o, device)
+
+ def blockdev_rereadpt (self, device):
+ u"""Reread the partition table on "device".
+
+ This uses the blockdev(8) command.
+ """
+ return libguestfsmod.blockdev_rereadpt (self._o, device)
+
+ 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)
+