X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=python%2Fguestfs.py;h=aa3572bf835673603ea94b23af9d200e4f60ed82;hb=284797c1561e5e089986027d469bd16ee1a983df;hp=c9658cd1513a78243c31c4564276f542c8990588;hpb=4211c7a258debd236017a19c70965bc1b3658edb;p=libguestfs.git diff --git a/python/guestfs.py b/python/guestfs.py index c9658cd..aa3572b 100644 --- a/python/guestfs.py +++ b/python/guestfs.py @@ -197,7 +197,7 @@ class GuestFS: to modify the image). This is equivalent to the qemu parameter "-drive - file=filename". + file=filename,cache=off". Note that this call checks for the existence of "filename". This stops you from specifying other types @@ -1342,6 +1342,8 @@ class GuestFS: *not* enough to securely wipe the device). It should be sufficient to remove any partition tables, filesystem superblocks and so on. + + See also: "g.scrub_device". """ return libguestfsmod.zero (self._o, device) @@ -1476,7 +1478,7 @@ class GuestFS: """ return libguestfsmod.pvresize (self._o, device) - def sfdisk_N (self, device, n, cyls, heads, sectors, line): + def sfdisk_N (self, device, partnum, cyls, heads, sectors, line): u"""This runs sfdisk(8) option to modify just the single partition "n" (note: "n" counts from 1). @@ -1486,7 +1488,7 @@ class GuestFS: 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) + return libguestfsmod.sfdisk_N (self._o, device, partnum, cyls, heads, sectors, line) def sfdisk_l (self, device): u"""This displays the partition table on "device", in the @@ -1651,3 +1653,228 @@ class GuestFS: """ return libguestfsmod.sh_lines (self._o, command) + def glob_expand (self, pattern): + u"""This command searches for all the pathnames matching + "pattern" according to the wildcard expansion rules used + by the shell. + + If no paths match, then this returns an empty list + (note: not an error). + + It is just a wrapper around the C glob(3) function with + flags "GLOB_MARK|GLOB_BRACE". See that manual page for + more details. + + This function returns a list of strings. + """ + return libguestfsmod.glob_expand (self._o, pattern) + + def scrub_device (self, device): + u"""This command writes patterns over "device" to make data + retrieval more difficult. + + It is an interface to the scrub(1) program. See that + manual page for more details. + + This command is dangerous. Without careful use you can + easily destroy all your data. + """ + return libguestfsmod.scrub_device (self._o, device) + + def scrub_file (self, file): + u"""This command writes patterns over a file to make data + retrieval more difficult. + + The file is *removed* after scrubbing. + + It is an interface to the scrub(1) program. See that + manual page for more details. + """ + return libguestfsmod.scrub_file (self._o, file) + + def scrub_freespace (self, dir): + u"""This command creates the directory "dir" and then fills + it with files until the filesystem is full, and scrubs + the files as for "g.scrub_file", and deletes them. The + intention is to scrub any free space on the partition + containing "dir". + + It is an interface to the scrub(1) program. See that + manual page for more details. + """ + return libguestfsmod.scrub_freespace (self._o, dir) + + def mkdtemp (self, template): + u"""This command creates a temporary directory. The + "template" parameter should be a full pathname for the + temporary directory name with the final six characters + being "XXXXXX". + + For example: "/tmp/myprogXXXXXX" or + "/Temp/myprogXXXXXX", the second one being suitable for + Windows filesystems. + + The name of the temporary directory that was created is + returned. + + The temporary directory is created with mode 0700 and is + owned by root. + + The caller is responsible for deleting the temporary + directory and its contents after use. + + See also: mkdtemp(3) + """ + return libguestfsmod.mkdtemp (self._o, template) + + def wc_l (self, path): + u"""This command counts the lines in a file, using the "wc + -l" external command. + """ + return libguestfsmod.wc_l (self._o, path) + + def wc_w (self, path): + u"""This command counts the words in a file, using the "wc + -w" external command. + """ + return libguestfsmod.wc_w (self._o, path) + + def wc_c (self, path): + u"""This command counts the characters in a file, using the + "wc -c" external command. + """ + return libguestfsmod.wc_c (self._o, path) + + def head (self, path): + u"""This command returns up to the first 10 lines of a file + as a list of strings. + + 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.head (self._o, path) + + def head_n (self, nrlines, path): + u"""If the parameter "nrlines" is a positive number, this + returns the first "nrlines" lines of the file "path". + + If the parameter "nrlines" is a negative number, this + returns lines from the file "path", excluding the last + "nrlines" lines. + + If the parameter "nrlines" is zero, this returns an + empty list. + + 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.head_n (self._o, nrlines, path) + + def tail (self, path): + u"""This command returns up to the last 10 lines of a file + as a list of strings. + + 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.tail (self._o, path) + + def tail_n (self, nrlines, path): + u"""If the parameter "nrlines" is a positive number, this + returns the last "nrlines" lines of the file "path". + + If the parameter "nrlines" is a negative number, this + returns lines from the file "path", starting with the + "-nrlines"th line. + + If the parameter "nrlines" is zero, this returns an + empty list. + + 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.tail_n (self._o, nrlines, path) + + def df (self): + u"""This command runs the "df" command to report disk space + used. + + This command is mostly useful for interactive sessions. + It is *not* intended that you try to parse the output + string. Use "statvfs" from programs. + """ + return libguestfsmod.df (self._o) + + def df_h (self): + u"""This command runs the "df -h" command to report disk + space used in human-readable format. + + This command is mostly useful for interactive sessions. + It is *not* intended that you try to parse the output + string. Use "statvfs" from programs. + """ + return libguestfsmod.df_h (self._o) + + def du (self, path): + u"""This command runs the "du -s" command to estimate file + space usage for "path". + + "path" can be a file or a directory. If "path" is a + directory then the estimate includes the contents of the + directory and all subdirectories (recursively). + + The result is the estimated size in *kilobytes* (ie. + units of 1024 bytes). + """ + return libguestfsmod.du (self._o, path) + + def initrd_list (self, path): + u"""This command lists out files contained in an initrd. + + The files are listed without any initial "/" character. + The files are listed in the order they appear (not + necessarily alphabetical). Directory names are listed as + separate items. + + Old Linux kernels (2.4 and earlier) used a compressed + ext2 filesystem as initrd. We *only* support the newer + initramfs format (compressed cpio files). + + This function returns a list of strings. + """ + return libguestfsmod.initrd_list (self._o, path) + + def mount_loop (self, file, mountpoint): + u"""This command lets you mount "file" (a filesystem image + in a file) on a mount point. It is entirely equivalent + to the command "mount -o loop file mountpoint". + """ + return libguestfsmod.mount_loop (self._o, file, mountpoint) + + def mkswap (self, device): + u"""Create a swap partition on "device". + """ + return libguestfsmod.mkswap (self._o, device) + + def mkswap_L (self, label, device): + u"""Create a swap partition on "device" with label "label". + """ + return libguestfsmod.mkswap_L (self._o, label, device) + + def mkswap_U (self, uuid, device): + u"""Create a swap partition on "device" with UUID "uuid". + """ + return libguestfsmod.mkswap_U (self._o, uuid, device) +