com.redhat.et.libguestfs

Class GuestFS

public class GuestFS extends Object

The GuestFS object is a libguestfs handle.
Constructor Summary
GuestFS()
Create a libguestfs handle.
Method Summary
voidadd_cdrom(String filename)
add a CD-ROM disk image to examine

This function adds a virtual CD-ROM disk image to the guest.

voidadd_drive(String filename)
add an image to examine or modify

This function adds a virtual machine disk image "filename" to the guest.

voidadd_drive_ro(String filename)
add a drive in snapshot mode (read-only)

This adds a drive in snapshot mode, making it effectively read-only.

voidaug_close()
close the current Augeas handle

Close the current Augeas handle and free up any resources used by it.

IntBoolaug_defnode(String name, String expr, String val)
define an Augeas node

Defines a variable "name" whose value is the result of evaluating "expr".

intaug_defvar(String name, String expr)
define an Augeas variable

Defines an Augeas variable "name" whose value is the result of evaluating "expr".

Stringaug_get(String augpath)
look up the value of an Augeas path

Look up the value associated with "path".

voidaug_init(String root, int flags)
create a new Augeas handle

Create a new Augeas handle for editing configuration files.

voidaug_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").

voidaug_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".

voidaug_mv(String src, String dest)
move Augeas node

Move the node "src" to "dest".

intaug_rm(String augpath)
remove an Augeas path

Remove "path" and all of its children.

voidaug_save()
write all pending Augeas changes to disk

This writes all pending changes to disk.

voidaug_set(String augpath, String val)
set Augeas path to value

Set the value associated with "path" to "value".

voidblockdev_flushbufs(String device)
flush device buffers

This tells the kernel to flush internal buffers associated with "device".

intblockdev_getbsz(String device)
get blocksize of block device

This returns the block size of a device.

booleanblockdev_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).

longblockdev_getsize64(String device)
get total size of device in bytes

This returns the size of the device in bytes.

intblockdev_getss(String device)
get sectorsize of block device

This returns the size of sectors on a block device.

longblockdev_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).

voidblockdev_rereadpt(String device)
reread partition table

Reread the partition table on "device".

voidblockdev_setbsz(String device, int blocksize)
set blocksize of block device

This sets the block size of a device.

voidblockdev_setro(String device)
set block device to read-only

Sets the block device named "device" to read-only.

voidblockdev_setrw(String device)
set block device to read-write

Sets the block device named "device" to read-write.

Stringcat(String path)
list the contents of a file

Return the contents of the file named "path".

Stringchecksum(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".

voidchmod(int mode, String path)
change file mode

Change the mode (permissions) of "path" to "mode".

voidchown(int owner, int group, String path)
change file owner and group

Change the file owner to "owner" and group to "group".

voidclose()
Close a libguestfs handle.
Stringcommand(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.

voidconfig(String qemuparam, String qemuvalue)
add qemu parameters

This can be used to add arbitrary qemu command line parameters of the form "-param value".

voidcp(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.

voidcp_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.

Stringdebug(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.

Stringdf()
report file system disk space usage

This command runs the "df" command to report disk space used.

Stringdf_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.

Stringdmesg()
return kernel messages

This returns the kernel messages ("dmesg" output) from the guest kernel.

voiddownload(String remotefilename, String filename)
download a file to the local machine

Download file "remotefilename" and save it as "filename" on the local machine.

voiddrop_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.

longdu(String path)
estimate file space usage

This command runs the "du -s" command to estimate file space usage for "path".

voide2fsck_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").

Stringecho_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.

booleanequal(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.

booleanexists(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.

voidfallocate(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.

Stringfile(String path)
determine file type

This call uses the standard file(1) command to determine the type or contents of the file.

voidfinalize()
String[]find(String directory)
find all files and directories

This command lists out all files and directories, recursively, starting at "directory".

intfsck(String fstype, String device)
run the filesystem checker

This runs the filesystem checker (fsck) on "device" which should have filesystem type "fstype".

Stringgetcon()
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".

Stringget_append()
get the additional kernel options

Return the additional kernel options which are added to the guest kernel command line.

booleanget_autosync()
get autosync mode

Get the autosync flag.

booleanget_direct()
get direct appliance mode flag

Return the direct appliance mode flag.

Stringget_e2label(String device)
get the ext2/3/4 filesystem label

This returns the ext2/3/4 filesystem label of the filesystem on "device".

Stringget_e2uuid(String device)
get the ext2/3/4 filesystem UUID

This returns the ext2/3/4 filesystem UUID of the filesystem on "device".

intget_memsize()
get memory allocated to the qemu subprocess

This gets the memory size in megabytes allocated to the qemu subprocess.

Stringget_path()
get the search path

Return the current search path.

intget_pid()
get PID of qemu subprocess

Return the process ID of the qemu subprocess.

Stringget_qemu()
get the qemu binary

Return the current qemu binary.

booleanget_selinux()
get SELinux enabled flag

This returns the current setting of the selinux flag which is passed to the appliance at boot time.

intget_state()
get the current state

This returns the current state as an opaque integer.

booleanget_trace()
get command trace enabled flag

Return the command trace flag.

booleanget_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.

voidgrub_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".

Stringhexdump(String path)
dump a file in hexadecimal

This runs "hexdump -C" on the given "path".

String[]initrd_list(String path)
list files in an initrd

This command lists out files contained in an initrd.

longinotify_add_watch(String path, int mask)
add an inotify watch

Watch "path" for the events listed in "mask".

voidinotify_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.

voidinotify_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.

voidinotify_rm_watch(int wd)
remove an inotify watch

Remove a previously defined inotify watch.

booleanis_busy()
is busy processing a command

This returns true iff this handle is busy processing a command (in the "BUSY" state).

booleanis_config()
is in configuration state

This returns true iff this handle is being configured (in the "CONFIG" state).

booleanis_dir(String path)
test if file exists

This returns "true" if and only if there is a directory with the given "path" name.

booleanis_file(String path)
test if file exists

This returns "true" if and only if there is a file with the given "path" name.

booleanis_launching()
is launching subprocess

This returns true iff this handle is launching the subprocess (in the "LAUNCHING" state).

booleanis_ready()
is ready to accept commands

This returns true iff this handle is ready to accept commands (in the "READY" state).

voidkill_subprocess()
kill the qemu subprocess

This kills the qemu subprocess.

voidlaunch()
launch the qemu subprocess

Internally libguestfs is implemented by running a virtual machine using qemu(1).

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.

Stringll(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'.

voidln(String target, String linkname)
create a hard link

This command creates a hard link using the "ln" command.

voidln_f(String target, String linkname)
create a hard link

This command creates a hard link using the "ln -f" command.

voidln_s(String target, String linkname)
create a symbolic link

This command creates a symbolic link using the "ln -s" command.

voidln_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.

voidlremovexattr(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).

voidlsetxattr(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.

Statlstat(String path)
get file information for a symbolic link

Returns file information for the given "path".

voidlvcreate(String logvol, String volgroup, int mbytes)
create an LVM volume group

This creates an LVM volume group called "logvol" on the volume group "volgroup", with "size" megabytes.

voidlvm_remove_all()
remove all LVM LVs, VGs and PVs

This command removes all LVM logical volumes, volume groups and physical volumes.

voidlvremove(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".

voidlvresize(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.

voidmkdir(String path)
create a directory

Create a directory named "path".

voidmkdir_p(String path)
create a directory and parents

Create a directory named "path", creating any parent directories as necessary.

Stringmkdtemp(String template)
create a temporary directory

This command creates a temporary directory.

voidmke2fs_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".

voidmke2fs_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".

voidmke2fs_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".

voidmke2journal(int blocksize, String device)
make ext2/3/4 external journal

This creates an ext2 external journal on "device".

voidmke2journal_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".

voidmke2journal_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".

voidmkfifo(int mode, String path)
make FIFO (named pipe)

This call creates a FIFO (named pipe) called "path" with mode "mode".

voidmkfs(String fstype, String device)
make a filesystem

This creates a filesystem on "device" (usually a partition or LVM logical volume).

voidmkfs_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.

voidmkmountpoint(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.

voidmknod(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).

voidmknod_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".

voidmknod_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".

voidmkswap(String device)
create a swap partition

Create a swap partition on "device".

voidmkswap_file(String path)
create a swap file

Create a swap file.

voidmkswap_L(String label, String device)
create a swap partition with a label

Create a swap partition on "device" with label "label".

voidmkswap_U(String uuid, String device)
create a swap partition with an explicit UUID

Create a swap partition on "device" with UUID "uuid".

voidmodprobe(String modulename)
load a kernel module

This loads a kernel module in the appliance.

voidmount(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.

voidmount_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.

voidmount_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.

voidmount_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.

voidmount_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.

voidmv(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.

intntfs_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.

voidping_daemon()
ping the guest daemon

This is a test probe into the guestfs daemon running inside the qemu subprocess.

voidpvcreate(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".

voidpvremove(String device)
remove an LVM physical volume

This wipes a physical volume "device" so that LVM will no longer recognise it.

voidpvresize(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.

Dirent[]readdir(String dir)
read directories entries

This returns the list of directory entries in directory "dir".

Stringreadlink(String path)
read the target of a symbolic link

This command reads the target of a symbolic link.

Stringread_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".

Stringrealpath(String path)
canonicalized absolute pathname

Return the canonicalized absolute pathname of "path".

voidremovexattr(String xattr, String path)
remove extended attribute of a file or directory

This call removes the extended attribute named "xattr" of the file "path".

voidresize2fs(String device)
resize an ext2/ext3 filesystem

This resizes an ext2 or ext3 filesystem to match the size of the underlying device.

voidrm(String path)
remove a file

Remove the single file "path".

voidrmdir(String path)
remove a directory

Remove the single directory "path".

voidrmmountpoint(String exemptpath)
remove a mountpoint

This calls removes a mountpoint that was previously created with "g.mkmountpoint".

voidrm_rf(String path)
remove a file or directory recursively

Remove the file or directory "path", recursively removing the contents if its a directory.

voidscrub_device(String device)
scrub (securely wipe) a device

This command writes patterns over "device" to make data retrieval more difficult.

voidscrub_file(String file)
scrub (securely wipe) a file

This command writes patterns over a file to make data retrieval more difficult.

voidscrub_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.

voidsetcon(String context)
set SELinux security context

This sets the SELinux security context of the daemon to the string "context".

voidsetxattr(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").

voidset_append(String append)
add options to kernel command line

This function is used to add additional options to the guest kernel command line.

voidset_autosync(boolean autosync)
set autosync mode

If "autosync" is true, this enables autosync.

voidset_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.

voidset_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".

voidset_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".

voidset_memsize(int memsize)
set memory allocated to the qemu subprocess

This sets the memory size in megabytes allocated to the qemu subprocess.

voidset_path(String searchpath)
set the search path

Set the path that libguestfs searches for kernel and initrd.img.

voidset_qemu(String qemu)
set the qemu binary

Set the qemu binary that we will use.

voidset_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.

voidset_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.

voidset_verbose(boolean verbose)
set verbose mode

If "verbose" is true, this turns on verbose messages (to "stderr").

voidsfdisk(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.

voidsfdiskM(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.

Stringsfdisk_disk_geometry(String device)
display the disk geometry from the partition table

This displays the disk geometry of "device" read from the partition table.

Stringsfdisk_kernel_geometry(String device)
display the kernel geometry

This displays the kernel's idea of the geometry of "device".

Stringsfdisk_l(String device)
display the partition table

This displays the partition table on "device", in the human-readable output of the sfdisk(8) command.

voidsfdisk_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).

Stringsh(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.

voidsleep(int secs)
sleep for some seconds

Sleep for "secs" seconds.

Statstat(String path)
get file information

Returns file information for the given "path".

StatVFSstatvfs(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.

voidswapoff_device(String device)
disable swap on device

This command disables the libguestfs appliance swap device or partition named "device".

voidswapoff_file(String file)
disable swap on file

This command disables the libguestfs appliance swap on file.

voidswapoff_label(String label)
disable swap on labeled swap partition

This command disables the libguestfs appliance swap on labeled swap partition.

voidswapoff_uuid(String uuid)
disable swap on swap partition by UUID

This command disables the libguestfs appliance swap partition with the given UUID.

voidswapon_device(String device)
enable swap on device

This command enables the libguestfs appliance to use the swap device or partition named "device".

voidswapon_file(String file)
enable swap on file

This command enables swap to a file.

voidswapon_label(String label)
enable swap on labeled swap partition

This command enables swap to a labeled swap partition.

voidswapon_uuid(String uuid)
enable swap on swap partition by UUID

This command enables swap to a swap partition with the given UUID.

voidsync()
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".

voidtar_in(String tarfile, String directory)
unpack tarfile to directory

This command uploads and unpacks local file "tarfile" (an *uncompressed* tar file) into "directory".

voidtar_out(String directory, String tarfile)
pack directory into tarfile

This command packs the contents of "directory" and downloads it to local file "tarfile".

voidtest0(String str, String optstr, String[] strlist, boolean b, int integer, String filein, String fileout)
booleantest0rbool(String val)
booleantest0rboolerr()
Stringtest0rconstoptstring(String val)
Stringtest0rconstoptstringerr()
Stringtest0rconststring(String val)
Stringtest0rconststringerr()
HashMap<String,String>test0rhashtable(String val)
HashMap<String,String>test0rhashtableerr()
inttest0rint(String val)
longtest0rint64(String val)
longtest0rint64err()
inttest0rinterr()
Stringtest0rstring(String val)
Stringtest0rstringerr()
String[]test0rstringlist(String val)
String[]test0rstringlisterr()
PVtest0rstruct(String val)
PVtest0rstructerr()
PV[]test0rstructlist(String val)
PV[]test0rstructlisterr()
voidtgz_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".

voidtgz_out(String directory, String tarball)
pack directory into compressed tarball

This command packs the contents of "directory" and downloads it to local file "tarball".

voidtouch(String path)
update file timestamps or create a new file

Touch acts like the touch(1) command.

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".

intumask(int mask)
set file mode creation mask (umask)

This function sets the mask used for creating new files and device nodes to "mask & 0777".

voidumount(String pathordevice)
unmount a filesystem

This unmounts the given filesystem.

voidumount_all()
unmount all filesystems

This unmounts all mounted filesystems.

voidupload(String filename, String remotefilename)
upload a file from the local machine

Upload local file "filename" to "remotefilename" on the filesystem.

Versionversion()
get the library version number

Return the libguestfs version number that the program is linked against.

voidvgcreate(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".

voidvgremove(String vgname)
remove an LVM volume group

Remove an LVM volume group "vgname", (for example "VG").

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.

voidvg_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".

voidvg_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.

voidwait_ready()
wait until the qemu subprocess launches (no op)

This function is a no op.

intwc_c(String path)
count characters in a file

This command counts the characters in a file, using the "wc -c" external command.

intwc_l(String path)
count lines in a file

This command counts the lines in a file, using the "wc -l" external command.

intwc_w(String path)
count words in a file

This command counts the words in a file, using the "wc -w" external command.

voidwrite_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.

voidzero(String device)
write zeroes to the device

This command writes zeroes over the first few blocks of "device".

voidzerofree(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.

Stringzfile(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.

Constructor Detail

GuestFS

public GuestFS()
Create a libguestfs handle.

Throws: LibGuestFSException

Method Detail

add_cdrom

public 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.

This is equivalent to the qemu parameter "-cdrom filename".

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

add_drive

public void add_drive(String filename)
add an image to examine or modify

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.

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

add_drive_ro

public 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.

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,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

aug_close

public void aug_close()
close the current Augeas handle

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

aug_defnode

public 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".

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

aug_defvar

public int aug_defvar(String name, String expr)
define an Augeas variable

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

aug_get

public String aug_get(String augpath)
look up the value of an Augeas path

Look up the value associated with "path". If "path" matches exactly one node, the "value" is returned.

Throws: LibGuestFSException

aug_init

public void aug_init(String root, int flags)
create a new Augeas handle

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 , the logical *or* of the following integers:

"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

aug_insert

public 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").

"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

aug_load

public void aug_load()
load files into the tree

Load files into the tree.

See "aug_load" in the Augeas documentation for the full gory details.

Throws: LibGuestFSException

aug_ls

public 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.

Throws: LibGuestFSException

aug_match

public String[] aug_match(String augpath)
return Augeas nodes which match augpath

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

aug_mv

public void aug_mv(String src, String dest)
move Augeas node

Move the node "src" to "dest". "src" must match exactly one node. "dest" is overwritten if it exists.

Throws: LibGuestFSException

aug_rm

public int aug_rm(String augpath)
remove an Augeas path

Remove "path" and all of its children.

On success this returns the number of entries which were removed.

Throws: LibGuestFSException

aug_save

public void aug_save()
write all pending Augeas changes to disk

This writes all pending changes to disk.

The flags which were passed to "g.aug_init" affect exactly how files are saved.

Throws: LibGuestFSException

aug_set

public void aug_set(String augpath, String val)
set Augeas path to value

Set the value associated with "path" to "value".

Throws: LibGuestFSException

blockdev_flushbufs

public void blockdev_flushbufs(String device)
flush device buffers

This tells the kernel to flush internal buffers associated with "device".

This uses the blockdev(8) command.

Throws: LibGuestFSException

blockdev_getbsz

public int blockdev_getbsz(String device)
get blocksize of block device

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

blockdev_getro

public 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).

This uses the blockdev(8) command.

Throws: LibGuestFSException

blockdev_getsize64

public long blockdev_getsize64(String device)
get total size of device in bytes

This returns the size of the device in bytes.

See also "g.blockdev_getsz".

This uses the blockdev(8) command.

Throws: LibGuestFSException

blockdev_getss

public int blockdev_getss(String device)
get sectorsize of block device

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

blockdev_getsz

public 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).

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

blockdev_rereadpt

public void blockdev_rereadpt(String device)
reread partition table

Reread the partition table on "device".

This uses the blockdev(8) command.

Throws: LibGuestFSException

blockdev_setbsz

public void blockdev_setbsz(String device, int blocksize)
set blocksize of block device

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

blockdev_setro

public void blockdev_setro(String device)
set block device to read-only

Sets the block device named "device" to read-only.

This uses the blockdev(8) command.

Throws: LibGuestFSException

blockdev_setrw

public void blockdev_setrw(String device)
set block device to read-write

Sets the block device named "device" to read-write.

This uses the blockdev(8) command.

Throws: LibGuestFSException

cat

public String cat(String path)
list the contents of a file

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. To transfer large files you should use FTP.

Throws: LibGuestFSException

checksum

public 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".

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

chmod

public void chmod(int mode, String path)
change file mode

Change the mode (permissions) of "path" to "mode". Only numeric modes are supported.

Throws: LibGuestFSException

chown

public void chown(int owner, int group, String path)
change file owner and group

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

close

public void close()
Close a libguestfs handle. You can also leave handles to be collected by the garbage collector, but this method ensures that the resources used by the handle are freed up immediately. If you call any other methods after closing the handle, you will get an exception.

Throws: LibGuestFSException

command

public String command(String[] arguments)
run a command from the guest filesystem

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. To transfer large files you should use FTP.

Throws: LibGuestFSException

command_lines

public 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.

See also: "g.sh_lines"

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. To transfer large files you should use FTP.

Throws: LibGuestFSException

config

public 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". 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

cp

public 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.

Throws: LibGuestFSException

cp_a

public 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.

Throws: LibGuestFSException

debug

public 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.

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

df

public String df()
report file system disk space usage

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

df_h

public 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.

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

dmesg

public String dmesg()
return kernel messages

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

public 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.

"filename" can also be a named pipe.

See also "g.upload", "g.cat".

Throws: LibGuestFSException

drop_caches

public 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. 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

du

public long du(String path)
estimate file space usage

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

e2fsck_f

public 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").

This command is only needed because of "g.resize2fs" (q.v.). Normally you should use "g.fsck".

Throws: LibGuestFSException

echo_daemon

public 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.

You can use this command to test the connection through to the daemon.

See also "g.ping_daemon".

Throws: LibGuestFSException

egrep

public String[] egrep(String regex, String path)
return lines matching a pattern

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. To transfer large files you should use FTP.

Throws: LibGuestFSException

egrepi

public String[] egrepi(String regex, String path)
return lines matching a pattern

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. To transfer large files you should use FTP.

Throws: LibGuestFSException

equal

public 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.

The external cmp(1) program is used for the comparison.

Throws: LibGuestFSException

exists

public 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.

See also "g.is_file", "g.is_dir", "g.stat".

Throws: LibGuestFSException

fallocate

public 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. 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

fgrep

public String[] fgrep(String pattern, String path)
return lines matching a pattern

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. To transfer large files you should use FTP.

Throws: LibGuestFSException

fgrepi

public String[] fgrepi(String pattern, String path)
return lines matching a pattern

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. To transfer large files you should use FTP.

Throws: LibGuestFSException

file

public String file(String path)
determine file type

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

finalize

public void finalize()

find

public String[] find(String directory)
find all files and directories

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.

Throws: LibGuestFSException

fsck

public int fsck(String fstype, String device)
run the filesystem checker

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

getcon

public String getcon()
get SELinux security context

This gets the SELinux security context of the daemon.

See the documentation about SELINUX in guestfs(3), and "g.setcon"

Throws: LibGuestFSException

getxattrs

public XAttr[] getxattrs(String path)
list extended attributes of a file or directory

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

get_append

public String get_append()
get the additional kernel options

Return the additional kernel options which are added to the guest kernel command line.

If "NULL" then no options are added.

Throws: LibGuestFSException

get_autosync

public boolean get_autosync()
get autosync mode

Get the autosync flag.

Throws: LibGuestFSException

get_direct

public boolean get_direct()
get direct appliance mode flag

Return the direct appliance mode flag.

Throws: LibGuestFSException

get_e2label

public 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".

Throws: LibGuestFSException

get_e2uuid

public 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".

Throws: LibGuestFSException

get_memsize

public int get_memsize()
get memory allocated to the qemu subprocess

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

get_path

public String get_path()
get the search path

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

get_pid

public int get_pid()
get PID of qemu subprocess

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

get_qemu

public String get_qemu()
get the qemu binary

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

get_selinux

public 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. See "g.set_selinux".

For more information on the architecture of libguestfs, see guestfs(3).

Throws: LibGuestFSException

get_state

public int get_state()
get the current state

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

get_trace

public boolean get_trace()
get command trace enabled flag

Return the command trace flag.

Throws: LibGuestFSException

get_verbose

public boolean get_verbose()
get verbose mode

This returns the verbose messages flag.

Throws: LibGuestFSException

glob_expand

public 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.

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

grep

public String[] grep(String regex, String path)
return lines matching a pattern

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. To transfer large files you should use FTP.

Throws: LibGuestFSException

grepi

public String[] grepi(String regex, String path)
return lines matching a pattern

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. To transfer large files you should use FTP.

Throws: LibGuestFSException

grub_install

public 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".

Throws: LibGuestFSException

head

public 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.

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. To transfer large files you should use FTP.

Throws: LibGuestFSException

head_n

public 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".

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. To transfer large files you should use FTP.

Throws: LibGuestFSException

hexdump

public String hexdump(String path)
dump a file in hexadecimal

This runs "hexdump -C" on the given "path". The result is the human-readable, canonical hex dump of the file.

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. To transfer large files you should use FTP.

Throws: LibGuestFSException

initrd_list

public String[] initrd_list(String path)
list files in an initrd

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

inotify_add_watch

public long inotify_add_watch(String path, int mask)
add an inotify watch

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

inotify_close

public void inotify_close()
close the inotify handle

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

inotify_files

public 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. The returned pathnames are sorted and deduplicated.

Throws: LibGuestFSException

inotify_init

public void inotify_init(int maxevents)
create an inotify handle

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

inotify_read

public INotifyEvent[] inotify_read()
return list of inotify events

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

inotify_rm_watch

public void inotify_rm_watch(int wd)
remove an inotify watch

Remove a previously defined inotify watch. See "g.inotify_add_watch".

Throws: LibGuestFSException

is_busy

public boolean is_busy()
is busy processing a command

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

is_config

public boolean is_config()
is in configuration state

This returns true iff this handle is being configured (in the "CONFIG" state).

For more information on states, see guestfs(3).

Throws: LibGuestFSException

is_dir

public 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. Note that it returns false for other objects like files.

See also "g.stat".

Throws: LibGuestFSException

is_file

public 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. Note that it returns false for other objects like directories.

See also "g.stat".

Throws: LibGuestFSException

is_launching

public boolean is_launching()
is launching subprocess

This returns true iff this handle is launching the subprocess (in the "LAUNCHING" state).

For more information on states, see guestfs(3).

Throws: LibGuestFSException

is_ready

public boolean is_ready()
is ready to accept commands

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

kill_subprocess

public void kill_subprocess()
kill the qemu subprocess

This kills the qemu subprocess. You should never need to call this.

Throws: LibGuestFSException

launch

public void launch()
launch the qemu subprocess

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

lgetxattrs

public 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.

Throws: LibGuestFSException

list_devices

public String[] list_devices()
list the block devices

List all the block devices.

The full block device names are returned, eg. "/dev/sda"

Throws: LibGuestFSException

list_partitions

public String[] list_partitions()
list the partitions

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

ll

public 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'.

This command is mostly useful for interactive sessions. It is *not* intended that you try to parse the output string.

Throws: LibGuestFSException

ln

public void ln(String target, String linkname)
create a hard link

This command creates a hard link using the "ln" command.

Throws: LibGuestFSException

ln_f

public void ln_f(String target, String linkname)
create a hard link

This command creates a hard link using the "ln -f" command. The "-f" option removes the link ("linkname") if it exists already.

Throws: LibGuestFSException

ln_s

public void ln_s(String target, String linkname)
create a symbolic link

This command creates a symbolic link using the "ln -s" command.

Throws: LibGuestFSException

ln_sf

public 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.

Throws: LibGuestFSException

lremovexattr

public 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.

Throws: LibGuestFSException

ls

public String[] ls(String directory)
list the files in a directory

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

lsetxattr

public 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.

Throws: LibGuestFSException

lstat

public Stat lstat(String path)
get file information for a symbolic link

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

lvcreate

public void lvcreate(String logvol, String volgroup, int mbytes)
create an LVM volume group

This creates an LVM volume group called "logvol" on the volume group "volgroup", with "size" megabytes.

Throws: LibGuestFSException

lvm_remove_all

public void lvm_remove_all()
remove all LVM LVs, VGs and PVs

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

lvremove

public 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".

You can also remove all LVs in a volume group by specifying the VG name, "/dev/VG".

Throws: LibGuestFSException

lvresize

public void lvresize(String device, int mbytes)
resize an LVM logical volume

This resizes (expands or shrinks) an existing LVM logical volume to "mbytes". When reducing, data in the reduced part is lost.

Throws: LibGuestFSException

lvs

public String[] lvs()
list the LVM logical volumes (LVs)

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

lvs_full

public LV[] lvs_full()
list the LVM logical volumes (LVs)

List all the logical volumes detected. This is the equivalent of the lvs(8) command. The "full" version includes all fields.

Throws: LibGuestFSException

mkdir

public void mkdir(String path)
create a directory

Create a directory named "path".

Throws: LibGuestFSException

mkdir_p

public void mkdir_p(String path)
create a directory and parents

Create a directory named "path", creating any parent directories as necessary. This is like the "mkdir -p" shell command.

Throws: LibGuestFSException

mkdtemp

public String mkdtemp(String template)
create a temporary directory

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

mke2fs_J

public 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". It is equivalent to the command:

mke2fs -t fstype -b blocksize -J device=

See also "g.mke2journal".

Throws: LibGuestFSException

mke2fs_JL

public 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".

See also "g.mke2journal_L".

Throws: LibGuestFSException

mke2fs_JU

public 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".

See also "g.mke2journal_U".

Throws: LibGuestFSException

mke2journal

public void mke2journal(int blocksize, String device)
make ext2/3/4 external journal

This creates an ext2 external journal on "device". It is equivalent to the command:

mke2fs -O journal_dev -b blocksize device

Throws: LibGuestFSException

mke2journal_L

public 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".

Throws: LibGuestFSException

mke2journal_U

public 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".

Throws: LibGuestFSException

mkfifo

public void mkfifo(int mode, String path)
make FIFO (named pipe)

This call creates a FIFO (named pipe) called "path" with mode "mode". It is just a convenient wrapper around "g.mknod".

Throws: LibGuestFSException

mkfs

public void mkfs(String fstype, String device)
make a filesystem

This creates a filesystem on "device" (usually a partition or LVM logical volume). The filesystem type is "fstype", for example "ext3".

Throws: LibGuestFSException

mkfs_b

public 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. Supported block sizes depend on the filesystem type, but typically they are 1024, 2048 or 4096 only.

Throws: LibGuestFSException

mkmountpoint

public 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.

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

mknod

public 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).

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.

Throws: LibGuestFSException

mknod_b

public 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". It is just a convenient wrapper around "g.mknod".

Throws: LibGuestFSException

mknod_c

public 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". It is just a convenient wrapper around "g.mknod".

Throws: LibGuestFSException

mkswap

public void mkswap(String device)
create a swap partition

Create a swap partition on "device".

Throws: LibGuestFSException

mkswap_file

public void mkswap_file(String path)
create a swap file

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

mkswap_L

public void mkswap_L(String label, String device)
create a swap partition with a label

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

mkswap_U

public void mkswap_U(String uuid, String device)
create a swap partition with an explicit UUID

Create a swap partition on "device" with UUID "uuid".

Throws: LibGuestFSException

modprobe

public void modprobe(String modulename)
load a kernel module

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

public 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. 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.

The filesystem options "sync" and "noatime" are set with this call, in order to improve reliability.

Throws: LibGuestFSException

mountpoints

public HashMap<String,String> mountpoints()
show mountpoints

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

mounts

public String[] mounts()
show mounted filesystems

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

mount_loop

public 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. It is entirely equivalent to the command "mount -o loop file mountpoint".

Throws: LibGuestFSException

mount_options

public 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.

Throws: LibGuestFSException

mount_ro

public 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.

Throws: LibGuestFSException

mount_vfs

public 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.

Throws: LibGuestFSException

mv

public 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.

Throws: LibGuestFSException

ntfs_3g_probe

public 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. (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

ping_daemon

public void ping_daemon()
ping the guest daemon

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

pvcreate

public 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".

Throws: LibGuestFSException

pvremove

public void pvremove(String device)
remove an LVM physical volume

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

pvresize

public 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.

Throws: LibGuestFSException

pvs

public String[] pvs()
list the LVM physical volumes (PVs)

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

pvs_full

public PV[] pvs_full()
list the LVM physical volumes (PVs)

List all the physical volumes detected. This is the equivalent of the pvs(8) command. The "full" version includes all fields.

Throws: LibGuestFSException

readdir

public Dirent[] readdir(String dir)
read directories entries

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

readlink

public String readlink(String path)
read the target of a symbolic link

This command reads the target of a symbolic link.

Throws: LibGuestFSException

read_file

public String read_file(String path)
read a file

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. To transfer large files you should use FTP.

Throws: LibGuestFSException

read_lines

public String[] read_lines(String path)
read file as lines

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

realpath

public String realpath(String path)
canonicalized absolute pathname

Return the canonicalized absolute pathname of "path". The returned path has no ".", ".." or symbolic link path elements.

Throws: LibGuestFSException

removexattr

public 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".

See also: "g.lremovexattr", attr(5).

Throws: LibGuestFSException

resize2fs

public void resize2fs(String device)
resize an ext2/ext3 filesystem

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

rm

public void rm(String path)
remove a file

Remove the single file "path".

Throws: LibGuestFSException

rmdir

public void rmdir(String path)
remove a directory

Remove the single directory "path".

Throws: LibGuestFSException

rmmountpoint

public void rmmountpoint(String exemptpath)
remove a mountpoint

This calls removes a mountpoint that was previously created with "g.mkmountpoint". See "g.mkmountpoint" for full details.

Throws: LibGuestFSException

rm_rf

public 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. This is like the "rm -rf" shell command.

Throws: LibGuestFSException

scrub_device

public void scrub_device(String device)
scrub (securely wipe) a device

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

scrub_file

public void scrub_file(String file)
scrub (securely wipe) a file

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

scrub_freespace

public 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. 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

setcon

public void setcon(String context)
set SELinux security context

This sets the SELinux security context of the daemon to the string "context".

See the documentation about SELINUX in guestfs(3).

Throws: LibGuestFSException

setxattr

public 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"). The value is arbitrary 8 bit data.

See also: "g.lsetxattr", attr(5).

Throws: LibGuestFSException

set_append

public 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.

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

set_autosync

public void set_autosync(boolean autosync)
set autosync mode

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

set_direct

public 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.

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

set_e2label

public 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". 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

set_e2uuid

public 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". 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

set_memsize

public void set_memsize(int memsize)
set memory allocated to the qemu subprocess

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_path

public void set_path(String searchpath)
set the search path

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_qemu

public void set_qemu(String qemu)
set the qemu binary

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.

Throws: LibGuestFSException

set_selinux

public 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. 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

set_trace

public 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. 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

set_verbose

public void set_verbose(boolean verbose)
set verbose mode

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

sfdisk

public 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.

"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"

This command is dangerous. Without careful use you can easily destroy all your data.

Throws: LibGuestFSException

sfdiskM

public 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.

See also "g.sfdisk" and the sfdisk(8) manpage.

This command is dangerous. Without careful use you can easily destroy all your data.

Throws: LibGuestFSException

sfdisk_disk_geometry

public 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. 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

sfdisk_kernel_geometry

public String sfdisk_kernel_geometry(String device)
display the kernel geometry

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

sfdisk_l

public 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. It is not intended to be parsed.

Throws: LibGuestFSException

sfdisk_N

public 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).

For other parameters, see "g.sfdisk". You should usually pass 0 for the cyls/heads/sectors parameters.

This command is dangerous. Without careful use you can easily destroy all your data.

Throws: LibGuestFSException

sh

public 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".

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

sh_lines

public 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.

See also: "g.command_lines"

Throws: LibGuestFSException

sleep

public void sleep(int secs)
sleep for some seconds

Sleep for "secs" seconds.

Throws: LibGuestFSException

stat

public Stat stat(String path)
get file information

Returns file information for the given "path".

This is the same as the stat(2) system call.

Throws: LibGuestFSException

statvfs

public StatVFS statvfs(String path)
get file system statistics

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

strings

public 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.

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. To transfer large files you should use FTP.

Throws: LibGuestFSException

strings_e

public 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.

See the strings(1) manpage for the full list of encodings.

Commonly useful encodings are "l" (lower case L) which will show strings inside Windows/x86 files.

The returned strings are transcoded to UTF-8.

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. To transfer large files you should use FTP.

Throws: LibGuestFSException

swapoff_device

public void swapoff_device(String device)
disable swap on device

This command disables the libguestfs appliance swap device or partition named "device". See "g.swapon_device".

Throws: LibGuestFSException

swapoff_file

public void swapoff_file(String file)
disable swap on file

This command disables the libguestfs appliance swap on file.

Throws: LibGuestFSException

swapoff_label

public void swapoff_label(String label)
disable swap on labeled swap partition

This command disables the libguestfs appliance swap on labeled swap partition.

Throws: LibGuestFSException

swapoff_uuid

public void swapoff_uuid(String uuid)
disable swap on swap partition by UUID

This command disables the libguestfs appliance swap partition with the given UUID.

Throws: LibGuestFSException

swapon_device

public void swapon_device(String device)
enable swap on device

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

swapon_file

public void swapon_file(String file)
enable swap on file

This command enables swap to a file. See "g.swapon_device" for other notes.

Throws: LibGuestFSException

swapon_label

public void swapon_label(String label)
enable swap on labeled swap partition

This command enables swap to a labeled swap partition. See "g.swapon_device" for other notes.

Throws: LibGuestFSException

swapon_uuid

public void swapon_uuid(String uuid)
enable swap on swap partition by UUID

This command enables swap to a swap partition with the given UUID. See "g.swapon_device" for other notes.

Throws: LibGuestFSException

sync

public 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.

You should always call this if you have modified a disk image, before closing the handle.

Throws: LibGuestFSException

tail

public 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.

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. To transfer large files you should use FTP.

Throws: LibGuestFSException

tail_n

public 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".

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. To transfer large files you should use FTP.

Throws: LibGuestFSException

tar_in

public 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".

To upload a compressed tarball, use "g.tgz_in".

Throws: LibGuestFSException

tar_out

public 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".

To download a compressed tarball, use "g.tgz_out".

Throws: LibGuestFSException

test0

public void test0(String str, String optstr, String[] strlist, boolean b, int integer, String filein, String fileout)

test0rbool

public boolean test0rbool(String val)

test0rboolerr

public boolean test0rboolerr()

test0rconstoptstring

public String test0rconstoptstring(String val)

test0rconstoptstringerr

public String test0rconstoptstringerr()

test0rconststring

public String test0rconststring(String val)

test0rconststringerr

public String test0rconststringerr()

test0rhashtable

public HashMap<String,String> test0rhashtable(String val)

test0rhashtableerr

public HashMap<String,String> test0rhashtableerr()

test0rint

public int test0rint(String val)

test0rint64

public long test0rint64(String val)

test0rint64err

public long test0rint64err()

test0rinterr

public int test0rinterr()

test0rstring

public String test0rstring(String val)

test0rstringerr

public String test0rstringerr()

test0rstringlist

public String[] test0rstringlist(String val)

test0rstringlisterr

public String[] test0rstringlisterr()

test0rstruct

public PV test0rstruct(String val)

test0rstructerr

public PV test0rstructerr()

test0rstructlist

public PV[] test0rstructlist(String val)

test0rstructlisterr

public PV[] test0rstructlisterr()

tgz_in

public 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".

To upload an uncompressed tarball, use "g.tar_in".

Throws: LibGuestFSException

tgz_out

public 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".

To download an uncompressed tarball, use "g.tar_out".

Throws: LibGuestFSException

touch

public void touch(String path)
update file timestamps or create a new file

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

tune2fs_l

public 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".

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

umask

public 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".

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

umount

public void umount(String pathordevice)
unmount a filesystem

This unmounts the given filesystem. The filesystem may be specified either by its mountpoint (path) or the device which contains the filesystem.

Throws: LibGuestFSException

umount_all

public void umount_all()
unmount all filesystems

This unmounts all mounted filesystems.

Some internal mounts are not unmounted by this call.

Throws: LibGuestFSException

upload

public void upload(String filename, String remotefilename)
upload a file from the local machine

Upload local file "filename" to "remotefilename" on the filesystem.

"filename" can also be a named pipe.

See also "g.download".

Throws: LibGuestFSException

version

public Version version()
get the library version number

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.

Throws: LibGuestFSException

vgcreate

public 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".

Throws: LibGuestFSException

vgremove

public void vgremove(String vgname)
remove an LVM volume group

Remove an LVM volume group "vgname", (for example "VG").

This also forcibly removes all logical volumes in the volume group (if any).

Throws: LibGuestFSException

vgs

public String[] vgs()
list the LVM volume groups (VGs)

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

vgs_full

public VG[] vgs_full()
list the LVM volume groups (VGs)

List all the volumes groups detected. This is the equivalent of the vgs(8) command. The "full" version includes all fields.

Throws: LibGuestFSException

vg_activate

public 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". 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

vg_activate_all

public 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. 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

wait_ready

public void wait_ready()
wait until the qemu subprocess launches (no op)

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

wc_c

public int wc_c(String path)
count characters in a file

This command counts the characters in a file, using the "wc -c" external command.

Throws: LibGuestFSException

wc_l

public int wc_l(String path)
count lines in a file

This command counts the lines in a file, using the "wc -l" external command.

Throws: LibGuestFSException

wc_w

public int wc_w(String path)
count words in a file

This command counts the words in a file, using the "wc -w" external command.

Throws: LibGuestFSException

write_file

public void write_file(String path, String content, int size)
create a file

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. To transfer large files you should use FTP.

Throws: LibGuestFSException

zegrep

public String[] zegrep(String regex, String path)
return lines matching a pattern

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. To transfer large files you should use FTP.

Throws: LibGuestFSException

zegrepi

public String[] zegrepi(String regex, String path)
return lines matching a pattern

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. To transfer large files you should use FTP.

Throws: LibGuestFSException

zero

public void zero(String device)
write zeroes to the device

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

zerofree

public void zerofree(String device)
zero unused inodes and disk blocks on ext2/3 filesystem

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

zfgrep

public String[] zfgrep(String pattern, String path)
return lines matching a pattern

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. To transfer large files you should use FTP.

Throws: LibGuestFSException

zfgrepi

public String[] zfgrepi(String pattern, String path)
return lines matching a pattern

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. To transfer large files you should use FTP.

Throws: LibGuestFSException

zfile

public String zfile(String meth, String path)
determine file type inside a compressed file

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

zgrep

public String[] zgrep(String regex, String path)
return lines matching a pattern

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. To transfer large files you should use FTP.

Throws: LibGuestFSException

zgrepi

public String[] zgrepi(String regex, String path)
return lines matching a pattern

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. To transfer large files you should use FTP.

Throws: LibGuestFSException