com.redhat.et.libguestfs
public class GuestFS extends Object
Constructor Summary | |
---|---|
GuestFS()
Create a libguestfs handle.
|
Method Summary | |
---|---|
void | add_cdrom(String filename)
add a CD-ROM disk image to examine
This function adds a virtual CD-ROM disk image to the guest. |
void | add_drive(String filename)
add an image to examine or modify
This function adds a virtual machine disk image "filename" to the guest. |
void | add_drive_ro(String filename)
add a drive in snapshot mode (read-only)
This adds a drive in snapshot mode, making it effectively read-only. |
void | add_drive_ro_with_if(String filename, String iface)
add a drive read-only specifying the QEMU block emulation to use
This is the same as "g.add_drive_ro" but it allows you to specify the QEMU interface emulation to use at run time. |
void | add_drive_with_if(String filename, String iface)
add a drive specifying the QEMU block emulation to use
This is the same as "g.add_drive" but it allows you to specify the QEMU interface emulation to use at run time. |
void | aug_clear(String augpath)
clear Augeas path
Set the value associated with "path" to "NULL". |
void | aug_close()
close the current Augeas handle
Close the current Augeas handle and free up any resources used by it. |
IntBool | aug_defnode(String name, String expr, String val)
define an Augeas node
Defines a variable "name" whose value is the result of evaluating "expr". |
int | aug_defvar(String name, String expr)
define an Augeas variable
Defines an Augeas variable "name" whose value is the result of evaluating "expr". |
String | aug_get(String augpath)
look up the value of an Augeas path
Look up the value associated with "path". |
void | aug_init(String root, int flags)
create a new Augeas handle
Create a new Augeas handle for editing configuration files. |
void | aug_insert(String augpath, String label, boolean before)
insert a sibling Augeas node
Create a new sibling "label" for "path", inserting it into the tree before or after "path" (depending on the boolean flag "before"). |
void | aug_load()
load files into the tree
Load files into the tree. |
String[] | aug_ls(String augpath)
list Augeas nodes under augpath
This is just a shortcut for listing "g.aug_match" "path/*" and sorting the resulting nodes into alphabetical order. |
String[] | aug_match(String augpath)
return Augeas nodes which match augpath
Returns a list of paths which match the path expression "path". |
void | aug_mv(String src, String dest)
move Augeas node
Move the node "src" to "dest". |
int | aug_rm(String augpath)
remove an Augeas path
Remove "path" and all of its children. |
void | aug_save()
write all pending Augeas changes to disk
This writes all pending changes to disk. |
void | aug_set(String augpath, String val)
set Augeas path to value
Set the value associated with "path" to "val". |
void | available(String[] groups)
test availability of some parts of the API
This command is used to check the availability of some groups of functionality in the appliance, which not all builds of the libguestfs appliance will be able to provide. |
void | blockdev_flushbufs(String device)
flush device buffers
This tells the kernel to flush internal buffers associated with "device". |
int | blockdev_getbsz(String device)
get blocksize of block device
This returns the block size of a device. |
boolean | blockdev_getro(String device)
is block device set to read-only
Returns a boolean indicating if the block device is read-only (true if read-only, false if not). |
long | blockdev_getsize64(String device)
get total size of device in bytes
This returns the size of the device in bytes. |
int | blockdev_getss(String device)
get sectorsize of block device
This returns the size of sectors on a block device. |
long | blockdev_getsz(String device)
get total size of device in 512-byte sectors
This returns the size of the device in units of 512-byte sectors (even if the sectorsize isn't 512 bytes ... weird). |
void | blockdev_rereadpt(String device)
reread partition table
Reread the partition table on "device". |
void | blockdev_setbsz(String device, int blocksize)
set blocksize of block device
This sets the block size of a device. |
void | blockdev_setro(String device)
set block device to read-only
Sets the block device named "device" to read-only. |
void | blockdev_setrw(String device)
set block device to read-write
Sets the block device named "device" to read-write. |
String | case_sensitive_path(String path)
return true path on case-insensitive filesystem
This can be used to resolve case insensitive paths on a filesystem which is case sensitive. |
String | cat(String path)
list the contents of a file
Return the contents of the file named "path". |
String | checksum(String csumtype, String path)
compute MD5, SHAx or CRC checksum of file
This call computes the MD5, SHAx or CRC checksum of the file named "path". |
void | chmod(int mode, String path)
change file mode
Change the mode (permissions) of "path" to "mode". |
void | chown(int owner, int group, String path)
change file owner and group
Change the file owner to "owner" and group to "group". |
void | close()
Close a libguestfs handle.
|
String | command(String[] arguments)
run a command from the guest filesystem
This call runs a command from the guest filesystem. |
String[] | command_lines(String[] arguments)
run a command, returning lines
This is the same as "g.command", but splits the result into a list of lines. |
void | config(String qemuparam, String qemuvalue)
add qemu parameters
This can be used to add arbitrary qemu command line parameters of the form "-param value". |
void | copy_size(String src, String dest, long size)
copy size bytes from source to destination using dd
This command copies exactly "size" bytes from one source device or file "src" to another destination device or file "dest". |
void | cp(String src, String dest)
copy a file
This copies a file from "src" to "dest" where "dest" is either a destination filename or destination directory. |
void | cp_a(String src, String dest)
copy a file or directory recursively
This copies a file or directory from "src" to "dest" recursively using the "cp -a" command. |
void | dd(String src, String dest)
copy from source to destination using dd
This command copies from one source device or file "src" to another destination device or file "dest". |
String | debug(String subcmd, String[] extraargs)
debugging and internals
The "g.debug" command exposes some internals of "guestfsd" (the guestfs daemon) that runs inside the qemu subprocess. |
String | df()
report file system disk space usage
This command runs the "df" command to report disk space used. |
String | df_h()
report file system disk space usage (human readable)
This command runs the "df -h" command to report disk space used in human-readable format. |
String | dmesg()
return kernel messages
This returns the kernel messages ("dmesg" output) from the guest kernel. |
void | download(String remotefilename, String filename)
download a file to the local machine
Download file "remotefilename" and save it as "filename" on the local machine. |
void | drop_caches(int whattodrop)
drop kernel page cache, dentries and inodes
This instructs the guest kernel to drop its page cache, and/or dentries and inode caches. |
long | du(String path)
estimate file space usage
This command runs the "du -s" command to estimate file space usage for "path". |
void | e2fsck_f(String device)
check an ext2/ext3 filesystem
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"). |
String | echo_daemon(String[] words)
echo arguments back to the client
This command concatenate the list of "words" passed with single spaces between them and returns the resulting string. |
String[] | egrep(String regex, String path)
return lines matching a pattern
This calls the external "egrep" program and returns the matching lines. |
String[] | egrepi(String regex, String path)
return lines matching a pattern
This calls the external "egrep -i" program and returns the matching lines. |
boolean | equal(String file1, String file2)
test if two files have equal contents
This compares the two files "file1" and "file2" and returns true if their content is exactly equal, or false otherwise. |
boolean | exists(String path)
test if file or directory exists
This returns "true" if and only if there is a file, directory (or anything) with the given "path" name. |
void | fallocate(String path, int len)
preallocate a file in the guest filesystem
This command preallocates a file (containing zero bytes) named "path" of size "len" bytes. |
String[] | fgrep(String pattern, String path)
return lines matching a pattern
This calls the external "fgrep" program and returns the matching lines. |
String[] | fgrepi(String pattern, String path)
return lines matching a pattern
This calls the external "fgrep -i" program and returns the matching lines. |
String | file(String path)
determine file type
This call uses the standard file(1) command to determine the type or contents of the file. |
long | filesize(String file)
return the size of the file in bytes
This command returns the size of "file" in bytes. |
void | fill(int c, int len, String path)
fill a file with octets
This command creates a new file called "path". |
void | finalize() |
String[] | find(String directory)
find all files and directories
This command lists out all files and directories, recursively, starting at "directory". |
void | find0(String directory, String files)
find all files and directories, returning NUL-separated list
This command lists out all files and directories, recursively, starting at "directory", placing the resulting list in the external file called "files". |
int | fsck(String fstype, String device)
run the filesystem checker
This runs the filesystem checker (fsck) on "device" which should have filesystem type "fstype". |
String | getcon()
get SELinux security context
This gets the SELinux security context of the daemon. |
XAttr[] | getxattrs(String path)
list extended attributes of a file or directory
This call lists the extended attributes of the file or directory "path". |
String | get_append()
get the additional kernel options
Return the additional kernel options which are added to the guest kernel command line. |
boolean | get_autosync()
get autosync mode
Get the autosync flag. |
boolean | get_direct()
get direct appliance mode flag
Return the direct appliance mode flag. |
String | get_e2label(String device)
get the ext2/3/4 filesystem label
This returns the ext2/3/4 filesystem label of the filesystem on "device". |
String | get_e2uuid(String device)
get the ext2/3/4 filesystem UUID
This returns the ext2/3/4 filesystem UUID of the filesystem on "device". |
int | get_memsize()
get memory allocated to the qemu subprocess
This gets the memory size in megabytes allocated to the qemu subprocess. |
String | get_path()
get the search path
Return the current search path. |
int | get_pid()
get PID of qemu subprocess
Return the process ID of the qemu subprocess. |
String | get_qemu()
get the qemu binary
Return the current qemu binary. |
boolean | get_recovery_proc()
get recovery process enabled flag
Return the recovery process enabled flag. |
boolean | get_selinux()
get SELinux enabled flag
This returns the current setting of the selinux flag which is passed to the appliance at boot time. |
int | get_state()
get the current state
This returns the current state as an opaque integer. |
boolean | get_trace()
get command trace enabled flag
Return the command trace flag. |
boolean | get_verbose()
get verbose mode
This returns the verbose messages flag. |
String[] | glob_expand(String pattern)
expand a wildcard path
This command searches for all the pathnames matching "pattern" according to the wildcard expansion rules used by the shell. |
String[] | grep(String regex, String path)
return lines matching a pattern
This calls the external "grep" program and returns the matching lines. |
String[] | grepi(String regex, String path)
return lines matching a pattern
This calls the external "grep -i" program and returns the matching lines. |
void | grub_install(String root, String device)
install GRUB
This command installs GRUB (the Grand Unified Bootloader) on "device", with the root directory being "root". |
String[] | head(String path)
return first 10 lines of a file
This command returns up to the first 10 lines of a file as a list of strings. |
String[] | head_n(int nrlines, String path)
return first N lines of a file
If the parameter "nrlines" is a positive number, this returns the first "nrlines" lines of the file "path". |
String | hexdump(String path)
dump a file in hexadecimal
This runs "hexdump -C" on the given "path". |
String | initrd_cat(String initrdpath, String filename)
list the contents of a single file in an initrd
This command unpacks the file "filename" from the initrd file called "initrdpath". |
String[] | initrd_list(String path)
list files in an initrd
This command lists out files contained in an initrd. |
long | inotify_add_watch(String path, int mask)
add an inotify watch
Watch "path" for the events listed in "mask". |
void | inotify_close()
close the inotify handle
This closes the inotify handle which was previously opened by inotify_init. |
String[] | inotify_files()
return list of watched files that had events
This function is a helpful wrapper around "g.inotify_read" which just returns a list of pathnames of objects that were touched. |
void | inotify_init(int maxevents)
create an inotify handle
This command creates a new inotify handle. |
INotifyEvent[] | inotify_read()
return list of inotify events
Return the complete queue of events that have happened since the previous read call. |
void | inotify_rm_watch(int wd)
remove an inotify watch
Remove a previously defined inotify watch. |
boolean | is_busy()
is busy processing a command
This returns true iff this handle is busy processing a command (in the "BUSY" state). |
boolean | is_config()
is in configuration state
This returns true iff this handle is being configured (in the "CONFIG" state). |
boolean | is_dir(String path)
test if file exists
This returns "true" if and only if there is a directory with the given "path" name. |
boolean | is_file(String path)
test if file exists
This returns "true" if and only if there is a file with the given "path" name. |
boolean | is_launching()
is launching subprocess
This returns true iff this handle is launching the subprocess (in the "LAUNCHING" state). |
boolean | is_ready()
is ready to accept commands
This returns true iff this handle is ready to accept commands (in the "READY" state). |
void | kill_subprocess()
kill the qemu subprocess
This kills the qemu subprocess. |
void | launch()
launch the qemu subprocess
Internally libguestfs is implemented by running a virtual machine using qemu(1). |
void | lchown(int owner, int group, String path)
change file owner and group
Change the file owner to "owner" and group to "group". |
XAttr[] | lgetxattrs(String path)
list extended attributes of a file or directory
This is the same as "g.getxattrs", but if "path" is a symbolic link, then it returns the extended attributes of the link itself. |
String[] | list_devices()
list the block devices
List all the block devices. |
String[] | list_partitions()
list the partitions
List all the partitions detected on all block devices. |
String | ll(String directory)
list the files in a directory (long format)
List the files in "directory" (relative to the root directory, there is no cwd) in the format of 'ls -la'. |
void | ln(String target, String linkname)
create a hard link
This command creates a hard link using the "ln" command. |
void | ln_f(String target, String linkname)
create a hard link
This command creates a hard link using the "ln -f" command. |
void | ln_s(String target, String linkname)
create a symbolic link
This command creates a symbolic link using the "ln -s" command. |
void | ln_sf(String target, String linkname)
create a symbolic link
This command creates a symbolic link using the "ln -sf" command, The "-f" option removes the link ("linkname") if it exists already. |
void | lremovexattr(String xattr, String path)
remove extended attribute of a file or directory
This is the same as "g.removexattr", but if "path" is a symbolic link, then it removes an extended attribute of the link itself. |
String[] | ls(String directory)
list the files in a directory
List the files in "directory" (relative to the root directory, there is no cwd). |
void | lsetxattr(String xattr, String val, int vallen, String path)
set extended attribute of a file or directory
This is the same as "g.setxattr", but if "path" is a symbolic link, then it sets an extended attribute of the link itself. |
Stat | lstat(String path)
get file information for a symbolic link
Returns file information for the given "path". |
Stat[] | lstatlist(String path, String[] names)
lstat on multiple files
This call allows you to perform the "g.lstat" operation on multiple files, where all files are in the directory "path". |
void | lvcreate(String logvol, String volgroup, int mbytes)
create an LVM logical volume
This creates an LVM logical volume called "logvol" on the volume group "volgroup", with "size" megabytes. |
void | lvm_remove_all()
remove all LVM LVs, VGs and PVs
This command removes all LVM logical volumes, volume groups and physical volumes. |
void | lvremove(String device)
remove an LVM logical volume
Remove an LVM logical volume "device", where "device" is the path to the LV, such as "/dev/VG/LV". |
void | lvrename(String logvol, String newlogvol)
rename an LVM logical volume
Rename a logical volume "logvol" with the new name "newlogvol". |
void | lvresize(String device, int mbytes)
resize an LVM logical volume
This resizes (expands or shrinks) an existing LVM logical volume to "mbytes". |
String[] | lvs()
list the LVM logical volumes (LVs)
List all the logical volumes detected. |
LV[] | lvs_full()
list the LVM logical volumes (LVs)
List all the logical volumes detected. |
String | lvuuid(String device)
get the UUID of a logical volume
This command returns the UUID of the LVM LV "device". |
XAttr[] | lxattrlist(String path, String[] names)
lgetxattr on multiple files
This call allows you to get the extended attributes of multiple files, where all files are in the directory "path". |
void | mkdir(String path)
create a directory
Create a directory named "path". |
void | mkdir_mode(String path, int mode)
create a directory with a particular mode
This command creates a directory, setting the initial permissions of the directory to "mode". |
void | mkdir_p(String path)
create a directory and parents
Create a directory named "path", creating any parent directories as necessary. |
String | mkdtemp(String template)
create a temporary directory
This command creates a temporary directory. |
void | mke2fs_J(String fstype, int blocksize, String device, String journal)
make ext2/3/4 filesystem with external journal
This creates an ext2/3/4 filesystem on "device" with an external journal on "journal". |
void | mke2fs_JL(String fstype, int blocksize, String device, String label)
make ext2/3/4 filesystem with external journal
This creates an ext2/3/4 filesystem on "device" with an external journal on the journal labeled "label". |
void | mke2fs_JU(String fstype, int blocksize, String device, String uuid)
make ext2/3/4 filesystem with external journal
This creates an ext2/3/4 filesystem on "device" with an external journal on the journal with UUID "uuid". |
void | mke2journal(int blocksize, String device)
make ext2/3/4 external journal
This creates an ext2 external journal on "device". |
void | mke2journal_L(int blocksize, String label, String device)
make ext2/3/4 external journal with label
This creates an ext2 external journal on "device" with label "label". |
void | mke2journal_U(int blocksize, String uuid, String device)
make ext2/3/4 external journal with UUID
This creates an ext2 external journal on "device" with UUID "uuid". |
void | mkfifo(int mode, String path)
make FIFO (named pipe)
This call creates a FIFO (named pipe) called "path" with mode "mode". |
void | mkfs(String fstype, String device)
make a filesystem
This creates a filesystem on "device" (usually a partition or LVM logical volume). |
void | mkfs_b(String fstype, int blocksize, String device)
make a filesystem with block size
This call is similar to "g.mkfs", but it allows you to control the block size of the resulting filesystem. |
void | mkmountpoint(String exemptpath)
create a mountpoint
"g.mkmountpoint" and "g.rmmountpoint" are specialized calls that can be used to create extra mountpoints before mounting the first filesystem. |
void | mknod(int mode, int devmajor, int devminor, String path)
make block, character or FIFO devices
This call creates block or character special devices, or named pipes (FIFOs). |
void | mknod_b(int mode, int devmajor, int devminor, String path)
make block device node
This call creates a block device node called "path" with mode "mode" and device major/minor "devmajor" and "devminor". |
void | mknod_c(int mode, int devmajor, int devminor, String path)
make char device node
This call creates a char device node called "path" with mode "mode" and device major/minor "devmajor" and "devminor". |
void | mkswap(String device)
create a swap partition
Create a swap partition on "device". |
void | mkswap_file(String path)
create a swap file
Create a swap file. |
void | mkswap_L(String label, String device)
create a swap partition with a label
Create a swap partition on "device" with label "label". |
void | mkswap_U(String uuid, String device)
create a swap partition with an explicit UUID
Create a swap partition on "device" with UUID "uuid". |
void | modprobe(String modulename)
load a kernel module
This loads a kernel module in the appliance. |
void | mount(String device, String mountpoint)
mount a guest disk at a position in the filesystem
Mount a guest disk at a position in the filesystem. |
HashMap<String,String> | mountpoints()
show mountpoints
This call is similar to "g.mounts". |
String[] | mounts()
show mounted filesystems
This returns the list of currently mounted filesystems. |
void | mount_loop(String file, String mountpoint)
mount a file using the loop device
This command lets you mount "file" (a filesystem image in a file) on a mount point. |
void | mount_options(String options, String device, String mountpoint)
mount a guest disk with mount options
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. |
void | mount_ro(String device, String mountpoint)
mount a guest disk, read-only
This is the same as the "g.mount" command, but it mounts the filesystem with the read-only (*-o ro*) flag. |
void | mount_vfs(String options, String vfstype, String device, String mountpoint)
mount a guest disk with mount options and vfstype
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. |
void | mv(String src, String dest)
move a file
This moves a file from "src" to "dest" where "dest" is either a destination filename or destination directory. |
int | ntfs_3g_probe(boolean rw, String device)
probe NTFS volume
This command runs the ntfs-3g.probe(8) command which probes an NTFS "device" for mountability. |
void | part_add(String device, String prlogex, long startsect, long endsect)
add a partition to the device
This command adds a partition to "device". |
void | part_del(String device, int partnum)
delete a partition
This command deletes the partition numbered "partnum" on "device". |
void | part_disk(String device, String parttype)
partition whole disk with a single primary partition
This command is simply a combination of "g.part_init" followed by "g.part_add" to create a single primary partition covering the whole disk. |
boolean | part_get_bootable(String device, int partnum)
return true if a partition is bootable
This command returns true if the partition "partnum" on "device" has the bootable flag set. |
int | part_get_mbr_id(String device, int partnum)
get the MBR type byte (ID byte) from a partition
Returns the MBR type byte (also known as the ID byte) from the numbered partition "partnum". |
String | part_get_parttype(String device)
get the partition table type
This command examines the partition table on "device" and returns the partition table type (format) being used. |
void | part_init(String device, String parttype)
create an empty partition table
This creates an empty partition table on "device" of one of the partition types listed below. |
Partition[] | part_list(String device)
list partitions on a device
This command parses the partition table on "device" and returns the list of partitions found. |
void | part_set_bootable(String device, int partnum, boolean bootable)
make a partition bootable
This sets the bootable flag on partition numbered "partnum" on device "device". |
void | part_set_mbr_id(String device, int partnum, int idbyte)
set the MBR type byte (ID byte) of a partition
Sets the MBR type byte (also known as the ID byte) of the numbered partition "partnum" to "idbyte". |
void | part_set_name(String device, int partnum, String name)
set partition name
This sets the partition name on partition numbered "partnum" on device "device". |
void | ping_daemon()
ping the guest daemon
This is a test probe into the guestfs daemon running inside the qemu subprocess. |
String | pread(String path, int count, long offset)
read part of a file
This command lets you read part of a file. |
void | pvcreate(String device)
create an LVM physical volume
This creates an LVM physical volume on the named "device", where "device" should usually be a partition name such as "/dev/sda1". |
void | pvremove(String device)
remove an LVM physical volume
This wipes a physical volume "device" so that LVM will no longer recognise it. |
void | pvresize(String device)
resize an LVM physical volume
This resizes (expands or shrinks) an existing LVM physical volume to match the new size of the underlying device. |
String[] | pvs()
list the LVM physical volumes (PVs)
List all the physical volumes detected. |
PV[] | pvs_full()
list the LVM physical volumes (PVs)
List all the physical volumes detected. |
String | pvuuid(String device)
get the UUID of a physical volume
This command returns the UUID of the LVM PV "device". |
Dirent[] | readdir(String dir)
read directories entries
This returns the list of directory entries in directory "dir". |
String | readlink(String path)
read the target of a symbolic link
This command reads the target of a symbolic link. |
String[] | readlinklist(String path, String[] names)
readlink on multiple files
This call allows you to do a "readlink" operation on multiple files, where all files are in the directory "path". |
String | read_file(String path)
read a file
This calls returns the contents of the file "path" as a buffer. |
String[] | read_lines(String path)
read file as lines
Return the contents of the file named "path". |
String | realpath(String path)
canonicalized absolute pathname
Return the canonicalized absolute pathname of "path". |
void | removexattr(String xattr, String path)
remove extended attribute of a file or directory
This call removes the extended attribute named "xattr" of the file "path". |
void | resize2fs(String device)
resize an ext2/ext3 filesystem
This resizes an ext2 or ext3 filesystem to match the size of the underlying device. |
void | rm(String path)
remove a file
Remove the single file "path". |
void | rmdir(String path)
remove a directory
Remove the single directory "path". |
void | rmmountpoint(String exemptpath)
remove a mountpoint
This calls removes a mountpoint that was previously created with "g.mkmountpoint". |
void | rm_rf(String path)
remove a file or directory recursively
Remove the file or directory "path", recursively removing the contents if its a directory. |
void | scrub_device(String device)
scrub (securely wipe) a device
This command writes patterns over "device" to make data retrieval more difficult. |
void | scrub_file(String file)
scrub (securely wipe) a file
This command writes patterns over a file to make data retrieval more difficult. |
void | scrub_freespace(String dir)
scrub (securely wipe) free space
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. |
void | setcon(String context)
set SELinux security context
This sets the SELinux security context of the daemon to the string "context". |
void | setxattr(String xattr, String val, int vallen, String path)
set extended attribute of a file or directory
This call sets the extended attribute named "xattr" of the file "path" to the value "val" (of length "vallen"). |
void | set_append(String append)
add options to kernel command line
This function is used to add additional options to the guest kernel command line. |
void | set_autosync(boolean autosync)
set autosync mode
If "autosync" is true, this enables autosync. |
void | set_direct(boolean direct)
enable or disable direct appliance mode
If the direct appliance mode flag is enabled, then stdin and stdout are passed directly through to the appliance once it is launched. |
void | set_e2label(String device, String label)
set the ext2/3/4 filesystem label
This sets the ext2/3/4 filesystem label of the filesystem on "device" to "label". |
void | set_e2uuid(String device, String uuid)
set the ext2/3/4 filesystem UUID
This sets the ext2/3/4 filesystem UUID of the filesystem on "device" to "uuid". |
void | set_memsize(int memsize)
set memory allocated to the qemu subprocess
This sets the memory size in megabytes allocated to the qemu subprocess. |
void | set_path(String searchpath)
set the search path
Set the path that libguestfs searches for kernel and initrd.img. |
void | set_qemu(String qemu)
set the qemu binary
Set the qemu binary that we will use. |
void | set_recovery_proc(boolean recoveryproc)
enable or disable the recovery process
If this is called with the parameter "false" then "g.launch" does not create a recovery process. |
void | set_selinux(boolean selinux)
set SELinux enabled or disabled at appliance boot
This sets the selinux flag that is passed to the appliance at boot time. |
void | set_trace(boolean trace)
enable or disable command traces
If the command trace flag is set to 1, then commands are printed on stdout before they are executed in a format which is very similar to the one used by guestfish. |
void | set_verbose(boolean verbose)
set verbose mode
If "verbose" is true, this turns on verbose messages (to "stderr"). |
void | sfdisk(String device, int cyls, int heads, int sectors, String[] lines)
create partitions on a block device
This is a direct interface to the sfdisk(8) program for creating partitions on block devices. |
void | sfdiskM(String device, String[] lines)
create partitions on a block device
This is a simplified interface to the "g.sfdisk" command, where partition sizes are specified in megabytes only (rounded to the nearest cylinder) and you don't need to specify the cyls, heads and sectors parameters which were rarely if ever used anyway. |
String | sfdisk_disk_geometry(String device)
display the disk geometry from the partition table
This displays the disk geometry of "device" read from the partition table. |
String | sfdisk_kernel_geometry(String device)
display the kernel geometry
This displays the kernel's idea of the geometry of "device". |
String | sfdisk_l(String device)
display the partition table
This displays the partition table on "device", in the human-readable output of the sfdisk(8) command. |
void | sfdisk_N(String device, int partnum, int cyls, int heads, int sectors, String line)
modify a single partition on a block device
This runs sfdisk(8) option to modify just the single partition "n" (note: "n" counts from 1). |
String | sh(String command)
run a command via the shell
This call runs a command from the guest filesystem via the guest's "/bin/sh". |
String[] | sh_lines(String command)
run a command via the shell returning lines
This is the same as "g.sh", but splits the result into a list of lines. |
void | sleep(int secs)
sleep for some seconds
Sleep for "secs" seconds. |
Stat | stat(String path)
get file information
Returns file information for the given "path". |
StatVFS | statvfs(String path)
get file system statistics
Returns file system statistics for any mounted file system. |
String[] | strings(String path)
print the printable strings in a file
This runs the strings(1) command on a file and returns the list of printable strings found. |
String[] | strings_e(String encoding, String path)
print the printable strings in a file
This is like the "g.strings" command, but allows you to specify the encoding of strings that are looked for in the source file "path". |
void | swapoff_device(String device)
disable swap on device
This command disables the libguestfs appliance swap device or partition named "device". |
void | swapoff_file(String file)
disable swap on file
This command disables the libguestfs appliance swap on file. |
void | swapoff_label(String label)
disable swap on labeled swap partition
This command disables the libguestfs appliance swap on labeled swap partition. |
void | swapoff_uuid(String uuid)
disable swap on swap partition by UUID
This command disables the libguestfs appliance swap partition with the given UUID. |
void | swapon_device(String device)
enable swap on device
This command enables the libguestfs appliance to use the swap device or partition named "device". |
void | swapon_file(String file)
enable swap on file
This command enables swap to a file. |
void | swapon_label(String label)
enable swap on labeled swap partition
This command enables swap to a labeled swap partition. |
void | swapon_uuid(String uuid)
enable swap on swap partition by UUID
This command enables swap to a swap partition with the given UUID. |
void | sync()
sync disks, writes are flushed through to the disk image
This syncs the disk, so that any writes are flushed through to the underlying disk image. |
String[] | tail(String path)
return last 10 lines of a file
This command returns up to the last 10 lines of a file as a list of strings. |
String[] | tail_n(int nrlines, String path)
return last N lines of a file
If the parameter "nrlines" is a positive number, this returns the last "nrlines" lines of the file "path". |
void | tar_in(String tarfile, String directory)
unpack tarfile to directory
This command uploads and unpacks local file "tarfile" (an *uncompressed* tar file) into "directory". |
void | tar_out(String directory, String tarfile)
pack directory into tarfile
This command packs the contents of "directory" and downloads it to local file "tarfile". |
void | test0(String str, String optstr, String[] strlist, boolean b, int integer, long integer64, String filein, String fileout) |
boolean | test0rbool(String val) |
boolean | test0rboolerr() |
String | test0rconstoptstring(String val) |
String | test0rconstoptstringerr() |
String | test0rconststring(String val) |
String | test0rconststringerr() |
HashMap<String,String> | test0rhashtable(String val) |
HashMap<String,String> | test0rhashtableerr() |
int | test0rint(String val) |
long | test0rint64(String val) |
long | test0rint64err() |
int | test0rinterr() |
String | test0rstring(String val) |
String | test0rstringerr() |
String[] | test0rstringlist(String val) |
String[] | test0rstringlisterr() |
PV | test0rstruct(String val) |
PV | test0rstructerr() |
PV[] | test0rstructlist(String val) |
PV[] | test0rstructlisterr() |
void | tgz_in(String tarball, String directory)
unpack compressed tarball to directory
This command uploads and unpacks local file "tarball" (a *gzip compressed* tar file) into "directory". |
void | tgz_out(String directory, String tarball)
pack directory into compressed tarball
This command packs the contents of "directory" and downloads it to local file "tarball". |
void | touch(String path)
update file timestamps or create a new file
Touch acts like the touch(1) command. |
void | truncate(String path)
truncate a file to zero size
This command truncates "path" to a zero-length file. |
void | truncate_size(String path, long size)
truncate a file to a particular size
This command truncates "path" to size "size" bytes. |
HashMap<String,String> | tune2fs_l(String device)
get ext2/ext3/ext4 superblock details
This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "device". |
int | umask(int mask)
set file mode creation mask (umask)
This function sets the mask used for creating new files and device nodes to "mask & 0777". |
void | umount(String pathordevice)
unmount a filesystem
This unmounts the given filesystem. |
void | umount_all()
unmount all filesystems
This unmounts all mounted filesystems. |
void | upload(String filename, String remotefilename)
upload a file from the local machine
Upload local file "filename" to "remotefilename" on the filesystem. |
void | utimens(String path, long atsecs, long atnsecs, long mtsecs, long mtnsecs)
set timestamp of a file with nanosecond precision
This command sets the timestamps of a file with nanosecond precision. |
Version | version()
get the library version number
Return the libguestfs version number that the program is linked against. |
String | vfs_type(String device)
get the Linux VFS type corresponding to a mounted device
This command gets the block device type corresponding to a mounted device called "device". |
void | vgcreate(String volgroup, String[] physvols)
create an LVM volume group
This creates an LVM volume group called "volgroup" from the non-empty list of physical volumes "physvols". |
String[] | vglvuuids(String vgname)
get the LV UUIDs of all LVs in the volume group
Given a VG called "vgname", this returns the UUIDs of all the logical volumes created in this volume group. |
String[] | vgpvuuids(String vgname)
get the PV UUIDs containing the volume group
Given a VG called "vgname", this returns the UUIDs of all the physical volumes that this volume group resides on. |
void | vgremove(String vgname)
remove an LVM volume group
Remove an LVM volume group "vgname", (for example "VG"). |
void | vgrename(String volgroup, String newvolgroup)
rename an LVM volume group
Rename a volume group "volgroup" with the new name "newvolgroup". |
String[] | vgs()
list the LVM volume groups (VGs)
List all the volumes groups detected. |
VG[] | vgs_full()
list the LVM volume groups (VGs)
List all the volumes groups detected. |
String | vguuid(String vgname)
get the UUID of a volume group
This command returns the UUID of the LVM VG named "vgname". |
void | vg_activate(boolean activate, String[] volgroups)
activate or deactivate some volume groups
This command activates or (if "activate" is false) deactivates all logical volumes in the listed volume groups "volgroups". |
void | vg_activate_all(boolean activate)
activate or deactivate all volume groups
This command activates or (if "activate" is false) deactivates all logical volumes in all volume groups. |
void | wait_ready()
wait until the qemu subprocess launches (no op)
This function is a no op. |
int | wc_c(String path)
count characters in a file
This command counts the characters in a file, using the "wc -c" external command. |
int | wc_l(String path)
count lines in a file
This command counts the lines in a file, using the "wc -l" external command. |
int | wc_w(String path)
count words in a file
This command counts the words in a file, using the "wc -w" external command. |
void | write_file(String path, String content, int size)
create a file
This call creates a file called "path". |
String[] | zegrep(String regex, String path)
return lines matching a pattern
This calls the external "zegrep" program and returns the matching lines. |
String[] | zegrepi(String regex, String path)
return lines matching a pattern
This calls the external "zegrep -i" program and returns the matching lines. |
void | zero(String device)
write zeroes to the device
This command writes zeroes over the first few blocks of "device". |
void | zerofree(String device)
zero unused inodes and disk blocks on ext2/3 filesystem
This runs the *zerofree* program on "device". |
String[] | zfgrep(String pattern, String path)
return lines matching a pattern
This calls the external "zfgrep" program and returns the matching lines. |
String[] | zfgrepi(String pattern, String path)
return lines matching a pattern
This calls the external "zfgrep -i" program and returns the matching lines. |
String | zfile(String meth, String path)
determine file type inside a compressed file
This command runs "file" after first decompressing "path" using "method". |
String[] | zgrep(String regex, String path)
return lines matching a pattern
This calls the external "zgrep" program and returns the matching lines. |
String[] | zgrepi(String regex, String path)
return lines matching a pattern
This calls the external "zgrep -i" program and returns the matching lines. |
Throws: LibGuestFSException
This function adds a virtual CD-ROM disk image to the guest.
This is equivalent to the qemu parameter "-cdrom filename".
Notes:
* This call checks for the existence of "filename". This stops you from specifying other types of drive which are supported by qemu such as "nbd:" and "http:" URLs. To specify those, use the general "g.config" call instead.
* If you just want to add an ISO file (often you use this as an efficient way to transfer large files into the guest), then you should probably use "g.add_drive_ro" instead.
Throws: LibGuestFSException
This function adds a virtual machine disk image "filename" to the guest. The first time you call this function, the disk appears as IDE disk 0 ("/dev/sda") in the guest, the second time as "/dev/sdb", and so on.
You don't necessarily need to be root when using libguestfs. However you obviously do need sufficient permissions to access the filename for whatever operations you want to perform (ie. read access if you just want to read the image or write access if you want to modify the image).
This is equivalent to the qemu parameter "-drive file=filename,cache=off,if=...".
"cache=off" is omitted in cases where it is not supported by the underlying filesystem.
"if=..." is set at compile time by the configuration option "./configure --with-drive-if=...". In the rare case where you might need to change this at run time, use "g.add_drive_with_if" or "g.add_drive_ro_with_if".
Note that this call checks for the existence of "filename". This stops you from specifying other types of drive which are supported by qemu such as "nbd:" and "http:" URLs. To specify those, use the general "g.config" call instead.
Throws: LibGuestFSException
This adds a drive in snapshot mode, making it effectively read-only.
Note that writes to the device are allowed, and will be seen for the duration of the guestfs handle, but they are written to a temporary file which is discarded as soon as the guestfs handle is closed. We don't currently have any method to enable changes to be committed, although qemu can support this.
This is equivalent to the qemu parameter "-drive file=filename,snapshot=on,readonly=on,if=...".
"if=..." is set at compile time by the configuration option "./configure --with-drive-if=...". In the rare case where you might need to change this at run time, use "g.add_drive_with_if" or "g.add_drive_ro_with_if".
"readonly=on" is only added where qemu supports this option.
Note that this call checks for the existence of "filename". This stops you from specifying other types of drive which are supported by qemu such as "nbd:" and "http:" URLs. To specify those, use the general "g.config" call instead.
Throws: LibGuestFSException
This is the same as "g.add_drive_ro" but it allows you to specify the QEMU interface emulation to use at run time.
Throws: LibGuestFSException
This is the same as "g.add_drive" but it allows you to specify the QEMU interface emulation to use at run time.
Throws: LibGuestFSException
Set the value associated with "path" to "NULL". This is the same as the augtool(1) "clear" command.
Throws: LibGuestFSException
Close the current Augeas handle and free up any resources used by it. After calling this, you have to call "g.aug_init" again before you can use any other Augeas functions.
Throws: LibGuestFSException
Defines a variable "name" whose value is the result of evaluating "expr".
If "expr" evaluates to an empty nodeset, a node is created, equivalent to calling "g.aug_set" "expr", "value". "name" will be the nodeset containing that single node.
On success this returns a pair containing the number of nodes in the nodeset, and a boolean flag if a node was created.
Throws: LibGuestFSException
Defines an Augeas variable "name" whose value is the result of evaluating "expr". If "expr" is NULL, then "name" is undefined.
On success this returns the number of nodes in "expr", or 0 if "expr" evaluates to something which is not a nodeset.
Throws: LibGuestFSException
Look up the value associated with "path". If "path" matches exactly one node, the "value" is returned.
Throws: LibGuestFSException
Create a new Augeas handle for editing configuration files. If there was any previous Augeas handle associated with this guestfs session, then it is closed.
You must call this before using any other "g.aug_*" commands.
"root" is the filesystem root. "root" must not be NULL, use "/" instead.
The flags are the same as the flags defined in
"AUG_SAVE_BACKUP" = 1
Keep the original file with a ".augsave" extension.
"AUG_SAVE_NEWFILE" = 2
Save changes into a file with extension ".augnew",
and do not overwrite original. Overrides
"AUG_SAVE_BACKUP".
"AUG_TYPE_CHECK" = 4
Typecheck lenses (can be expensive).
"AUG_NO_STDINC" = 8
Do not use standard load path for modules.
"AUG_SAVE_NOOP" = 16
Make save a no-op, just record what would have been
changed.
"AUG_NO_LOAD" = 32
Do not load the tree in "g.aug_init".
To close the handle, you can call "g.aug_close".
To find out more about Augeas, see Throws: LibGuestFSException
Create a new sibling "label" for "path", inserting it into the tree before or after "path" (depending on the boolean flag "before").
"path" must match exactly one existing node in the tree, and "label" must be a label, ie. not contain "/", "*" or end with a bracketed index "[N]".
Throws: LibGuestFSException
Load files into the tree.
See "aug_load" in the Augeas documentation for the full gory details.
Throws: LibGuestFSException
This is just a shortcut for listing "g.aug_match" "path/*" and sorting the resulting nodes into alphabetical order.
Throws: LibGuestFSException
Returns a list of paths which match the path expression "path". The returned paths are sufficiently qualified so that they match exactly one node in the current tree.
Throws: LibGuestFSException
Move the node "src" to "dest". "src" must match exactly one node. "dest" is overwritten if it exists.
Throws: LibGuestFSException
Remove "path" and all of its children.
On success this returns the number of entries which were removed.
Throws: LibGuestFSException
This writes all pending changes to disk.
The flags which were passed to "g.aug_init" affect exactly how files are saved.
Throws: LibGuestFSException
Set the value associated with "path" to "val".
In the Augeas API, it is possible to clear a node by setting the value to NULL. Due to an oversight in the libguestfs API you cannot do that with this call. Instead you must use the "g.aug_clear" call.
Throws: LibGuestFSException
This command is used to check the availability of some groups of functionality in the appliance, which not all builds of the libguestfs appliance will be able to provide.
The libguestfs groups, and the functions that those groups correspond to, are listed in "AVAILABILITY" in guestfs(3).
The argument "groups" is a list of group names, eg: "["inotify", "augeas"]" would check for the availability of the Linux inotify functions and Augeas (configuration file editing) functions.
The command returns no error if *all* requested groups are available.
It fails with an error if one or more of the requested groups is unavailable in the appliance.
If an unknown group name is included in the list of groups then an error is always returned.
*Notes:*
* You must call "g.launch" before calling this function.
The reason is because we don't know what groups are supported by the appliance/daemon until it is running and can be queried.
* If a group of functions is available, this does not necessarily mean that they will work. You still have to check for errors when calling individual API functions even if they are available.
* It is usually the job of distro packagers to build complete functionality into the libguestfs appliance. Upstream libguestfs, if built from source with all requirements satisfied, will support everything.
* This call was added in version 1.0.80. In previous versions of libguestfs all you could do would be to speculatively execute a command to find out if the daemon implemented it. See also "g.version".
Throws: LibGuestFSException
This tells the kernel to flush internal buffers associated with "device".
This uses the blockdev(8) command.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
Returns a boolean indicating if the block device is read-only (true if read-only, false if not).
This uses the blockdev(8) command.
Throws: LibGuestFSException
This returns the size of the device in bytes.
See also "g.blockdev_getsz".
This uses the blockdev(8) command.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
Reread the partition table on "device".
This uses the blockdev(8) command.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
Sets the block device named "device" to read-only.
This uses the blockdev(8) command.
Throws: LibGuestFSException
Sets the block device named "device" to read-write.
This uses the blockdev(8) command.
Throws: LibGuestFSException
This can be used to resolve case insensitive paths on a filesystem which is case sensitive. The use case is to resolve paths which you have read from Windows configuration files or the Windows Registry, to the true path.
The command handles a peculiarity of the Linux ntfs-3g filesystem driver (and probably others), which is that although the underlying filesystem is case-insensitive, the driver exports the filesystem to Linux as case-sensitive.
One consequence of this is that special directories such as "c:\windows" may appear as "/WINDOWS" or "/windows" (or other things) depending on the precise details of how they were created. In Windows itself this would not be a problem.
Bug or feature? You decide:
This function resolves the true case of each element in
the path and returns the case-sensitive path.
Thus "g.case_sensitive_path" ("/Windows/System32") might
return "/WINDOWS/system32" (the exact return value would
depend on details of how the directories were originally
created under Windows).
*Note*: This function does not handle drive names,
backslashes etc.
See also "g.realpath".
Throws: LibGuestFSException
Return the contents of the file named "path".
Note that this function cannot correctly handle binary files (specifically, files containing "\0" character which is treated as end of string). For those you need to use the "g.read_file" or "g.download" functions which have a more complex interface.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
Change the mode (permissions) of "path" to "mode". Only numeric modes are supported.
*Note*: When using this command from guestfish, "mode" by default would be decimal, unless you prefix it with 0 to get octal, ie. use 0700 not 700.
The mode actually set is affected by the umask.
Throws: LibGuestFSException
Change the file owner to "owner" and group to "group".
Only numeric uid and gid are supported. If you want to use names, you will need to locate and parse the password file yourself (Augeas support makes this relatively easy).
Throws: LibGuestFSException
Throws: LibGuestFSException
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). Note that the command runs directly, and is *not* invoked via the shell (see "g.sh").
The return value is anything printed to *stdout* by the command.
If the command returns a non-zero exit status, then this function returns an error message. The error message string is the content of *stderr* from the command.
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.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
This is the same as "g.command", but splits the result into a list of lines.
See also: "g.sh_lines"
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
This can be used to add arbitrary qemu command line parameters of the form "-param value". Actually it's not quite arbitrary - we prevent you from setting some parameters which would interfere with parameters that we use.
The first character of "param" string must be a "-" (dash).
"value" can be NULL.
Throws: LibGuestFSException
This command copies exactly "size" bytes from one source device or file "src" to another destination device or file "dest".
Note this will fail if the source is too short or if the destination is not large enough.
Throws: LibGuestFSException
This copies a file from "src" to "dest" where "dest" is either a destination filename or destination directory.
Throws: LibGuestFSException
This copies a file or directory from "src" to "dest" recursively using the "cp -a" command.
Throws: LibGuestFSException
This command copies from one source device or file "src" to another destination device or file "dest". Normally you would use this to copy to or from a device or partition, for example to duplicate a filesystem.
If the destination is a device, it must be as large or larger than the source file or device, otherwise the copy will fail. This command cannot do partial copies (see "g.copy_size").
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
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".
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
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).
Throws: LibGuestFSException
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".
Throws: LibGuestFSException
This command concatenate the list of "words" passed with single spaces between them and returns the resulting string.
You can use this command to test the connection through to the daemon.
See also "g.ping_daemon".
Throws: LibGuestFSException
This calls the external "egrep" program and returns the matching lines.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
This calls the external "egrep -i" program and returns the matching lines.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
This returns "true" if and only if there is a file, directory (or anything) with the given "path" name.
See also "g.is_file", "g.is_dir", "g.stat".
Throws: LibGuestFSException
This command preallocates a file (containing zero bytes) named "path" of size "len" bytes. If the file exists already, it is overwritten.
Do not confuse this with the guestfish-specific "alloc" command which allocates a file in the host and attaches it as a device.
Throws: LibGuestFSException
This calls the external "fgrep" program and returns the matching lines.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
This calls the external "fgrep -i" program and returns the matching lines.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
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.
This call will also transparently look inside various types of compressed file.
The exact command which runs is "file -zbsL path". Note in particular that the filename is not prepended to the output (the "-b" option).
Throws: LibGuestFSException
This command returns the size of "file" in bytes.
To get other stats about a file, use "g.stat", "g.lstat", "g.is_dir", "g.is_file" etc. To get the size of block devices, use "g.blockdev_getsize64".
Throws: LibGuestFSException
This command creates a new file called "path". The initial content of the file is "len" octets of "c", where "c" must be a number in the range "[0..255]".
To fill a file with zero bytes (sparsely), it is much more efficient to use "g.truncate_size".
Throws: LibGuestFSException
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.
See also "g.find0".
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
This command lists out all files and directories, recursively, starting at "directory", placing the resulting list in the external file called "files".
This command works the same way as "g.find" with the following exceptions:
* The resulting list is written to an external file.
* Items (filenames) in the result are separated by "\0" characters. See find(1) option *-print0*.
* This command is not limited in the number of names that it can return.
* The result list is not sorted.
Throws: LibGuestFSException
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".
Throws: LibGuestFSException
This gets the SELinux security context of the daemon.
See the documentation about SELINUX in guestfs(3), and "g.setcon"
Throws: LibGuestFSException
This call lists the extended attributes of the file or directory "path".
At the system call level, this is a combination of the listxattr(2) and getxattr(2) calls.
See also: "g.lgetxattrs", attr(5).
Throws: LibGuestFSException
Return the additional kernel options which are added to the guest kernel command line.
If "NULL" then no options are added.
Throws: LibGuestFSException
Get the autosync flag.
Throws: LibGuestFSException
Return the direct appliance mode flag.
Throws: LibGuestFSException
This returns the ext2/3/4 filesystem label of the filesystem on "device".
Throws: LibGuestFSException
This returns the ext2/3/4 filesystem UUID of the filesystem on "device".
Throws: LibGuestFSException
This gets the memory size in megabytes allocated to the qemu subprocess.
If "g.set_memsize" was not called on this handle, and if "LIBGUESTFS_MEMSIZE" was not set, then this returns the compiled-in default value for memsize.
For more information on the architecture of libguestfs, see guestfs(3).
Throws: LibGuestFSException
Return the current search path.
This is always non-NULL. If it wasn't set already, then this will return the default path.
Throws: LibGuestFSException
Return the process ID of the qemu subprocess. If there is no qemu subprocess, then this will return an error.
This is an internal call used for debugging and testing.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
Return the recovery process enabled flag.
Throws: LibGuestFSException
This returns the current setting of the selinux flag which is passed to the appliance at boot time. See "g.set_selinux".
For more information on the architecture of libguestfs, see guestfs(3).
Throws: LibGuestFSException
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 guestfs(3).
Throws: LibGuestFSException
Return the command trace flag.
Throws: LibGuestFSException
This returns the verbose messages flag.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
This calls the external "grep" program and returns the matching lines.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
This calls the external "grep -i" program and returns the matching lines.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
This command installs GRUB (the Grand Unified Bootloader) on "device", with the root directory being "root".
Throws: LibGuestFSException
This command returns up to the first 10 lines of a file as a list of strings.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
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.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
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. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
This command unpacks the file "filename" from the initrd file called "initrdpath". The filename must be given *without* the initial "/" character.
For example, in guestfish you could use the following command to examine the boot script (usually called "/init") contained in a Linux initrd or initramfs image:
initrd-cat /boot/initrd-
See also "g.initrd_list".
Because of the message protocol, there is a transfer
limit of somewhere between 2MB and 4MB. See "PROTOCOL
LIMITS" in guestfs(3).
Throws: LibGuestFSException
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).
Throws: LibGuestFSException
Watch "path" for the events listed in "mask".
Note that if "path" is a directory then events within that directory are watched, but this does *not* happen recursively (in subdirectories).
Note for non-C or non-Linux callers: the inotify events are defined by the Linux kernel ABI and are listed in "/usr/include/sys/inotify.h".
Throws: LibGuestFSException
This closes the inotify handle which was previously opened by inotify_init. It removes all watches, throws away any pending events, and deallocates all resources.
Throws: LibGuestFSException
This function is a helpful wrapper around "g.inotify_read" which just returns a list of pathnames of objects that were touched. The returned pathnames are sorted and deduplicated.
Throws: LibGuestFSException
This command creates a new inotify handle. The inotify subsystem can be used to notify events which happen to objects in the guest filesystem.
"maxevents" is the maximum number of events which will be queued up between calls to "g.inotify_read" or "g.inotify_files". If this is passed as 0, then the kernel (or previously set) default is used. For Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel throws away events, but records the fact that it threw them away by setting a flag "IN_Q_OVERFLOW" in the returned structure list (see "g.inotify_read").
Before any events are generated, you have to add some watches to the internal watch list. See: "g.inotify_add_watch", "g.inotify_rm_watch" and "g.inotify_watch_all".
Queued up events should be read periodically by calling "g.inotify_read" (or "g.inotify_files" which is just a helpful wrapper around "g.inotify_read"). If you don't read the events out often enough then you risk the internal queue overflowing.
The handle should be closed after use by calling "g.inotify_close". This also removes any watches automatically.
See also inotify(7) for an overview of the inotify interface as exposed by the Linux kernel, which is roughly what we expose via libguestfs. Note that there is one global inotify handle per libguestfs instance.
Throws: LibGuestFSException
Return the complete queue of events that have happened since the previous read call.
If no events have happened, this returns an empty list.
*Note*: In order to make sure that all events have been read, you must call this function repeatedly until it returns an empty list. The reason is that the call will read events up to the maximum appliance-to-host message size and leave remaining events in the queue.
Throws: LibGuestFSException
Remove a previously defined inotify watch. See "g.inotify_add_watch".
Throws: LibGuestFSException
This returns true iff this handle is busy processing a command (in the "BUSY" state).
For more information on states, see guestfs(3).
Throws: LibGuestFSException
This returns true iff this handle is being configured (in the "CONFIG" state).
For more information on states, see guestfs(3).
Throws: LibGuestFSException
This returns "true" if and only if there is a directory with the given "path" name. Note that it returns false for other objects like files.
See also "g.stat".
Throws: LibGuestFSException
This returns "true" if and only if there is a file with the given "path" name. Note that it returns false for other objects like directories.
See also "g.stat".
Throws: LibGuestFSException
This returns true iff this handle is launching the subprocess (in the "LAUNCHING" state).
For more information on states, see guestfs(3).
Throws: LibGuestFSException
This returns true iff this handle is ready to accept commands (in the "READY" state).
For more information on states, see guestfs(3).
Throws: LibGuestFSException
This kills the qemu subprocess. You should never need to call this.
Throws: LibGuestFSException
Internally libguestfs is implemented by running a virtual machine using qemu(1).
You should call this after configuring the handle (eg. adding drives) but before performing any actions.
Throws: LibGuestFSException
Change the file owner to "owner" and group to "group". This is like "g.chown" but if "path" is a symlink then the link itself is changed, not the target.
Only numeric uid and gid are supported. If you want to use names, you will need to locate and parse the password file yourself (Augeas support makes this relatively easy).
Throws: LibGuestFSException
This is the same as "g.getxattrs", but if "path" is a symbolic link, then it returns the extended attributes of the link itself.
Throws: LibGuestFSException
List all the block devices.
The full block device names are returned, eg. "/dev/sda"
Throws: LibGuestFSException
List all the partitions detected on all block devices.
The full partition device names are returned, eg. "/dev/sda1"
This does not return logical volumes. For that you will need to call "g.lvs".
Throws: LibGuestFSException
List the files in "directory" (relative to the root directory, there is no cwd) in the format of 'ls -la'.
This command is mostly useful for interactive sessions. It is *not* intended that you try to parse the output string.
Throws: LibGuestFSException
This command creates a hard link using the "ln" command.
Throws: LibGuestFSException
This command creates a hard link using the "ln -f" command. The "-f" option removes the link ("linkname") if it exists already.
Throws: LibGuestFSException
This command creates a symbolic link using the "ln -s" command.
Throws: LibGuestFSException
This command creates a symbolic link using the "ln -sf" command, The "-f" option removes the link ("linkname") if it exists already.
Throws: LibGuestFSException
This is the same as "g.removexattr", but if "path" is a symbolic link, then it removes an extended attribute of the link itself.
Throws: LibGuestFSException
List the files in "directory" (relative to the root directory, there is no cwd). The '.' and '..' entries are not returned, but hidden files are shown.
This command is mostly useful for interactive sessions. Programs should probably use "g.readdir" instead.
Throws: LibGuestFSException
This is the same as "g.setxattr", but if "path" is a symbolic link, then it sets an extended attribute of the link itself.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
This call allows you to perform the "g.lstat" operation on multiple files, where all files are in the directory "path". "names" is the list of files from this directory.
On return you get a list of stat structs, with a one-to-one correspondence to the "names" list. If any name did not exist or could not be lstat'd, then the "ino" field of that structure is set to -1.
This call is intended for programs that want to efficiently list a directory contents without making many round-trips. See also "g.lxattrlist" for a similarly efficient call for getting extended attributes. Very long directory listings might cause the protocol message size to be exceeded, causing this call to fail. The caller must split up such requests into smaller groups of names.
Throws: LibGuestFSException
This creates an LVM logical volume called "logvol" on the volume group "volgroup", with "size" megabytes.
Throws: LibGuestFSException
This command removes all LVM logical volumes, volume groups and physical volumes.
This command is dangerous. Without careful use you can easily destroy all your data.
Throws: LibGuestFSException
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".
Throws: LibGuestFSException
Rename a logical volume "logvol" with the new name "newlogvol".
Throws: LibGuestFSException
This resizes (expands or shrinks) an existing LVM logical volume to "mbytes". When reducing, data in the reduced part is lost.
Throws: LibGuestFSException
List all the logical volumes detected. This is the equivalent of the lvs(8) command.
This returns a list of the logical volume device names (eg. "/dev/VolGroup00/LogVol00").
See also "g.lvs_full".
Throws: LibGuestFSException
List all the logical volumes detected. This is the equivalent of the lvs(8) command. The "full" version includes all fields.
Throws: LibGuestFSException
This command returns the UUID of the LVM LV "device".
Throws: LibGuestFSException
This call allows you to get the extended attributes of multiple files, where all files are in the directory "path". "names" is the list of files from this directory.
On return you get a flat list of xattr structs which must be interpreted sequentially. The first xattr struct always has a zero-length "attrname". "attrval" in this struct is zero-length to indicate there was an error doing "lgetxattr" for this file, *or* is a C string which is a decimal number (the number of following attributes for this file, which could be "0"). Then after the first xattr struct are the zero or more attributes for the first named file. This repeats for the second and subsequent files.
This call is intended for programs that want to efficiently list a directory contents without making many round-trips. See also "g.lstatlist" for a similarly efficient call for getting standard stats. Very long directory listings might cause the protocol message size to be exceeded, causing this call to fail. The caller must split up such requests into smaller groups of names.
Throws: LibGuestFSException
Create a directory named "path".
Throws: LibGuestFSException
This command creates a directory, setting the initial permissions of the directory to "mode".
For common Linux filesystems, the actual mode which is set will be "mode & ~umask & 01777". Non-native-Linux filesystems may interpret the mode in other ways.
See also "g.mkdir", "g.umask"
Throws: LibGuestFSException
Create a directory named "path", creating any parent directories as necessary. This is like the "mkdir -p" shell command.
Throws: LibGuestFSException
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)
Throws: LibGuestFSException
This creates an ext2/3/4 filesystem on "device" with an external journal on "journal". It is equivalent to the command:
mke2fs -t fstype -b blocksize -J device=
See also "g.mke2journal".
Throws: LibGuestFSException
This creates an ext2/3/4 filesystem on "device" with an external journal on the journal labeled "label".
See also "g.mke2journal_L".
Throws: LibGuestFSException
This creates an ext2/3/4 filesystem on "device" with an external journal on the journal with UUID "uuid".
See also "g.mke2journal_U".
Throws: LibGuestFSException
This creates an ext2 external journal on "device". It is equivalent to the command:
mke2fs -O journal_dev -b blocksize device
Throws: LibGuestFSException
This creates an ext2 external journal on "device" with label "label".
Throws: LibGuestFSException
This creates an ext2 external journal on "device" with UUID "uuid".
Throws: LibGuestFSException
This call creates a FIFO (named pipe) called "path" with mode "mode". It is just a convenient wrapper around "g.mknod".
The mode actually set is affected by the umask.
Throws: LibGuestFSException
This creates a filesystem on "device" (usually a partition or LVM logical volume). The filesystem type is "fstype", for example "ext3".
Throws: LibGuestFSException
This call is similar to "g.mkfs", but it allows you to control the block size of the resulting filesystem. Supported block sizes depend on the filesystem type, but typically they are 1024, 2048 or 4096 only.
Throws: LibGuestFSException
"g.mkmountpoint" and "g.rmmountpoint" are specialized calls that can be used to create extra mountpoints before mounting the first filesystem.
These calls are *only* necessary in some very limited circumstances, mainly the case where you want to mount a mix of unrelated and/or read-only filesystems together.
For example, live CDs often contain a "Russian doll" nest of filesystems, an ISO outer layer, with a squashfs image inside, with an ext2/3 image inside that. You can unpack this as follows in guestfish:
add-ro Fedora-11-i686-Live.iso run mkmountpoint /cd mkmountpoint /squash mkmountpoint /ext3 mount /dev/sda /cd mount-loop /cd/LiveOS/squashfs.img /squash mount-loop /squash/LiveOS/ext3fs.img /ext3
The inner filesystem is now unpacked under the /ext3 mountpoint.
Throws: LibGuestFSException
This call creates block or character special devices, or named pipes (FIFOs).
The "mode" parameter should be the mode, using the standard constants. "devmajor" and "devminor" are the device major and minor numbers, only used when creating block and character special devices.
Note that, just like mknod(2), the mode must be bitwise OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a regular file). These constants are available in the standard Linux header files, or you can use "g.mknod_b", "g.mknod_c" or "g.mkfifo" which are wrappers around this command which bitwise OR in the appropriate constant for you.
The mode actually set is affected by the umask.
Throws: LibGuestFSException
This call creates a block device node called "path" with mode "mode" and device major/minor "devmajor" and "devminor". It is just a convenient wrapper around "g.mknod".
The mode actually set is affected by the umask.
Throws: LibGuestFSException
This call creates a char device node called "path" with mode "mode" and device major/minor "devmajor" and "devminor". It is just a convenient wrapper around "g.mknod".
The mode actually set is affected by the umask.
Throws: LibGuestFSException
Create a swap partition on "device".
Throws: LibGuestFSException
Create a swap file.
This command just writes a swap file signature to an existing file. To create the file itself, use something like "g.fallocate".
Throws: LibGuestFSException
Create a swap partition on "device" with label "label".
Note that you cannot attach a swap label to a block device (eg. "/dev/sda"), just to a partition. This appears to be a limitation of the kernel or swap tools.
Throws: LibGuestFSException
Create a swap partition on "device" with UUID "uuid".
Throws: LibGuestFSException
This loads a kernel module in the appliance.
The kernel module must have been whitelisted when libguestfs was built (see "appliance/kmod.whitelist.in" in the source).
Throws: LibGuestFSException
Mount a guest disk at a position in the filesystem. Block devices are named "/dev/sda", "/dev/sdb" and so on, as they were added to the guest. If those block devices contain partitions, they will have the usual names (eg. "/dev/sda1"). Also LVM "/dev/VG/LV"-style names can be used.
The rules are the same as for mount(2): A filesystem must first be mounted on "/" before others can be mounted. Other filesystems can only be mounted on directories which already exist.
The mounted filesystem is writable, if we have sufficient permissions on the underlying device.
Important note: When you use this call, the filesystem options "sync" and "noatime" are set implicitly. This was originally done because we thought it would improve reliability, but it turns out that *-o sync* has a very large negative performance impact and negligible effect on reliability. Therefore we recommend that you avoid using "g.mount" in any code that needs performance, and instead use "g.mount_options" (use an empty string for the first parameter if you don't want any options).
Throws: LibGuestFSException
This call is similar to "g.mounts". That call returns a list of devices. This one returns a hash table (map) of device name to directory where the device is mounted.
Throws: LibGuestFSException
This returns the list of currently mounted filesystems. It returns the list of devices (eg. "/dev/sda1", "/dev/VG/LV").
Some internal mounts are not shown.
See also: "g.mountpoints"
Throws: LibGuestFSException
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".
Throws: LibGuestFSException
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.
If the "options" parameter is an empty string, then no options are passed (all options default to whatever the filesystem uses).
Throws: LibGuestFSException
This is the same as the "g.mount" command, but it mounts the filesystem with the read-only (*-o ro*) flag.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
This moves a file from "src" to "dest" where "dest" is either a destination filename or destination directory.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
This command adds a partition to "device". If there is no partition table on the device, call "g.part_init" first.
The "prlogex" parameter is the type of partition. Normally you should pass "p" or "primary" here, but MBR partition tables also support "l" (or "logical") and "e" (or "extended") partition types.
"startsect" and "endsect" are the start and end of the partition in *sectors*. "endsect" may be negative, which means it counts backwards from the end of the disk (-1 is the last sector).
Creating a partition which covers the whole disk is not so easy. Use "g.part_disk" to do that.
Throws: LibGuestFSException
This command deletes the partition numbered "partnum" on "device".
Note that in the case of MBR partitioning, deleting an extended partition also deletes any logical partitions it contains.
Throws: LibGuestFSException
This command is simply a combination of "g.part_init" followed by "g.part_add" to create a single primary partition covering the whole disk.
"parttype" is the partition table type, usually "mbr" or "gpt", but other possible values are described in "g.part_init".
This command is dangerous. Without careful use you can easily destroy all your data.
Throws: LibGuestFSException
This command returns true if the partition "partnum" on "device" has the bootable flag set.
See also "g.part_set_bootable".
Throws: LibGuestFSException
Returns the MBR type byte (also known as the ID byte) from the numbered partition "partnum".
Note that only MBR (old DOS-style) partitions have type bytes. You will get undefined results for other partition table types (see "g.part_get_parttype").
Throws: LibGuestFSException
This command examines the partition table on "device" and returns the partition table type (format) being used.
Common return values include: "msdos" (a DOS/Windows style MBR partition table), "gpt" (a GPT/EFI-style partition table). Other values are possible, although unusual. See "g.part_init" for a full list.
Throws: LibGuestFSException
This creates an empty partition table on "device" of one of the partition types listed below. Usually "parttype" should be either "msdos" or "gpt" (for large disks).
Initially there are no partitions. Following this, you should call "g.part_add" for each partition required.
Possible values for "parttype" are:
efi | gpt Intel EFI / GPT partition table.
This is recommended for >= 2 TB partitions that will be accessed from Linux and Intel-based Mac OS X. It also has limited backwards compatibility with the "mbr" format.
mbr | msdos The standard PC "Master Boot Record" (MBR) format used by MS-DOS and Windows. This partition type will only work for device sizes up to 2 TB. For large disks we recommend using "gpt".
Other partition table types that may work but are not supported include:
aix AIX disk labels.
amiga | rdb Amiga "Rigid Disk Block" format.
bsd BSD disk labels.
dasd DASD, used on IBM mainframes.
dvh MIPS/SGI volumes.
mac Old Mac partition format. Modern Macs use "gpt".
pc98 NEC PC-98 format, common in Japan apparently.
sun Sun disk labels.
Throws: LibGuestFSException
This command parses the partition table on "device" and returns the list of partitions found.
The fields in the returned structure are:
part_num Partition number, counting from 1.
part_start Start of the partition *in bytes*. To get sectors you have to divide by the device's sector size, see "g.blockdev_getss".
part_end End of the partition in bytes.
part_size Size of the partition in bytes.
Throws: LibGuestFSException
This sets the bootable flag on partition numbered "partnum" on device "device". Note that partitions are numbered from 1.
The bootable flag is used by some operating systems (notably Windows) to determine which partition to boot from. It is by no means universally recognized.
Throws: LibGuestFSException
Sets the MBR type byte (also known as the ID byte) of the numbered partition "partnum" to "idbyte". Note that the type bytes quoted in most documentation are in fact hexadecimal numbers, but usually documented without any leading "0x" which might be confusing.
Note that only MBR (old DOS-style) partitions have type bytes. You will get undefined results for other partition table types (see "g.part_get_parttype").
Throws: LibGuestFSException
This sets the partition name on partition numbered "partnum" on device "device". Note that partitions are numbered from 1.
The partition name can only be set on certain types of partition table. This works on "gpt" but not on "mbr" partitions.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
This command lets you read part of a file. It reads "count" bytes of the file, starting at "offset", from file "path".
This may read fewer bytes than requested. For further details see the pread(2) system call.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
This creates an LVM physical volume on the named "device", where "device" should usually be a partition name such as "/dev/sda1".
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
This resizes (expands or shrinks) an existing LVM physical volume to match the new size of the underlying device.
Throws: LibGuestFSException
List all the physical volumes detected. This is the equivalent of the pvs(8) command.
This returns a list of just the device names that contain PVs (eg. "/dev/sda2").
See also "g.pvs_full".
Throws: LibGuestFSException
List all the physical volumes detected. This is the equivalent of the pvs(8) command. The "full" version includes all fields.
Throws: LibGuestFSException
This command returns the UUID of the LVM PV "device".
Throws: LibGuestFSException
This returns the list of directory entries in directory "dir".
All entries in the directory are returned, including "." and "..". The entries are *not* sorted, but returned in the same order as the underlying filesystem.
Also this call returns basic file type information about each file. The "ftyp" field will contain one of the following characters:
'b' Block special
'c' Char special
'd' Directory
'f' FIFO (named pipe)
'l' Symbolic link
'r' Regular file
's' Socket
'u' Unknown file type
'?' The readdir(3) returned a "d_type" field with an unexpected value
This function is primarily intended for use by programs. To get a simple list of names, use "g.ls". To get a printable directory for human consumption, use "g.ll".
Throws: LibGuestFSException
This command reads the target of a symbolic link.
Throws: LibGuestFSException
This call allows you to do a "readlink" operation on multiple files, where all files are in the directory "path". "names" is the list of files from this directory.
On return you get a list of strings, with a one-to-one correspondence to the "names" list. Each string is the value of the symbol link.
If the readlink(2) operation fails on any name, then the corresponding result string is the empty string "". However the whole operation is completed even if there were readlink(2) errors, and so you can call this function with names where you don't know if they are symbolic links already (albeit slightly less efficient).
This call is intended for programs that want to efficiently list a directory contents without making many round-trips. Very long directory listings might cause the protocol message size to be exceeded, causing this call to fail. The caller must split up such requests into smaller groups of names.
Throws: LibGuestFSException
This calls returns the contents of the file "path" as a buffer.
Unlike "g.cat", this function can correctly handle files that contain embedded ASCII NUL characters. However unlike "g.download", this function is limited in the total size of file that can be handled.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
Return the contents of the file named "path".
The file contents are returned as a list of lines. Trailing "LF" and "CRLF" character sequences are *not* returned.
Note that this function cannot correctly handle binary files (specifically, files containing "\0" character which is treated as end of line). For those you need to use the "g.read_file" function which has a more complex interface.
Throws: LibGuestFSException
Return the canonicalized absolute pathname of "path". The returned path has no ".", ".." or symbolic link path elements.
Throws: LibGuestFSException
This call removes the extended attribute named "xattr" of the file "path".
See also: "g.lremovexattr", attr(5).
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
Remove the single file "path".
Throws: LibGuestFSException
Remove the single directory "path".
Throws: LibGuestFSException
This calls removes a mountpoint that was previously created with "g.mkmountpoint". See "g.mkmountpoint" for full details.
Throws: LibGuestFSException
Remove the file or directory "path", recursively removing the contents if its a directory. This is like the "rm -rf" shell command.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
This sets the SELinux security context of the daemon to the string "context".
See the documentation about SELINUX in guestfs(3).
Throws: LibGuestFSException
This call sets the extended attribute named "xattr" of the file "path" to the value "val" (of length "vallen"). The value is arbitrary 8 bit data.
See also: "g.lsetxattr", attr(5).
Throws: LibGuestFSException
This function is used to add additional options to the guest kernel command line.
The default is "NULL" unless overridden by setting "LIBGUESTFS_APPEND" environment variable.
Setting "append" to "NULL" means *no* additional options are passed (libguestfs always adds a few of its own).
Throws: LibGuestFSException
If "autosync" is true, this enables autosync. Libguestfs 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).
Throws: LibGuestFSException
If the direct appliance mode flag is enabled, then stdin and stdout are passed directly through to the appliance once it is launched.
One consequence of this is that log messages aren't caught by the library and handled by "g.set_log_message_callback", but go straight to stdout.
You probably don't want to use this unless you know what you are doing.
The default is disabled.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
This sets the memory size in megabytes allocated to the qemu subprocess. This only has any effect if called before "g.launch".
You can also change this by setting the environment variable "LIBGUESTFS_MEMSIZE" before the handle is created.
For more information on the architecture of libguestfs, see guestfs(3).
Throws: LibGuestFSException
Set the path that libguestfs searches for kernel and initrd.img.
The default is "$libdir/guestfs" unless overridden by setting "LIBGUESTFS_PATH" environment variable.
Setting "path" to "NULL" restores the default path.
Throws: LibGuestFSException
Set the qemu binary that we will use.
The default is chosen when the library was compiled by the configure script.
You can also override this by setting the "LIBGUESTFS_QEMU" environment variable.
Setting "qemu" to "NULL" restores the default qemu binary.
Note that you should call this function as early as possible after creating the handle. This is because some pre-launch operations depend on testing qemu features (by running "qemu -help"). If the qemu binary changes, we don't retest features, and so you might see inconsistent results. Using the environment variable "LIBGUESTFS_QEMU" is safest of all since that picks the qemu binary at the same time as the handle is created.
Throws: LibGuestFSException
If this is called with the parameter "false" then "g.launch" does not create a recovery process. The purpose of the recovery process is to stop runaway qemu processes in the case where the main program aborts abruptly.
This only has any effect if called before "g.launch", and the default is true.
About the only time when you would want to disable this is if the main process will fork itself into the background ("daemonize" itself). In this case the recovery process thinks that the main program has disappeared and so kills qemu, which is not very helpful.
Throws: LibGuestFSException
This sets the selinux flag that is passed to the appliance at boot time. The default is "selinux=0" (disabled).
Note that if SELinux is enabled, it is always in Permissive mode ("enforcing=0").
For more information on the architecture of libguestfs, see guestfs(3).
Throws: LibGuestFSException
If the command trace flag is set to 1, then commands are printed on stdout before they are executed in a format which is very similar to the one used by guestfish. In other words, you can run a program with this enabled, and you will get out a script which you can feed to guestfish to perform the same set of actions.
If you want to trace C API calls into libguestfs (and other libraries) then possibly a better way is to use the external ltrace(1) command.
Command traces are disabled unless the environment variable "LIBGUESTFS_TRACE" is defined and set to 1.
Throws: LibGuestFSException
If "verbose" is true, this turns on verbose messages (to "stderr").
Verbose messages are disabled unless the environment variable "LIBGUESTFS_DEBUG" is defined and set to 1.
Throws: LibGuestFSException
This is a direct interface to the sfdisk(8) program for creating partitions on block devices.
"device" should be a block device, for example "/dev/sda".
"cyls", "heads" and "sectors" are the number of cylinders, heads and sectors on the device, which are passed directly to sfdisk as the *-C*, *-H* and *-S* parameters. If you pass 0 for any of these, then the corresponding parameter is omitted. Usually for 'large' disks, you can just pass 0 for these, but for small (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work out the right geometry and you will need to tell it.
"lines" is a list of lines that we feed to "sfdisk". For more information refer to the sfdisk(8) manpage.
To create a single partition occupying the whole disk, you would pass "lines" as a single element list, when the single element being the string "," (comma).
See also: "g.sfdisk_l", "g.sfdisk_N", "g.part_init"
This command is dangerous. Without careful use you can easily destroy all your data.
Throws: LibGuestFSException
This is a simplified interface to the "g.sfdisk" command, where partition sizes are specified in megabytes only (rounded to the nearest cylinder) and you don't need to specify the cyls, heads and sectors parameters which were rarely if ever used anyway.
See also: "g.sfdisk", the sfdisk(8) manpage and "g.part_disk"
This command is dangerous. Without careful use you can easily destroy all your data.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
This displays the kernel's idea of the geometry of "device".
The result is in human-readable format, and not designed to be parsed.
Throws: LibGuestFSException
This displays the partition table on "device", in the human-readable output of the sfdisk(8) command. It is not intended to be parsed.
See also: "g.part_list"
Throws: LibGuestFSException
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.
See also: "g.part_add"
This command is dangerous. Without careful use you can easily destroy all your data.
Throws: LibGuestFSException
This call runs a command from the guest filesystem via the guest's "/bin/sh".
This is like "g.command", but passes the command to:
/bin/sh -c "command"
Depending on the guest's shell, this usually results in wildcards being expanded, shell expressions being interpolated and so on.
All the provisos about "g.command" apply to this call.
Throws: LibGuestFSException
This is the same as "g.sh", but splits the result into a list of lines.
See also: "g.command_lines"
Throws: LibGuestFSException
Sleep for "secs" seconds.
Throws: LibGuestFSException
Returns file information for the given "path".
This is the same as the stat(2) system call.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
This runs the strings(1) command on a file and returns the list of printable strings found.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
This is like the "g.strings" command, but allows you to specify the encoding of strings that are looked for in the source file "path".
Allowed encodings are:
s Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of ISO-8859-X (this is what "g.strings" uses).
S Single 8-bit-byte characters.
b 16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE.
l (lower case letter L) 16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for examining binaries in Windows guests.
B 32-bit big endian such as UCS-4BE.
L 32-bit little endian such as UCS-4LE.
The returned strings are transcoded to UTF-8.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
This command disables the libguestfs appliance swap device or partition named "device". See "g.swapon_device".
Throws: LibGuestFSException
This command disables the libguestfs appliance swap on file.
Throws: LibGuestFSException
This command disables the libguestfs appliance swap on labeled swap partition.
Throws: LibGuestFSException
This command disables the libguestfs appliance swap partition with the given UUID.
Throws: LibGuestFSException
This command enables the libguestfs appliance to use the swap device or partition named "device". The increased memory is made available for all commands, for example those run using "g.command" or "g.sh".
Note that you should not swap to existing guest swap partitions unless you know what you are doing. They may contain hibernation information, or other information that the guest doesn't want you to trash. You also risk leaking information about the host to the guest this way. Instead, attach a new host device to the guest and swap on that.
Throws: LibGuestFSException
This command enables swap to a file. See "g.swapon_device" for other notes.
Throws: LibGuestFSException
This command enables swap to a labeled swap partition. See "g.swapon_device" for other notes.
Throws: LibGuestFSException
This command enables swap to a swap partition with the given UUID. See "g.swapon_device" for other notes.
Throws: LibGuestFSException
This syncs the disk, so that any writes are flushed through to the underlying disk image.
You should always call this if you have modified a disk image, before closing the handle.
Throws: LibGuestFSException
This command returns up to the last 10 lines of a file as a list of strings.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
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.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
This command uploads and unpacks local file "tarfile" (an *uncompressed* tar file) into "directory".
To upload a compressed tarball, use "g.tgz_in".
Throws: LibGuestFSException
This command packs the contents of "directory" and downloads it to local file "tarfile".
To download a compressed tarball, use "g.tgz_out".
Throws: LibGuestFSException
This command uploads and unpacks local file "tarball" (a *gzip compressed* tar file) into "directory".
To upload an uncompressed tarball, use "g.tar_in".
Throws: LibGuestFSException
This command packs the contents of "directory" and downloads it to local file "tarball".
To download an uncompressed tarball, use "g.tar_out".
Throws: LibGuestFSException
Touch acts like the touch(1) command. It can be used to update the timestamps on a file, or, if the file does not exist, to create a new zero-length file.
Throws: LibGuestFSException
This command truncates "path" to a zero-length file. The file must exist already.
Throws: LibGuestFSException
This command truncates "path" to size "size" bytes. The file must exist already. If the file is smaller than "size" then the file is extended to the required size with null bytes.
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
This function sets the mask used for creating new files and device nodes to "mask & 0777".
Typical umask values would be 022 which creates new files with permissions like "-rw-r--r--" or "-rwxr-xr-x", and 002 which creates new files with permissions like "-rw-rw-r--" or "-rwxrwxr-x".
The default umask is 022. This is important because it means that directories and device nodes will be created with 0644 or 0755 mode even if you specify 0777.
See also umask(2), "g.mknod", "g.mkdir".
This call returns the previous umask.
Throws: LibGuestFSException
This unmounts the given filesystem. The filesystem may be specified either by its mountpoint (path) or the device which contains the filesystem.
Throws: LibGuestFSException
This unmounts all mounted filesystems.
Some internal mounts are not unmounted by this call.
Throws: LibGuestFSException
Upload local file "filename" to "remotefilename" on the filesystem.
"filename" can also be a named pipe.
See also "g.download".
Throws: LibGuestFSException
This command sets the timestamps of a file with nanosecond precision.
"atsecs, atnsecs" are the last access time (atime) in secs and nanoseconds from the epoch.
"mtsecs, mtnsecs" are the last modification time (mtime) in secs and nanoseconds from the epoch.
If the *nsecs field contains the special value -1 then the corresponding timestamp is set to the current time. (The *secs field is ignored in this case).
If the *nsecs field contains the special value -2 then the corresponding timestamp is left unchanged. (The *secs field is ignored in this case).
Throws: LibGuestFSException
Return the libguestfs version number that the program is linked against.
Note that because of dynamic linking this is not necessarily the version of libguestfs that you compiled against. You can compile the program, and then at runtime dynamically link against a completely different "libguestfs.so" library.
This call was added in version 1.0.58. In previous versions of libguestfs there was no way to get the version number. From C code you can use ELF weak linking tricks to find out if this symbol exists (if it doesn't, then it's an earlier version).
The call returns a structure with four elements. The first three ("major", "minor" and "release") are numbers and correspond to the usual version triplet. The fourth element ("extra") is a string and is normally empty, but may be used for distro-specific information.
To construct the original version string: "$major.$minor.$release$extra"
*Note:* Don't use this call to test for availability of features. Distro backports makes this unreliable. Use "g.available" instead.
Throws: LibGuestFSException
This command gets the block device type corresponding to a mounted device called "device".
Usually the result is the name of the Linux VFS module that is used to mount this device (probably determined automatically if you used the "g.mount" call).
Throws: LibGuestFSException
This creates an LVM volume group called "volgroup" from the non-empty list of physical volumes "physvols".
Throws: LibGuestFSException
Given a VG called "vgname", this returns the UUIDs of all the logical volumes created in this volume group.
You can use this along with "g.lvs" and "g.lvuuid" calls to associate logical volumes and volume groups.
See also "g.vgpvuuids".
Throws: LibGuestFSException
Given a VG called "vgname", this returns the UUIDs of all the physical volumes that this volume group resides on.
You can use this along with "g.pvs" and "g.pvuuid" calls to associate physical volumes and volume groups.
See also "g.vglvuuids".
Throws: LibGuestFSException
Remove an LVM volume group "vgname", (for example "VG").
This also forcibly removes all logical volumes in the volume group (if any).
Throws: LibGuestFSException
Rename a volume group "volgroup" with the new name "newvolgroup".
Throws: LibGuestFSException
List all the volumes groups detected. This is the equivalent of the vgs(8) command.
This returns a list of just the volume group names that were detected (eg. "VolGroup00").
See also "g.vgs_full".
Throws: LibGuestFSException
List all the volumes groups detected. This is the equivalent of the vgs(8) command. The "full" version includes all fields.
Throws: LibGuestFSException
This command returns the UUID of the LVM VG named "vgname".
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
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"
Throws: LibGuestFSException
This function is a no op.
In versions of the API < 1.0.71 you had to call this function just after calling "g.launch" to wait for the launch to complete. However this is no longer necessary because "g.launch" now does the waiting.
If you see any calls to this function in code then you can just remove them, unless you want to retain compatibility with older versions of the API.
Throws: LibGuestFSException
This command counts the characters in a file, using the "wc -c" external command.
Throws: LibGuestFSException
This command counts the lines in a file, using the "wc -l" external command.
Throws: LibGuestFSException
This command counts the words in a file, using the "wc -w" external command.
Throws: LibGuestFSException
This call creates a file called "path". The contents of the file is the string "content" (which can contain any 8 bit data), with length "size".
As a special case, if "size" is 0 then the length is 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. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
This calls the external "zegrep" program and returns the matching lines.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
This calls the external "zegrep -i" program and returns the matching lines.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
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.
See also: "g.scrub_device".
Throws: LibGuestFSException
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.
Throws: LibGuestFSException
This calls the external "zfgrep" program and returns the matching lines.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
This calls the external "zfgrep -i" program and returns the matching lines.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
This command runs "file" after first decompressing "path" using "method".
"method" must be one of "gzip", "compress" or "bzip2".
Since 1.0.63, use "g.file" instead which can now process compressed files.
This function is deprecated. In new code, use the "file" call instead.
Deprecated functions will not be removed from the API, but the fact that they are deprecated indicates that there are problems with correct use of these functions.
Throws: LibGuestFSException
This calls the external "zgrep" program and returns the matching lines.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException
This calls the external "zgrep -i" program and returns the matching lines.
Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).
Throws: LibGuestFSException