X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;ds=sidebyside;f=python%2Fguestfs.py;h=678e298e9eb894271b47df740d09ae34d558bd2b;hb=d43dac69483e8ec62e8356d93f761684ce2f5cc8;hp=1ebaa74a637bac3bebfc91699b2677c642f471d6;hpb=aed0fa2c015e56a882fd6d4b759c82df08fc40d7;p=libguestfs.git diff --git a/python/guestfs.py b/python/guestfs.py index 1ebaa74..678e298 100644 --- a/python/guestfs.py +++ b/python/guestfs.py @@ -194,9 +194,12 @@ class GuestFS: def set_autosync (self, autosync): u"""If "autosync" is true, this enables autosync. Libguestfs - will make a best effort attempt to run "g.sync" when the - handle is closed (also if the program exits without - closing handles). + will make a best effort attempt to run "g.umount_all" + followed by "g.sync" 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). """ return libguestfsmod.set_autosync (self._o, autosync) @@ -276,6 +279,15 @@ class GuestFS: """ return libguestfsmod.set_ready (self._o) + def end_busy (self): + u"""This sets the state to "READY", or if in "CONFIG" 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 guestfs(3). + """ + return libguestfsmod.end_busy (self._o) + def mount (self, device, mountpoint): u"""Mount a guest disk at a position in the filesystem. Block devices are named "/dev/sda", "/dev/sdb" and so @@ -697,7 +709,7 @@ class GuestFS: def mkfs (self, fstype, device): u"""This creates a filesystem on "device" (usually a - partition of LVM logical volume). The filesystem type is + partition or LVM logical volume). The filesystem type is "fstype", for example "ext3". """ return libguestfsmod.mkfs (self._o, fstype, device) @@ -740,6 +752,11 @@ class GuestFS: calculated using "strlen" (so in this case the content cannot contain embedded ASCII NULs). + *NB.* Owing to a bug, writing content containing ASCII + NUL characters does *not* work, even if the length is + specified. We hope to resolve this bug in a future + version. In the meantime use "g.upload". + Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. To transfer large files you should use FTP. @@ -1113,3 +1130,180 @@ class GuestFS: """ 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 + + 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) +