com.redhat.et.libguestfs

Class GuestFS

public class GuestFS extends Object

The GuestFS object is a libguestfs handle.
Constructor Summary
GuestFS(Map<String,Object> optargs)
Create a libguestfs handle, setting flags.
GuestFS()
Create a libguestfs handle.
Method Summary
voidacl_delete_def_file(String dir)
delete the default POSIX ACL of a directory

This function deletes the default POSIX Access Control List (ACL) attached to directory "dir".

Stringacl_get_file(String path, String acltype)
get the POSIX ACL attached to a file

This function returns the POSIX Access Control List (ACL) attached to "path".

voidacl_set_file(String path, String acltype, String acl)
set the POSIX ACL attached to a file

This function sets the POSIX Access Control List (ACL) attached to "path".

voidadd_cdrom(String filename)
add a CD-ROM disk image to examine

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

intadd_domain(String dom, Map<String,Object> optargs)
add the disk(s) from a named libvirt domain

This function adds the disk(s) attached to the named libvirt domain "dom".

intadd_domain(String dom)
voidadd_drive(String filename, Map<String,Object> optargs)
add an image to examine or modify

This function adds a disk image called "filename" to the handle.

voidadd_drive(String filename)
voidadd_drive_opts(String filename, Map<String,Object> optargs)
voidadd_drive_opts(String filename)
voidadd_drive_ro(String filename)
add a drive in snapshot mode (read-only)

This function is the equivalent of calling "g.add_drive_opts" with the optional parameter "GUESTFS_ADD_DRIVE_OPTS_READONLY" set to 1, so the disk is added read-only, with the format being detected automatically.

voidadd_drive_ro_with_if(String filename, String iface)
add a drive read-only specifying the QEMU block emulation to use

This is the same as "g.add_drive_ro" but it allows you to specify the QEMU interface emulation to use at run time.

voidadd_drive_with_if(String filename, String iface)
add a drive specifying the QEMU block emulation to use

This is the same as "g.add_drive" but it allows you to specify the QEMU interface emulation to use at run time.

voidaug_clear(String augpath)
clear Augeas path

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

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

voidavailable(String[] groups)
test availability of some parts of the API

This command is used to check the availability of some groups of functionality in the appliance, which not all builds of the libguestfs appliance will be able to provide.

String[]available_all_groups()
return a list of all optional groups

This command returns a list of all optional groups that this daemon knows about.

voidbase64_in(String base64file, String filename)
upload base64-encoded data to file

This command uploads base64-encoded data from "base64file" to "filename".

voidbase64_out(String filename, String base64file)
download file and encode as base64

This command downloads the contents of "filename", writing it out to local file "base64file" encoded as base64.

Map<String,String>blkid(String device)
print block device attributes

This command returns block device attributes for "device".

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.

voidbtrfs_device_add(String[] devices, String fs)
add devices to a btrfs filesystem

Add the list of device(s) in "devices" to the btrfs filesystem mounted at "fs".

voidbtrfs_device_delete(String[] devices, String fs)
remove devices from a btrfs filesystem

Remove the "devices" from the btrfs filesystem mounted at "fs".

voidbtrfs_filesystem_balance(String fs)
balance a btrfs filesystem

Balance the chunks in the btrfs filesystem mounted at "fs" across the underlying devices.

voidbtrfs_filesystem_resize(String mountpoint, Map<String,Object> optargs)
resize a btrfs filesystem

This command resizes a btrfs filesystem.

voidbtrfs_filesystem_resize(String mountpoint)
voidbtrfs_filesystem_sync(String fs)
sync a btrfs filesystem

Force sync on the btrfs filesystem mounted at "fs".

voidbtrfs_fsck(String device, Map<String,Object> optargs)
check a btrfs filesystem

Used to check a btrfs filesystem, "device" is the device file where the filesystem is stored.

voidbtrfs_fsck(String device)
voidbtrfs_set_seeding(String device, boolean seeding)
enable or disable the seeding feature of device

Enable or disable the seeding feature of a device that contains a btrfs filesystem.

voidbtrfs_subvolume_create(String dest)
create a btrfs snapshot

Create a btrfs subvolume.

voidbtrfs_subvolume_delete(String subvolume)
delete a btrfs snapshot

Delete the named btrfs subvolume.

BTRFSSubvolume[]btrfs_subvolume_list(String fs)
list btrfs snapshots and subvolumes

List the btrfs snapshots and subvolumes of the btrfs filesystem which is mounted at "fs".

voidbtrfs_subvolume_set_default(long id, String fs)
set default btrfs subvolume

Set the subvolume of the btrfs filesystem "fs" which will be mounted by default.

voidbtrfs_subvolume_snapshot(String source, String dest)
create a writable btrfs snapshot

Create a writable snapshot of the btrfs subvolume "source".

Stringcanonical_device_name(String device)
return canonical device name

This utility function is useful when displaying device names to the user.

Stringcap_get_file(String path)
get the Linux capabilities attached to a file

This function returns the Linux capabilities attached to "path".

voidcap_set_file(String path, String cap)
set the Linux capabilities attached to a file

This function sets the Linux capabilities attached to "path".

Stringcase_sensitive_path(String path)
return true path on case-insensitive filesystem

This can be used to resolve case insensitive paths on a filesystem which is case sensitive.

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

voidchecksums_out(String csumtype, String directory, String sumsfile)
compute MD5, SHAx or CRC checksum of files in a directory

This command computes the checksums of all regular files in "directory" and then emits a list of those checksums to the local output file "sumsfile".

Stringchecksum_device(String csumtype, String device)
compute MD5, SHAx or CRC checksum of the contents of a device

This call computes the MD5, SHAx or CRC checksum of the contents of the device named "device".

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.

voidcompress_device_out(String ctype, String device, String zdevice, Map<String,Object> optargs)
output compressed device

This command compresses "device" and writes it out to the local file "zdevice".

voidcompress_device_out(String ctype, String device, String zdevice)
voidcompress_out(String ctype, String file, String zfile, Map<String,Object> optargs)
output compressed file

This command compresses "file" and writes it out to the local file "zfile".

voidcompress_out(String ctype, String file, String zfile)
voidconfig(String qemuparam, String qemuvalue)
add qemu parameters

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

voidcopy_device_to_device(String src, String dest, Map<String,Object> optargs)
copy from source device to destination device

The four calls "g.copy_device_to_device", "g.copy_device_to_file", "g.copy_file_to_device", and "g.copy_file_to_file" let you copy from a source (device|file) to a destination (device|file).

voidcopy_device_to_device(String src, String dest)
voidcopy_device_to_file(String src, String dest, Map<String,Object> optargs)
copy from source device to destination file

See "g.copy_device_to_device" for a general overview of this call.

voidcopy_device_to_file(String src, String dest)
voidcopy_file_to_device(String src, String dest, Map<String,Object> optargs)
copy from source file to destination device

See "g.copy_device_to_device" for a general overview of this call.

voidcopy_file_to_device(String src, String dest)
voidcopy_file_to_file(String src, String dest, Map<String,Object> optargs)
copy from source file to destination file

See "g.copy_device_to_device" for a general overview of this call.

voidcopy_file_to_file(String src, String dest)
voidcopy_size(String src, String dest, long size)
copy size bytes from source to destination using dd

This command copies exactly "size" bytes from one source device or file "src" to another destination device or file "dest".

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.

voiddd(String src, String dest)
copy from source to destination using dd

This command copies from one source device or file "src" to another destination device or file "dest".

Stringdebug(String subcmd, String[] extraargs)
String[]debug_drives()
voiddebug_upload(String filename, String tmpname, int mode)
intdevice_index(String device)
convert device to index

This function takes a device name (eg.

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.

Stringdisk_format(String filename)
detect the disk format of a disk image

Detect and return the format of the disk image called "filename".

booleandisk_has_backing_file(String filename)
return whether disk has a backing file

Detect and return whether the disk image "filename" has a backing file.

longdisk_virtual_size(String filename)
return virtual size of a disk

Detect and return the virtual size in bytes of the disk image called "filename".

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.

voiddownload_offset(String remotefilename, String filename, long offset, long size)
download a file to the local machine with offset and size

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(String device, Map<String,Object> optargs)
check an ext2/ext3 filesystem

This runs the ext2/ext3 filesystem checker on "device".

voide2fsck(String device)
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 concatenates 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.

voidfallocate64(String path, long 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.

longfilesize(String file)
return the size of the file in bytes

This command returns the size of "file" in bytes.

booleanfilesystem_available(String filesystem)
check if filesystem is available

Check whether libguestfs supports the named filesystem.

Stringfile_architecture(String filename)
detect the architecture of a binary file

This detects the architecture of the binary "filename", and returns it if known.

voidfill(int c, int len, String path)
fill a file with octets

This command creates a new file called "path".

voidfill_dir(String dir, int nr)
fill a directory with empty files

This function, useful for testing filesystems, creates "nr" empty files in the directory "dir" with names 00000000 through "nr-1" (ie. each file name is 8 digits long padded with zeroes).

voidfill_pattern(String pattern, int len, String path)
fill a file with a repeating pattern of bytes

This function is like "g.fill" except that it creates a new file of length "len" containing the repeating pattern of bytes in "pattern".

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

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

voidfind0(String directory, String files)
find all files and directories, returning NUL-separated list

This command lists out all files and directories, recursively, starting at "directory", placing the resulting list in the external file called "files".

Stringfindfs_label(String label)
find a filesystem by label

This command searches the filesystems and returns the one which has the given label.

Stringfindfs_uuid(String uuid)
find a filesystem by UUID

This command searches the filesystems and returns the one which has the given UUID.

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

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

voidfstrim(String mountpoint, Map<String,Object> optargs)
trim free space in a filesystem

Trim the free space in the filesystem mounted on "mountpoint".

voidfstrim(String mountpoint)
Stringgetcon()
get SELinux security context

This gets the SELinux security context of the daemon.

Stringgetxattr(String path, String name)
get a single extended attribute

Get a single extended attribute from file "path" named "name".

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.

Stringget_attach_method()
get the attach method

Return the current attach method.

booleanget_autosync()
get autosync mode

Get the autosync flag.

Stringget_cachedir()
get the appliance cache directory

Get the directory used by the handle to store the appliance cache.

booleanget_direct()
get direct appliance mode flag

Return the direct appliance mode flag.

Stringget_e2attrs(String file)
get ext2 file attributes of a file

This returns the file attributes associated with "file".

longget_e2generation(String file)
get ext2 file generation of a file

This returns the ext2 file generation of a file.

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

String[]get_libvirt_requested_credentials()
get list of credentials requested by libvirt

This should only be called during the event callback for events of type "GUESTFS_EVENT_LIBVIRT_AUTH".

Stringget_libvirt_requested_credential_challenge(int index)
challenge of i'th requested credential

Get the challenge (provided by libvirt) for the "index"'th requested credential.

Stringget_libvirt_requested_credential_defresult(int index)
default result of i'th requested credential

Get the default result (provided by libvirt) for the "index"'th requested credential.

Stringget_libvirt_requested_credential_prompt(int index)
prompt of i'th requested credential

Get the prompt (provided by libvirt) for the "index"'th requested credential.

intget_memsize()
get memory allocated to the qemu subprocess

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

booleanget_network()
get enable network flag

This returns the enable network flag.

Stringget_path()
get the search path

Return the current search path.

booleanget_pgroup()
get process group flag

This returns the process group flag.

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_recovery_proc()
get recovery process enabled flag

Return the recovery process enabled flag.

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_smp()
get number of virtual CPUs in appliance

This returns the number of virtual CPUs assigned to the appliance.

intget_state()
get the current state

This returns the current state as an opaque integer.

Stringget_tmpdir()
get the temporary directory

Get the directory used by the handle to store temporary files.

booleanget_trace()
get command trace enabled flag

Return the command trace flag.

intget_umask()
get the current umask

Return the current umask.

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, Map<String,Object> optargs)
return lines matching a pattern

This calls the external "grep" program and returns the matching lines.

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

This calls the external "grep -i" program and returns the matching lines.

String[]grep_opts(String regex, String path, Map<String,Object> optargs)
String[]grep_opts(String regex, String path)
voidgrub_install(String root, String device)
install GRUB 1

This command installs GRUB 1 (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".

voidhivex_close()
close the current hivex handle

Close the current hivex handle.

voidhivex_commit(String filename)
commit (write) changes back to the hive

Commit (write) changes to the hive.

longhivex_node_add_child(long parent, String name)
add a child node

Add a child node to "parent" named "name".

HivexNode[]hivex_node_children(long nodeh)
return list of nodes which are subkeys of node

Return the list of nodes which are subkeys of "nodeh".

voidhivex_node_delete_child(long nodeh)
delete a node (recursively)

Delete "nodeh", recursively if necessary.

longhivex_node_get_child(long nodeh, String name)
return the named child of node

Return the child of "nodeh" with the name "name", if it exists.

longhivex_node_get_value(long nodeh, String key)
return the named value

Return the value attached to "nodeh" which has the name "key", if it exists.

Stringhivex_node_name(long nodeh)
return the name of the node

Return the name of "nodeh".

longhivex_node_parent(long nodeh)
return the parent of node

Return the parent node of "nodeh".

voidhivex_node_set_value(long nodeh, String key, long t, byte[] val)
set or replace a single value in a node

Set or replace a single value under the node "nodeh".

HivexValue[]hivex_node_values(long nodeh)
return list of values attached to node

Return the array of (key, datatype, data) tuples attached to "nodeh".

voidhivex_open(String filename, Map<String,Object> optargs)
open a Windows Registry hive file

Open the Windows Registry hive file named "filename".

voidhivex_open(String filename)
longhivex_root()
return the root node of the hive

Return the root node of the hive.

Stringhivex_value_key(long valueh)
return the key field from the (key, datatype, data) tuple

Return the key (name) field of a (key, datatype, data) tuple.

longhivex_value_type(long valueh)
return the data type from the (key, datatype, data) tuple

Return the data type field from a (key, datatype, data) tuple.

Stringhivex_value_utf8(long valueh)
return the data field from the (key, datatype, data) tuple

This calls "g.hivex_value_value" (which returns the data field from a hivex value tuple).

Stringhivex_value_value(long valueh)
return the data field from the (key, datatype, data) tuple

Return the data field of a (key, datatype, data) tuple.

Stringinitrd_cat(String initrdpath, String filename)
list the contents of a single file in an initrd

This command unpacks the file "filename" from the initrd file called "initrdpath".

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

This command lists out files contained in an initrd.

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.

Stringinspect_get_arch(String root)
get architecture of inspected operating system

This returns the architecture of the inspected operating system.

Stringinspect_get_distro(String root)
get distro of inspected operating system

This returns the distro (distribution) of the inspected operating system.

Map<String,String>inspect_get_drive_mappings(String root)
get drive letter mappings

This call is useful for Windows which uses a primitive system of assigning drive letters (like "C:") to partitions.

String[]inspect_get_filesystems(String root)
get filesystems associated with inspected operating system

This returns a list of all the filesystems that we think are associated with this operating system.

Stringinspect_get_format(String root)
get format of inspected operating system

This returns the format of the inspected operating system.

Stringinspect_get_hostname(String root)
get hostname of the operating system

This function returns the hostname of the operating system as found by inspection of the guest's configuration files.

Stringinspect_get_icon(String root, Map<String,Object> optargs)
get the icon corresponding to this operating system

This function returns an icon corresponding to the inspected operating system.

Stringinspect_get_icon(String root)
intinspect_get_major_version(String root)
get major version of inspected operating system

This returns the major version number of the inspected operating system.

intinspect_get_minor_version(String root)
get minor version of inspected operating system

This returns the minor version number of the inspected operating system.

Map<String,String>inspect_get_mountpoints(String root)
get mountpoints of inspected operating system

This returns a hash of where we think the filesystems associated with this operating system should be mounted.

Stringinspect_get_package_format(String root)
get package format used by the operating system

This function and "g.inspect_get_package_management" return the package format and package management tool used by the inspected operating system.

Stringinspect_get_package_management(String root)
get package management tool used by the operating system

"g.inspect_get_package_format" and this function return the package format and package management tool used by the inspected operating system.

Stringinspect_get_product_name(String root)
get product name of inspected operating system

This returns the product name of the inspected operating system.

Stringinspect_get_product_variant(String root)
get product variant of inspected operating system

This returns the product variant of the inspected operating system.

String[]inspect_get_roots()
return list of operating systems found by last inspection

This function is a convenient way to get the list of root devices, as returned from a previous call to "g.inspect_os", but without redoing the whole inspection process.

Stringinspect_get_type(String root)
get type of inspected operating system

This returns the type of the inspected operating system.

Stringinspect_get_windows_current_control_set(String root)
get Windows CurrentControlSet of inspected operating system

This returns the Windows CurrentControlSet of the inspected guest.

Stringinspect_get_windows_systemroot(String root)
get Windows systemroot of inspected operating system

This returns the Windows systemroot of the inspected guest.

booleaninspect_is_live(String root)
get live flag for install disk

If "g.inspect_get_format" returns "installer" (this is an install disk), then this returns true if a live image was detected on the disk.

booleaninspect_is_multipart(String root)
get multipart flag for install disk

If "g.inspect_get_format" returns "installer" (this is an install disk), then this returns true if the disk is part of a set.

booleaninspect_is_netinst(String root)
get netinst (network installer) flag for install disk

If "g.inspect_get_format" returns "installer" (this is an install disk), then this returns true if the disk is a network installer, ie. not a self-contained install CD but one which is likely to require network access to complete the install.

Application[]inspect_list_applications(String root)
get list of applications installed in the operating system

Return the list of applications installed in the operating system.

Application2[]inspect_list_applications2(String root)
get list of applications installed in the operating system

Return the list of applications installed in the operating system.

String[]inspect_os()
inspect disk and return list of operating systems found

This function uses other libguestfs functions and certain heuristics to inspect the disk(s) (usually disks belonging to a virtual machine), looking for operating systems.

voidinternal_autosync()
voidinternal_hot_add_drive(String label)
voidinternal_hot_remove_drive(String label)
voidinternal_hot_remove_drive_precheck(String label)
Stat[]internal_lstatlist(String path, String[] names)
XAttr[]internal_lxattrlist(String path, String[] names)
String[]internal_readlinklist(String path, String[] names)
voidinternal_test(String str, String optstr, String[] strlist, boolean b, int integer, long integer64, String filein, String fileout, byte[] bufferin, Map<String,Object> optargs)
voidinternal_test(String str, String optstr, String[] strlist, boolean b, int integer, long integer64, String filein, String fileout, byte[] bufferin)
voidinternal_test_63_optargs(Map<String,Object> optargs)
voidinternal_test_63_optargs()
voidinternal_test_close_output()
voidinternal_test_only_optargs(Map<String,Object> optargs)
voidinternal_test_only_optargs()
booleaninternal_test_rbool(String val)
booleaninternal_test_rboolerr()
Stringinternal_test_rbufferout(String val)
Stringinternal_test_rbufferouterr()
Stringinternal_test_rconstoptstring(String val)
Stringinternal_test_rconstoptstringerr()
Stringinternal_test_rconststring(String val)
Stringinternal_test_rconststringerr()
Map<String,String>internal_test_rhashtable(String val)
Map<String,String>internal_test_rhashtableerr()
intinternal_test_rint(String val)
longinternal_test_rint64(String val)
longinternal_test_rint64err()
intinternal_test_rinterr()
Stringinternal_test_rstring(String val)
Stringinternal_test_rstringerr()
String[]internal_test_rstringlist(String val)
String[]internal_test_rstringlisterr()
PVinternal_test_rstruct(String val)
PVinternal_test_rstructerr()
PV[]internal_test_rstructlist(String val)
PV[]internal_test_rstructlisterr()
voidinternal_test_set_output(String filename)
voidinternal_write(String path, byte[] content)
voidinternal_write_append(String path, byte[] content)
ISOInfoisoinfo(String isofile)
get ISO information from primary volume descriptor of ISO file

This is the same as "g.isoinfo_device" except that it works for an ISO file located inside some other mounted filesystem.

ISOInfoisoinfo_device(String device)
get ISO information from primary volume descriptor of device

"device" is an ISO device.

booleanis_blockdev(String path)
test if block device

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

booleanis_busy()
booleanis_chardev(String path)
test if character device

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

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 a directory

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

booleanis_fifo(String path)
test if FIFO (named pipe)

This returns "true" if and only if there is a FIFO (named pipe) with the given "path" name.

booleanis_file(String path)
test if a regular file

This returns "true" if and only if there is a regular 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_lv(String device)
test if device is a logical volume

This command tests whether "device" is a logical volume, and returns true iff this is the case.

booleanis_ready()
is ready to accept commands

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

booleanis_socket(String path)
test if socket

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

booleanis_symlink(String path)
test if symbolic link

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

booleanis_zero(String path)
test if a file contains all zero bytes

This returns true iff the file exists and the file is empty or it contains all zero bytes.

booleanis_zero_device(String device)
test if a device contains all zero bytes

This returns true iff the device exists and contains all zero bytes.

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

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

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

voidldmtool_create_all()
scan and create Windows dynamic disk volumes

This function scans all block devices looking for Windows dynamic disk volumes and partitions, and creates devices for any that were found.

String[]ldmtool_diskgroup_disks(String diskgroup)
return the disks in a Windows dynamic disk group

Return the disks in a Windows dynamic disk group.

Stringldmtool_diskgroup_name(String diskgroup)
return the name of a Windows dynamic disk group

Return the name of a Windows dynamic disk group.

String[]ldmtool_diskgroup_volumes(String diskgroup)
return the volumes in a Windows dynamic disk group

Return the volumes in a Windows dynamic disk group.

voidldmtool_remove_all()
remove all Windows dynamic disk volumes

This is essentially the opposite of "g.ldmtool_create_all".

String[]ldmtool_scan()
scan for Windows dynamic disks

This function scans for Windows dynamic disks.

String[]ldmtool_scan_devices(String[] devices)
scan for Windows dynamic disks

This function scans for Windows dynamic disks.

Stringldmtool_volume_hint(String diskgroup, String volume)
return the hint field of a Windows dynamic disk volume

Return the hint field of the volume named "volume" in the disk group with GUID .

String[]ldmtool_volume_partitions(String diskgroup, String volume)
return the partitions in a Windows dynamic disk volume

Return the list of partitions in the volume named "volume" in the disk group with GUID .

Stringldmtool_volume_type(String diskgroup, String volume)
return the type of a Windows dynamic disk volume

Return the type of the volume named "volume" in the disk group with GUID .

Stringlgetxattr(String path, String name)
get a single extended attribute

Get a single extended attribute from file "path" named "name".

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_9p()
list 9p filesystems

List all 9p filesystems attached to the guest.

String[]list_devices()
list the block devices

List all the block devices.

Map<String,String>list_disk_labels()
mapping of disk labels to devices

If you add drives using the optional "label" parameter of "g.add_drive_opts", you can use this call to map between disk labels, and raw block device and partition names (like "/dev/sda" and "/dev/sda1").

String[]list_dm_devices()
list device mapper devices

List all device mapper devices.

Map<String,String>list_filesystems()
list filesystems

This inspection command looks for filesystems on partitions, block devices and logical volumes, returning a list of devices containing filesystems and their type.

String[]list_ldm_partitions()
list all Windows dynamic disk partitions

This function returns all Windows dynamic disk partitions that were found at launch time.

String[]list_ldm_volumes()
list all Windows dynamic disk volumes

This function returns all Windows dynamic disk volumes that were found at launch time.

String[]list_md_devices()
list Linux md (RAID) devices

List all Linux md 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'.

Stringllz(String directory)
list the files in a directory (long format with SELinux contexts)

List the files in "directory" in the format of 'ls -laZ'.

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

voidls0(String dir, String filenames)
get list of files in a directory

This specialized command is used to get a listing of the filenames in the directory "dir".

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

Stat[]lstatlist(String path, String[] names)
lstat on multiple files

This call allows you to perform the "g.lstat" operation on multiple files, where all files are in the directory "path".

voidluks_add_key(String device, String key, String newkey, int keyslot)
add a key on a LUKS encrypted device

This command adds a new key on LUKS device "device".

voidluks_close(String device)
close a LUKS device

This closes a LUKS device that was created earlier by "g.luks_open" or "g.luks_open_ro".

voidluks_format(String device, String key, int keyslot)
format a block device as a LUKS encrypted device

This command erases existing data on "device" and formats the device as a LUKS encrypted device.

voidluks_format_cipher(String device, String key, int keyslot, String cipher)
format a block device as a LUKS encrypted device

This command is the same as "g.luks_format" but it also allows you to set the "cipher" used.

voidluks_kill_slot(String device, String key, int keyslot)
remove a key from a LUKS encrypted device

This command deletes the key in key slot "keyslot" from the encrypted LUKS device "device".

voidluks_open(String device, String key, String mapname)
open a LUKS-encrypted block device

This command opens a block device which has been encrypted according to the Linux Unified Key Setup (LUKS) standard.

voidluks_open_ro(String device, String key, String mapname)
open a LUKS-encrypted block device read-only

This is the same as "g.luks_open" except that a read-only mapping is created.

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

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

voidlvcreate_free(String logvol, String volgroup, int percent)
create an LVM logical volume in % remaining free space

Create an LVM logical volume called "/dev/volgroup/logvol", using approximately "percent" % of the free space remaining in the volume group.

Stringlvm_canonical_lv_name(String lvname)
get canonical name of an LV

This converts alternative naming schemes for LVs that you might find to the canonical name.

voidlvm_clear_filter()
clear LVM device filter

This undoes the effect of "g.lvm_set_filter".

voidlvm_remove_all()
remove all LVM LVs, VGs and PVs

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

voidlvm_set_filter(String[] devices)
set LVM device filter

This sets the LVM device filter so that LVM will only be able to "see" the block devices in the list "devices", and will ignore all other attached block devices.

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

voidlvrename(String logvol, String newlogvol)
rename an LVM logical volume

Rename a logical volume "logvol" with the new name "newlogvol".

voidlvresize(String device, int mbytes)
resize an LVM logical volume

This resizes (expands or shrinks) an existing LVM logical volume to "mbytes".

voidlvresize_free(String lv, int percent)
expand an LV to fill free space

This expands an existing logical volume "lv" so that it fills "pc"% of the remaining free space in the volume group.

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.

Stringlvuuid(String device)
get the UUID of a logical volume

This command returns the UUID of the LVM LV "device".

XAttr[]lxattrlist(String path, String[] names)
lgetxattr on multiple files

This call allows you to get the extended attributes of multiple files, where all files are in the directory "path".

intmax_disks()
maximum number of disks that may be added

Return the maximum number of disks that may be added to a handle (eg. by "g.add_drive_opts" and similar calls).

voidmd_create(String name, String[] devices, Map<String,Object> optargs)
create a Linux md (RAID) device

Create a Linux md (RAID) device named "name" on the devices in the list "devices".

voidmd_create(String name, String[] devices)
Map<String,String>md_detail(String md)
obtain metadata for an MD device

This command exposes the output of 'mdadm -DY '.

MDStat[]md_stat(String md)
get underlying devices from an MD device

This call returns a list of the underlying devices which make up the single software RAID array device "md".

voidmd_stop(String md)
stop a Linux md (RAID) device

This command deactivates the MD array named "md".

voidmkdir(String path)
create a directory

Create a directory named "path".

voidmkdir_mode(String path, int mode)
create a directory with a particular mode

This command creates a directory, setting the initial permissions of the directory to "mode".

voidmkdir_p(String path)
create a directory and parents

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

Stringmkdtemp(String tmpl)
create a temporary directory

This command creates a temporary directory.

voidmke2fs(String device, Map<String,Object> optargs)
create an ext2/ext3/ext4 filesystem on device

"mke2fs" is used to create an ext2, ext3, or ext4 filesystem on "device".

voidmke2fs(String device)
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, Map<String,Object> optargs)
make a filesystem

This function creates a filesystem on "device".

voidmkfs(String fstype, String device)
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.

voidmkfs_btrfs(String[] devices, Map<String,Object> optargs)
create a btrfs filesystem

Create a btrfs filesystem, allowing all configurables to be set.

voidmkfs_btrfs(String[] devices)
voidmkfs_opts(String fstype, String device, Map<String,Object> optargs)
voidmkfs_opts(String fstype, String device)
voidmklost_and_found(String mountpoint)
make lost+found directory on an ext2/3/4 filesystem

Make the "lost+found" directory, normally in the root directory of an ext2/3/4 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, Map<String,Object> optargs)
create a swap partition

Create a Linux swap partition on "device".

voidmkswap(String 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_opts(String device, Map<String,Object> optargs)
voidmkswap_opts(String device)
voidmkswap_U(String uuid, String device)
create a swap partition with an explicit UUID

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

Stringmktemp(String tmpl, Map<String,Object> optargs)
create a temporary file

This command creates a temporary file.

Stringmktemp(String tmpl)
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.

Map<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_9p(String mounttag, String mountpoint, Map<String,Object> optargs)
mount 9p filesystem

Mount the virtio-9p filesystem with the tag "mounttag" on the directory "mountpoint".

voidmount_9p(String mounttag, String mountpoint)
voidmount_local(String localmountpoint, Map<String,Object> optargs)
mount on the local filesystem

This call exports the libguestfs-accessible filesystem to a local mountpoint (directory) called "localmountpoint".

voidmount_local(String localmountpoint)
voidmount_local_run()
run main loop of mount on the local filesystem

Run the main loop which translates kernel calls to libguestfs calls.

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.

intnr_devices()
return number of whole block devices (disks) added

This returns the number of whole block devices that were added.

voidntfsclone_in(String backupfile, String device)
restore NTFS from backup file

Restore the "backupfile" (from a previous call to "g.ntfsclone_out") to "device", overwriting any existing contents of this device.

voidntfsclone_out(String device, String backupfile, Map<String,Object> optargs)
save NTFS to backup file

Stream the NTFS filesystem "device" to the local file "backupfile".

voidntfsclone_out(String device, String backupfile)
voidntfsfix(String device, Map<String,Object> optargs)
fix common errors and force Windows to check NTFS

This command repairs some fundamental NTFS inconsistencies, resets the NTFS journal file, and schedules an NTFS consistency check for the first boot into Windows.

voidntfsfix(String device)
voidntfsresize(String device, Map<String,Object> optargs)
resize an NTFS filesystem

This command resizes an NTFS filesystem, expanding or shrinking it to the size of the underlying device.

voidntfsresize(String device)
voidntfsresize_opts(String device, Map<String,Object> optargs)
voidntfsresize_opts(String device)
voidntfsresize_size(String device, long size)
resize an NTFS filesystem (with size)

This command is the same as "g.ntfsresize" except that it allows you to specify the new size (in bytes) explicitly.

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.

voidparse_environment()
parse the environment and set handle flags accordingly

Parse the program's environment and set flags in the handle accordingly.

voidparse_environment_list(String[] environment)
parse the environment and set handle flags accordingly

Parse the list of strings in the argument "environment" and set flags in the handle accordingly.

voidpart_add(String device, String prlogex, long startsect, long endsect)
add a partition to the device

This command adds a partition to "device".

voidpart_del(String device, int partnum)
delete a partition

This command deletes the partition numbered "partnum" on "device".

voidpart_disk(String device, String parttype)
partition whole disk with a single primary partition

This command is simply a combination of "g.part_init" followed by "g.part_add" to create a single primary partition covering the whole disk.

booleanpart_get_bootable(String device, int partnum)
return true if a partition is bootable

This command returns true if the partition "partnum" on "device" has the bootable flag set.

intpart_get_mbr_id(String device, int partnum)
get the MBR type byte (ID byte) from a partition

Returns the MBR type byte (also known as the ID byte) from the numbered partition "partnum".

Stringpart_get_parttype(String device)
get the partition table type

This command examines the partition table on "device" and returns the partition table type (format) being used.

voidpart_init(String device, String parttype)
create an empty partition table

This creates an empty partition table on "device" of one of the partition types listed below.

Partition[]part_list(String device)
list partitions on a device

This command parses the partition table on "device" and returns the list of partitions found.

voidpart_set_bootable(String device, int partnum, boolean bootable)
make a partition bootable

This sets the bootable flag on partition numbered "partnum" on device "device".

voidpart_set_mbr_id(String device, int partnum, int idbyte)
set the MBR type byte (ID byte) of a partition

Sets the MBR type byte (also known as the ID byte) of the numbered partition "partnum" to "idbyte".

voidpart_set_name(String device, int partnum, String name)
set partition name

This sets the partition name on partition numbered "partnum" on device "device".

Stringpart_to_dev(String partition)
convert partition name to device name

This function takes a partition name (eg.

intpart_to_partnum(String partition)
convert partition name to partition number

This function takes a partition name (eg.

voidping_daemon()
ping the guest daemon

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

Stringpread(String path, int count, long offset)
read part of a file

This command lets you read part of a file.

Stringpread_device(String device, int count, long offset)
read part of a device

This command lets you read part of a file.

voidpvchange_uuid(String device)
generate a new random UUID for a physical volume

Generate a new random UUID for the physical volume "device".

voidpvchange_uuid_all()
generate new random UUIDs for all physical volumes

Generate new random UUIDs for all physical volumes.

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.

voidpvresize_size(String device, long size)
resize an LVM physical volume (with size)

This command is the same as "g.pvresize" except that it allows you to specify the new size (in bytes) explicitly.

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.

Stringpvuuid(String device)
get the UUID of a physical volume

This command returns the UUID of the LVM PV "device".

intpwrite(String path, byte[] content, long offset)
write to part of a file

This command writes to part of a file.

intpwrite_device(String device, byte[] content, long offset)
write to part of a device

This command writes to part of a device.

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.

String[]readlinklist(String path, String[] names)
readlink on multiple files

This call allows you to do a "readlink" operation on multiple files, where all files are in the directory "path".

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

voidremove_drive(String label)
remove a disk image

This function is conceptually the opposite of "g.add_drive_opts".

voidresize2fs(String device)
resize an ext2, ext3 or ext4 filesystem

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

voidresize2fs_M(String device)
resize an ext2, ext3 or ext4 filesystem to the minimum size

This command is the same as "g.resize2fs", but the filesystem is resized to its minimum size.

voidresize2fs_size(String device, long size)
resize an ext2, ext3 or ext4 filesystem (with size)

This command is the same as "g.resize2fs" except that it allows you to specify the new size (in bytes) explicitly.

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_f(String path)
remove a file ignoring errors

Remove the file "path".

voidrm_rf(String path)
remove a file or directory recursively

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

voidrsync(String src, String dest, Map<String,Object> optargs)
synchronize the contents of two directories

This call may be used to copy or synchronize two directories under the same libguestfs handle.

voidrsync(String src, String dest)
voidrsync_in(String remote, String dest, Map<String,Object> optargs)
synchronize host or remote filesystem with filesystem

This call may be used to copy or synchronize the filesystem on the host or on a remote computer with the filesystem within libguestfs.

voidrsync_in(String remote, String dest)
voidrsync_out(String src, String remote, Map<String,Object> optargs)
synchronize filesystem with host or remote filesystem

This call may be used to copy or synchronize the filesystem within libguestfs with a filesystem on the host or on a remote computer.

voidrsync_out(String src, String remote)
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_attach_method(String attachmethod)
set the attach method

Set the method that libguestfs uses to connect to the back end guestfsd daemon.

voidset_autosync(boolean autosync)
set autosync mode

If "autosync" is true, this enables autosync.

voidset_cachedir(String cachedir)
set the appliance cache directory

Set the directory used by the handle to store the appliance cache, when using a supermin appliance.

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_e2attrs(String file, String attrs, Map<String,Object> optargs)
set ext2 file attributes of a file

This sets or clears the file attributes "attrs" associated with the inode "file".

voidset_e2attrs(String file, String attrs)
voidset_e2generation(String file, long generation)
set ext2 file generation of a file

This sets the ext2 file generation of a file.

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_label(String device, String label)
set filesystem label

Set the filesystem label on "device" to "label".

voidset_libvirt_requested_credential(int index, byte[] cred)
pass requested credential back to libvirt

After requesting the "index"'th credential from the user, call this function to pass the answer back to libvirt.

voidset_libvirt_supported_credentials(String[] creds)
set libvirt credentials supported by calling program

Call this function before setting an event handler for "GUESTFS_EVENT_LIBVIRT_AUTH", to supply the list of credential types that the program knows how to process.

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

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

voidset_network(boolean network)
set enable network flag

If "network" is true, then the network is enabled in the libguestfs appliance.

voidset_path(String searchpath)
set the search path

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

voidset_pgroup(boolean pgroup)
set process group flag

If "pgroup" is true, child processes are placed into their own process group.

voidset_qemu(String qemu)
set the qemu binary

Set the qemu binary that we will use.

voidset_recovery_proc(boolean recoveryproc)
enable or disable the recovery process

If this is called with the parameter "false" then "g.launch" does not create a recovery process.

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_smp(int smp)
set number of virtual CPUs in appliance

Change the number of virtual CPUs assigned to the appliance.

voidset_tmpdir(String tmpdir)
set the temporary directory

Set the directory used by the handle to store temporary files.

voidset_trace(boolean trace)
enable or disable command traces

If the command trace flag is set to 1, then libguestfs calls, parameters and return values are traced.

voidset_verbose(boolean verbose)
set verbose mode

If "verbose" is true, this turns on verbose messages.

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

voidshutdown()
shutdown the qemu subprocess

This is the opposite of "g.launch".

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 of strings that are looked for in the source file "path".

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, Map<String,Object> optargs)
unpack tarfile to directory

This command uploads and unpacks local file "tarfile" into "directory".

voidtar_in(String tarfile, String directory)
voidtar_in_opts(String tarfile, String directory, Map<String,Object> optargs)
voidtar_in_opts(String tarfile, String directory)
voidtar_out(String directory, String tarfile, Map<String,Object> optargs)
pack directory into tarfile

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

voidtar_out(String directory, String tarfile)
voidtar_out_opts(String directory, String tarfile, Map<String,Object> optargs)
voidtar_out_opts(String directory, String tarfile)
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.

voidtruncate(String path)
truncate a file to zero size

This command truncates "path" to a zero-length file.

voidtruncate_size(String path, long size)
truncate a file to a particular size

This command truncates "path" to size "size" bytes.

voidtune2fs(String device, Map<String,Object> optargs)
adjust ext2/ext3/ext4 filesystem parameters

This call allows you to adjust various filesystem parameters of an ext2/ext3/ext4 filesystem called "device".

voidtune2fs(String device)
Map<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".

voidtxz_in(String tarball, String directory)
unpack compressed tarball to directory

This command uploads and unpacks local file "tarball" (an *xz compressed* tar file) into "directory".

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

This command packs the contents of "directory" and downloads it to local file "tarball" (as an xz compressed tar archive).

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, Map<String,Object> optargs)
unmount a filesystem

This unmounts the given filesystem.

voidumount(String pathordevice)
voidumount_all()
unmount all filesystems

This unmounts all mounted filesystems.

voidumount_local(Map<String,Object> optargs)
unmount a locally mounted filesystem

If libguestfs is exporting the filesystem on a local mountpoint, then this unmounts it.

voidumount_local()
voidumount_opts(String pathordevice, Map<String,Object> optargs)
voidumount_opts(String pathordevice)
voidupload(String filename, String remotefilename)
upload a file from the local machine

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

voidupload_offset(String filename, String remotefilename, long offset)
upload a file from the local machine with offset

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

voidutimens(String path, long atsecs, long atnsecs, long mtsecs, long mtnsecs)
set timestamp of a file with nanosecond precision

This command sets the timestamps of a file with nanosecond precision.

UTSNameutsname()
appliance kernel version

This returns the kernel version of the appliance, where this is available.

Versionversion()
get the library version number

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

Stringvfs_label(String device)
get the filesystem label

This returns the filesystem label of the filesystem on "device".

Stringvfs_type(String device)
get the Linux VFS type corresponding to a mounted device

This command gets the filesystem type corresponding to the filesystem on "device".

Stringvfs_uuid(String device)
get the filesystem UUID

This returns the filesystem UUID of the filesystem on "device".

voidvgchange_uuid(String vg)
generate a new random UUID for a volume group

Generate a new random UUID for the volume group "vg".

voidvgchange_uuid_all()
generate new random UUIDs for all volume groups

Generate new random UUIDs for all volume groups.

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

String[]vglvuuids(String vgname)
get the LV UUIDs of all LVs in the volume group

Given a VG called "vgname", this returns the UUIDs of all the logical volumes created in this volume group.

Stringvgmeta(String vgname)
get volume group metadata

"vgname" is an LVM volume group.

String[]vgpvuuids(String vgname)
get the PV UUIDs containing the volume group

Given a VG called "vgname", this returns the UUIDs of all the physical volumes that this volume group resides on.

voidvgremove(String vgname)
remove an LVM volume group

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

voidvgrename(String volgroup, String newvolgroup)
rename an LVM volume group

Rename a volume group "volgroup" with the new name "newvolgroup".

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

List all the volumes groups detected.

voidvgscan()
rescan for LVM physical volumes, volume groups and logical volumes

This rescans all block devices and rebuilds the list of LVM physical volumes, volume groups and logical volumes.

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

List all the volumes groups detected.

Stringvguuid(String vgname)
get the UUID of a volume group

This command returns the UUID of the LVM VG named "vgname".

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.

voidwipefs(String device)
wipe a filesystem signature from a device

This command erases filesystem or RAID signatures from the specified "device" to make the filesystem invisible to libblkid.

voidwrite(String path, byte[] content)
create a new file

This call creates a file called "path".

voidwrite_append(String path, byte[] content)
append content to end of file

This call appends "content" to the end of file "path".

voidwrite_file(String path, String content, int size)
create a file

This call creates a file called "path".

voidxfs_admin(String device, Map<String,Object> optargs)
change parameters of an XFS filesystem

Change the parameters of the XFS filesystem on "device".

voidxfs_admin(String device)
voidxfs_growfs(String path, Map<String,Object> optargs)
expand an existing XFS filesystem

Grow the XFS filesystem mounted at "path".

voidxfs_growfs(String path)
XFSInfoxfs_info(String pathordevice)
get geometry of XFS filesystem

"pathordevice" is a mounted XFS filesystem or a device containing an XFS filesystem.

intxfs_repair(String device, Map<String,Object> optargs)
repair an XFS filesystem

Repair corrupt or damaged XFS filesystem on "device".

intxfs_repair(String device)
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".

voidzero_device(String device)
write zeroes to an entire device

This command writes zeroes over the entire "device".

voidzero_free_space(String directory)
zero free space in a filesystem

Zero the free space in the filesystem mounted on "directory".

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(Map<String,Object> optargs)
Create a libguestfs handle, setting flags.

Throws: LibGuestFSException

GuestFS

public GuestFS()
Create a libguestfs handle.

Throws: LibGuestFSException

Method Detail

acl_delete_def_file

public void acl_delete_def_file(String dir)
delete the default POSIX ACL of a directory

This function deletes the default POSIX Access Control List (ACL) attached to directory "dir".

Throws: LibGuestFSException

acl_get_file

public String acl_get_file(String path, String acltype)
get the POSIX ACL attached to a file

This function returns the POSIX Access Control List (ACL) attached to "path". The ACL is returned in "long text form" (see acl(5)).

The "acltype" parameter may be:

"access" Return the ordinary (access) ACL for any file, directory or other filesystem object.

"default" Return the default ACL. Normally this only makes sense if "path" is a directory.

Throws: LibGuestFSException

acl_set_file

public void acl_set_file(String path, String acltype, String acl)
set the POSIX ACL attached to a file

This function sets the POSIX Access Control List (ACL) attached to "path". The "acl" parameter is the new ACL in either "long text form" or "short text form" (see acl(5)).

The "acltype" parameter may be:

"access" Set the ordinary (access) ACL for any file, directory or other filesystem object.

"default" Set the default ACL. Normally this only makes sense if "path" is a directory.

Throws: LibGuestFSException

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.

Do not use this function! ISO files are just ordinary read-only disk images. Use "g.add_drive_ro" instead.

*This function is deprecated.* In new code, use the "add_drive" 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

add_domain

public int add_domain(String dom, Map<String,Object> optargs)
add the disk(s) from a named libvirt domain

This function adds the disk(s) attached to the named libvirt domain "dom". It works by connecting to libvirt, requesting the domain and domain XML from libvirt, parsing it for disks, and calling "g.add_drive_opts" on each one.

The number of disks added is returned. This operation is atomic: if an error is returned, then no disks are added.

This function does some minimal checks to make sure the libvirt domain is not running (unless "readonly" is true). In a future version we will try to acquire the libvirt lock on each disk.

Disks must be accessible locally. This often means that adding disks from a remote libvirt connection (see ) will fail unless those disks are accessible via the same device path locally too.

The optional "libvirturi" parameter sets the libvirt URI (see ). If this is not set then we connect to the default libvirt URI (or one set through an environment variable, see the libvirt documentation for full details).

The optional "live" flag controls whether this call will try to connect to a running virtual machine "guestfsd" process if it sees a suitable element in the libvirt XML definition. The default (if the flag is omitted) is never to try. See "ATTACHING TO RUNNING DAEMONS" in guestfs(3) for more information.

If the "allowuuid" flag is true (default is false) then a UUID *may* be passed instead of the domain name. The "dom" string is treated as a UUID first and looked up, and if that lookup fails then we treat "dom" as a name as usual.

The optional "readonlydisk" parameter controls what we do for disks which are marked in the libvirt XML. Possible values are:

readonlydisk = "error" If "readonly" is false:

The whole call is aborted with an error if any disk with the flag is found.

If "readonly" is true:

Disks with the flag are added read-only.

readonlydisk = "read" If "readonly" is false:

Disks with the flag are added read-only. Other disks are added read/write.

If "readonly" is true:

Disks with the flag are added read-only.

readonlydisk = "write" (default) If "readonly" is false:

Disks with the flag are added read/write.

If "readonly" is true:

Disks with the flag are added read-only.

readonlydisk = "ignore" If "readonly" is true or false:

Disks with the flag are skipped.

The other optional parameters are passed directly through to "g.add_drive_opts".

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

add_domain

public int add_domain(String dom)

add_drive

public void add_drive(String filename, Map<String,Object> optargs)
add an image to examine or modify

This function adds a disk image called "filename" to the handle. "filename" may be a regular host file or a host device.

When this function is called before "g.launch" (the usual case) then the first time you call this function, the disk appears in the API as "/dev/sda", the second time as "/dev/sdb", and so on.

In libguestfs ≥ 1.20 you can also call this function after launch (with some restrictions). This is called "hotplugging". When hotplugging, you must specify a "label" so that the new disk gets a predictable name. For more information see "HOTPLUGGING" in guestfs(3).

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 call checks that "filename" exists.

"filename" may be the special string "/dev/null". See "NULL DISKS" in guestfs(3).

The optional arguments are:

"readonly" If true then the image is treated as read-only. Writes are still allowed, but they are stored in a temporary snapshot overlay which is discarded at the end. The disk that you add is not modified.

"format" This forces the image format. If you omit this (or use "g.add_drive" or "g.add_drive_ro") then the format is automatically detected. Possible formats include "raw" and "qcow2".

Automatic detection of the format opens you up to a potential security hole when dealing with untrusted raw-format images. See CVE-2010-3851 and RHBZ#642934. Specifying the format closes this security hole.

"iface" This rarely-used option lets you emulate the behaviour of the deprecated "g.add_drive_with_if" call (q.v.)

"name" The name the drive had in the original guest, e.g. "/dev/sdb". This is used as a hint to the guest inspection process if it is available.

"label" Give the disk a label. The label should be a unique, short string using *only* ASCII characters "[a-zA-Z]". As well as its usual name in the API (such as "/dev/sda"), the drive will also be named "/dev/disk/guestfs/*label*".

See "DISK LABELS" in guestfs(3).

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

add_drive

public void add_drive(String filename)

add_drive_opts

public void add_drive_opts(String filename, Map<String,Object> optargs)

add_drive_opts

public void add_drive_opts(String filename)

add_drive_ro

public void add_drive_ro(String filename)
add a drive in snapshot mode (read-only)

This function is the equivalent of calling "g.add_drive_opts" with the optional parameter "GUESTFS_ADD_DRIVE_OPTS_READONLY" set to 1, so the disk is added read-only, with the format being detected automatically.

Throws: LibGuestFSException

add_drive_ro_with_if

public void add_drive_ro_with_if(String filename, String iface)
add a drive read-only specifying the QEMU block emulation to use

This is the same as "g.add_drive_ro" but it allows you to specify the QEMU interface emulation to use at run time.

*This function is deprecated.* In new code, use the "add_drive" 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

add_drive_with_if

public void add_drive_with_if(String filename, String iface)
add a drive specifying the QEMU block emulation to use

This is the same as "g.add_drive" but it allows you to specify the QEMU interface emulation to use at run time.

*This function is deprecated.* In new code, use the "add_drive" 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

aug_clear

public void aug_clear(String augpath)
clear Augeas path

Set the value associated with "path" to "NULL". This is the same as the augtool(1) "clear" command.

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.

This option is only useful when debugging Augeas lenses. Use of this option may require additional memory for the libguestfs appliance. You may need to set the "LIBGUESTFS_MEMSIZE" environment variable or call "g.set_memsize".

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

In the Augeas API, it is possible to clear a node by setting the value to NULL. Due to an oversight in the libguestfs API you cannot do that with this call. Instead you must use the "g.aug_clear" call.

Throws: LibGuestFSException

available

public void available(String[] groups)
test availability of some parts of the API

This command is used to check the availability of some groups of functionality in the appliance, which not all builds of the libguestfs appliance will be able to provide.

The libguestfs groups, and the functions that those groups correspond to, are listed in "AVAILABILITY" in guestfs(3). You can also fetch this list at runtime by calling "g.available_all_groups".

The argument "groups" is a list of group names, eg: "["inotify", "augeas"]" would check for the availability of the Linux inotify functions and Augeas (configuration file editing) functions.

The command returns no error if *all* requested groups are available.

It fails with an error if one or more of the requested groups is unavailable in the appliance.

If an unknown group name is included in the list of groups then an error is always returned.

*Notes:*

* You must call "g.launch" before calling this function.

The reason is because we don't know what groups are supported by the appliance/daemon until it is running and can be queried.

* If a group of functions is available, this does not necessarily mean that they will work. You still have to check for errors when calling individual API functions even if they are available.

* It is usually the job of distro packagers to build complete functionality into the libguestfs appliance. Upstream libguestfs, if built from source with all requirements satisfied, will support everything.

* This call was added in version 1.0.80. In previous versions of libguestfs all you could do would be to speculatively execute a command to find out if the daemon implemented it. See also "g.version".

See also "g.filesystem_available".

Throws: LibGuestFSException

available_all_groups

public String[] available_all_groups()
return a list of all optional groups

This command returns a list of all optional groups that this daemon knows about. Note this returns both supported and unsupported groups. To find out which ones the daemon can actually support you have to call "g.available" on each member of the returned list.

See also "g.available" and "AVAILABILITY" in guestfs(3).

Throws: LibGuestFSException

base64_in

public void base64_in(String base64file, String filename)
upload base64-encoded data to file

This command uploads base64-encoded data from "base64file" to "filename".

Throws: LibGuestFSException

base64_out

public void base64_out(String filename, String base64file)
download file and encode as base64

This command downloads the contents of "filename", writing it out to local file "base64file" encoded as base64.

Throws: LibGuestFSException

blkid

public Map<String,String> blkid(String device)
print block device attributes

This command returns block device attributes for "device". The following fields are usually present in the returned hash. Other fields may also be present.

"UUID" The uuid of this device.

"LABEL" The label of this device.

"VERSION" The version of blkid command.

"TYPE" The filesystem type or RAID of this device.

"USAGE" The usage of this device, for example "filesystem" or "raid".

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

btrfs_device_add

public void btrfs_device_add(String[] devices, String fs)
add devices to a btrfs filesystem

Add the list of device(s) in "devices" to the btrfs filesystem mounted at "fs". If "devices" is an empty list, this does nothing.

Throws: LibGuestFSException

btrfs_device_delete

public void btrfs_device_delete(String[] devices, String fs)
remove devices from a btrfs filesystem

Remove the "devices" from the btrfs filesystem mounted at "fs". If "devices" is an empty list, this does nothing.

Throws: LibGuestFSException

btrfs_filesystem_balance

public void btrfs_filesystem_balance(String fs)
balance a btrfs filesystem

Balance the chunks in the btrfs filesystem mounted at "fs" across the underlying devices.

Throws: LibGuestFSException

btrfs_filesystem_resize

public void btrfs_filesystem_resize(String mountpoint, Map<String,Object> optargs)
resize a btrfs filesystem

This command resizes a btrfs filesystem.

Note that unlike other resize calls, the filesystem has to be mounted and the parameter is the mountpoint not the device (this is a requirement of btrfs itself).

The optional parameters are:

"size" The new size (in bytes) of the filesystem. If omitted, the filesystem is resized to the maximum size.

See also btrfs(8).

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

btrfs_filesystem_resize

public void btrfs_filesystem_resize(String mountpoint)

btrfs_filesystem_sync

public void btrfs_filesystem_sync(String fs)
sync a btrfs filesystem

Force sync on the btrfs filesystem mounted at "fs".

Throws: LibGuestFSException

btrfs_fsck

public void btrfs_fsck(String device, Map<String,Object> optargs)
check a btrfs filesystem

Used to check a btrfs filesystem, "device" is the device file where the filesystem is stored.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

btrfs_fsck

public void btrfs_fsck(String device)

btrfs_set_seeding

public void btrfs_set_seeding(String device, boolean seeding)
enable or disable the seeding feature of device

Enable or disable the seeding feature of a device that contains a btrfs filesystem.

Throws: LibGuestFSException

btrfs_subvolume_create

public void btrfs_subvolume_create(String dest)
create a btrfs snapshot

Create a btrfs subvolume. The "dest" argument is the destination directory and the name of the snapshot, in the form "/path/to/dest/name".

Throws: LibGuestFSException

btrfs_subvolume_delete

public void btrfs_subvolume_delete(String subvolume)
delete a btrfs snapshot

Delete the named btrfs subvolume.

Throws: LibGuestFSException

btrfs_subvolume_list

public BTRFSSubvolume[] btrfs_subvolume_list(String fs)
list btrfs snapshots and subvolumes

List the btrfs snapshots and subvolumes of the btrfs filesystem which is mounted at "fs".

Throws: LibGuestFSException

btrfs_subvolume_set_default

public void btrfs_subvolume_set_default(long id, String fs)
set default btrfs subvolume

Set the subvolume of the btrfs filesystem "fs" which will be mounted by default. See "g.btrfs_subvolume_list" to get a list of subvolumes.

Throws: LibGuestFSException

btrfs_subvolume_snapshot

public void btrfs_subvolume_snapshot(String source, String dest)
create a writable btrfs snapshot

Create a writable snapshot of the btrfs subvolume "source". The "dest" argument is the destination directory and the name of the snapshot, in the form "/path/to/dest/name".

Throws: LibGuestFSException

canonical_device_name

public String canonical_device_name(String device)
return canonical device name

This utility function is useful when displaying device names to the user. It takes a number of irregular device names and returns them in a consistent format:

"/dev/hdX" "/dev/vdX" These are returned as "/dev/sdX". Note this works for device names and partition names. This is approximately the reverse of the algorithm described in "BLOCK DEVICE NAMING" in guestfs(3).

"/dev/mapper/VG-LV" "/dev/dm-N" Converted to "/dev/VG/LV" form using "g.lvm_canonical_lvm_name".

Other strings are returned unmodified.

Throws: LibGuestFSException

cap_get_file

public String cap_get_file(String path)
get the Linux capabilities attached to a file

This function returns the Linux capabilities attached to "path". The capabilities set is returned in text form (see cap_to_text(3)).

Throws: LibGuestFSException

cap_set_file

public void cap_set_file(String path, String cap)
set the Linux capabilities attached to a file

This function sets the Linux capabilities attached to "path". The capabilities set "cap" should be passed in text form (see cap_from_text(3)).

Throws: LibGuestFSException

case_sensitive_path

public String case_sensitive_path(String path)
return true path on case-insensitive filesystem

This can be used to resolve case insensitive paths on a filesystem which is case sensitive. The use case is to resolve paths which you have read from Windows configuration files or the Windows Registry, to the true path.

The command handles a peculiarity of the Linux ntfs-3g filesystem driver (and probably others), which is that although the underlying filesystem is case-insensitive, the driver exports the filesystem to Linux as case-sensitive.

One consequence of this is that special directories such as "c:\windows" may appear as "/WINDOWS" or "/windows" (or other things) depending on the precise details of how they were created. In Windows itself this would not be a problem.

Bug or feature? You decide:

This function resolves the true case of each element in the path and returns the case-sensitive path.

Thus "g.case_sensitive_path" ("/Windows/System32") might return "/WINDOWS/system32" (the exact return value would depend on details of how the directories were originally created under Windows).

*Note*: This function does not handle drive names, backslashes etc.

See also "g.realpath".

Throws: LibGuestFSException

cat

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

Return the contents of the file named "path".

Because, in C, this function returns a "char *", there is no way to differentiate between a "\0" character in a file and end of string. To handle binary files, use the "g.read_file" or "g.download" functions.

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.

To get the checksum for a device, use "g.checksum_device".

To get the checksums for many files, use "g.checksums_out".

Throws: LibGuestFSException

checksums_out

public void checksums_out(String csumtype, String directory, String sumsfile)
compute MD5, SHAx or CRC checksum of files in a directory

This command computes the checksums of all regular files in "directory" and then emits a list of those checksums to the local output file "sumsfile".

This can be used for verifying the integrity of a virtual machine. However to be properly secure you should pay attention to the output of the checksum command (it uses the ones from GNU coreutils). In particular when the filename is not printable, coreutils uses a special backslash syntax. For more information, see the GNU coreutils info file.

Throws: LibGuestFSException

checksum_device

public String checksum_device(String csumtype, String device)
compute MD5, SHAx or CRC checksum of the contents of a device

This call computes the MD5, SHAx or CRC checksum of the contents of the device named "device". For the types of checksums supported see the "g.checksum" command.

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.

*Note*: When using this command from guestfish, "mode" by default would be decimal, unless you prefix it with 0 to get octal, ie. use 0700 not 700.

The mode actually set is affected by the umask.

Throws: LibGuestFSException

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. See "PROTOCOL LIMITS" in guestfs(3).

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. See "PROTOCOL LIMITS" in guestfs(3).

Throws: LibGuestFSException

compress_device_out

public void compress_device_out(String ctype, String device, String zdevice, Map<String,Object> optargs)
output compressed device

This command compresses "device" and writes it out to the local file "zdevice".

The "ctype" and optional "level" parameters have the same meaning as in "g.compress_out".

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

compress_device_out

public void compress_device_out(String ctype, String device, String zdevice)

compress_out

public void compress_out(String ctype, String file, String zfile, Map<String,Object> optargs)
output compressed file

This command compresses "file" and writes it out to the local file "zfile".

The compression program used is controlled by the "ctype" parameter. Currently this includes: "compress", "gzip", "bzip2", "xz" or "lzop". Some compression types may not be supported by particular builds of libguestfs, in which case you will get an error containing the substring "not supported".

The optional "level" parameter controls compression level. The meaning and default for this parameter depends on the compression program being used.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

compress_out

public void compress_out(String ctype, String file, String zfile)

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 "qemuparam" string must be a "-" (dash).

"qemuvalue" can be NULL.

Throws: LibGuestFSException

copy_device_to_device

public void copy_device_to_device(String src, String dest, Map<String,Object> optargs)
copy from source device to destination device

The four calls "g.copy_device_to_device", "g.copy_device_to_file", "g.copy_file_to_device", and "g.copy_file_to_file" let you copy from a source (device|file) to a destination (device|file).

Partial copies can be made since you can specify optionally the source offset, destination offset and size to copy. These values are all specified in bytes. If not given, the offsets both default to zero, and the size defaults to copying as much as possible until we hit the end of the source.

The source and destination may be the same object. However overlapping regions may not be copied correctly.

If the destination is a file, it is created if required. If the destination file is not large enough, it is extended.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

copy_device_to_device

public void copy_device_to_device(String src, String dest)

copy_device_to_file

public void copy_device_to_file(String src, String dest, Map<String,Object> optargs)
copy from source device to destination file

See "g.copy_device_to_device" for a general overview of this call.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

copy_device_to_file

public void copy_device_to_file(String src, String dest)

copy_file_to_device

public void copy_file_to_device(String src, String dest, Map<String,Object> optargs)
copy from source file to destination device

See "g.copy_device_to_device" for a general overview of this call.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

copy_file_to_device

public void copy_file_to_device(String src, String dest)

copy_file_to_file

public void copy_file_to_file(String src, String dest, Map<String,Object> optargs)
copy from source file to destination file

See "g.copy_device_to_device" for a general overview of this call.

This is not the function you want for copying files. This is for copying blocks within existing files. See "g.cp", "g.cp_a" and "g.mv" for general file copying and moving functions.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

copy_file_to_file

public void copy_file_to_file(String src, String dest)

copy_size

public void copy_size(String src, String dest, long size)
copy size bytes from source to destination using dd

This command copies exactly "size" bytes from one source device or file "src" to another destination device or file "dest".

Note this will fail if the source is too short or if the destination is not large enough.

*This function is deprecated.* In new code, use the "copy_device_to_device" 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

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

dd

public void dd(String src, String dest)
copy from source to destination using dd

This command copies from one source device or file "src" to another destination device or file "dest". Normally you would use this to copy to or from a device or partition, for example to duplicate a filesystem.

If the destination is a device, it must be as large or larger than the source file or device, otherwise the copy will fail. This command cannot do partial copies (see "g.copy_device_to_device").

*This function is deprecated.* In new code, use the "copy_device_to_device" 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

debug

public String debug(String subcmd, String[] extraargs)

debug_drives

public String[] debug_drives()

debug_upload

public void debug_upload(String filename, String tmpname, int mode)

device_index

public int device_index(String device)
convert device to index

This function takes a device name (eg. "/dev/sdb") and returns the index of the device in the list of devices.

Index numbers start from 0. The named device must exist, for example as a string returned from "g.list_devices".

See also "g.list_devices", "g.part_to_dev".

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 "g.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 "g.statvfs" from programs.

Throws: LibGuestFSException

disk_format

public String disk_format(String filename)
detect the disk format of a disk image

Detect and return the format of the disk image called "filename". "filename" can also be a host device, etc. If the format of the image could not be detected, then "unknown" is returned.

Note that detecting the disk format can be insecure under some circumstances. See "CVE-2010-3851" in guestfs(3).

See also: "DISK IMAGE FORMATS" in guestfs(3)

Throws: LibGuestFSException

disk_has_backing_file

public boolean disk_has_backing_file(String filename)
return whether disk has a backing file

Detect and return whether the disk image "filename" has a backing file.

Note that detecting disk features can be insecure under some circumstances. See "CVE-2010-3851" in guestfs(3).

Throws: LibGuestFSException

disk_virtual_size

public long disk_virtual_size(String filename)
return virtual size of a disk

Detect and return the virtual size in bytes of the disk image called "filename".

Note that detecting disk features can be insecure under some circumstances. See "CVE-2010-3851" in guestfs(3).

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

download_offset

public void download_offset(String remotefilename, String filename, long offset, long size)
download a file to the local machine with offset and size

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

"remotefilename" is read for "size" bytes starting at "offset" (this region must be within the file or device).

Note that there is no limit on the amount of data that can be downloaded with this call, unlike with "g.pread", and this call always reads the full amount unless an error occurs.

See also "g.download", "g.pread".

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

public void e2fsck(String device, Map<String,Object> optargs)
check an ext2/ext3 filesystem

This runs the ext2/ext3 filesystem checker on "device". It can take the following optional arguments:

"correct" Automatically repair the file system. This option will cause e2fsck to automatically fix any filesystem problems that can be safely fixed without human intervention.

This option may not be specified at the same time as the "forceall" option.

"forceall" Assume an answer of 'yes' to all questions; allows e2fsck to be used non-interactively.

This option may not be specified at the same time as the "correct" option.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

e2fsck

public void e2fsck(String device)

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 function is deprecated.* In new code, use the "e2fsck" 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

echo_daemon

public String echo_daemon(String[] words)
echo arguments back to the client

This command concatenates 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. See "PROTOCOL LIMITS" in guestfs(3).

*This function is deprecated.* In new code, use the "grep" 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

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. See "PROTOCOL LIMITS" in guestfs(3).

*This function is deprecated.* In new code, use the "grep" 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

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.

*This function is deprecated.* In new code, use the "fallocate64" 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

fallocate64

public void fallocate64(String path, long 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.

Note that this call allocates disk blocks for the file. To create a sparse file use "g.truncate_size" instead.

The deprecated call "g.fallocate" does the same, but owing to an oversight it only allowed 30 bit lengths to be specified, effectively limiting the maximum size of files created through that call to 1GB.

Do not confuse this with the guestfish-specific "alloc" and "sparse" commands which create a file in the host and attach 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. See "PROTOCOL LIMITS" in guestfs(3).

*This function is deprecated.* In new code, use the "grep" 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

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. See "PROTOCOL LIMITS" in guestfs(3).

*This function is deprecated.* In new code, use the "grep" 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

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 call will also transparently look inside various types of compressed file.

The exact command which runs is "file -zb path". Note in particular that the filename is not prepended to the output (the *-b* option).

The output depends on the output of the underlying file(1) command and it can change in future in ways beyond our control. In other words, the output is not guaranteed by the ABI.

See also: file(1), "g.vfs_type", "g.lstat", "g.is_file", "g.is_blockdev" (etc), "g.is_zero".

Throws: LibGuestFSException

filesize

public long filesize(String file)
return the size of the file in bytes

This command returns the size of "file" in bytes.

To get other stats about a file, use "g.stat", "g.lstat", "g.is_dir", "g.is_file" etc. To get the size of block devices, use "g.blockdev_getsize64".

Throws: LibGuestFSException

filesystem_available

public boolean filesystem_available(String filesystem)
check if filesystem is available

Check whether libguestfs supports the named filesystem. The argument "filesystem" is a filesystem name, such as "ext3".

You must call "g.launch" before using this command.

This is mainly useful as a negative test. If this returns true, it doesn't mean that a particular filesystem can be mounted, since filesystems can fail for other reasons such as it being a later version of the filesystem, or having incompatible features.

See also "g.available", "AVAILABILITY" in guestfs(3).

Throws: LibGuestFSException

file_architecture

public String file_architecture(String filename)
detect the architecture of a binary file

This detects the architecture of the binary "filename", and returns it if known.

Currently defined architectures are:

"i386" This string is returned for all 32 bit i386, i486, i586, i686 binaries irrespective of the precise processor requirements of the binary.

"x86_64" 64 bit x86-64.

"sparc" 32 bit SPARC.

"sparc64" 64 bit SPARC V9 and above.

"ia64" Intel Itanium.

"ppc" 32 bit Power PC.

"ppc64" 64 bit Power PC.

Libguestfs may return other architecture strings in future.

The function works on at least the following types of files:

* many types of Un*x and Linux binary

* many types of Un*x and Linux shared library

* Windows Win32 and Win64 binaries

* Windows Win32 and Win64 DLLs

Win32 binaries and DLLs return "i386".

Win64 binaries and DLLs return "x86_64".

* Linux kernel modules

* Linux new-style initrd images

* some non-x86 Linux vmlinuz kernels

What it can't do currently:

* static libraries (libfoo.a)

* Linux old-style initrd as compressed ext2 filesystem (RHEL 3)

* x86 Linux vmlinuz kernels

x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and compressed code, and are horribly hard to unpack. If you want to find the architecture of a kernel, use the architecture of the associated initrd or kernel module(s) instead.

Throws: LibGuestFSException

fill

public void fill(int c, int len, String path)
fill a file with octets

This command creates a new file called "path". The initial content of the file is "len" octets of "c", where "c" must be a number in the range "[0..255]".

To fill a file with zero bytes (sparsely), it is much more efficient to use "g.truncate_size". To create a file with a pattern of repeating bytes use "g.fill_pattern".

Throws: LibGuestFSException

fill_dir

public void fill_dir(String dir, int nr)
fill a directory with empty files

This function, useful for testing filesystems, creates "nr" empty files in the directory "dir" with names 00000000 through "nr-1" (ie. each file name is 8 digits long padded with zeroes).

Throws: LibGuestFSException

fill_pattern

public void fill_pattern(String pattern, int len, String path)
fill a file with a repeating pattern of bytes

This function is like "g.fill" except that it creates a new file of length "len" containing the repeating pattern of bytes in "pattern". The pattern is truncated if necessary to ensure the length of the file is exactly "len" bytes.

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

find0

public void find0(String directory, String files)
find all files and directories, returning NUL-separated list

This command lists out all files and directories, recursively, starting at "directory", placing the resulting list in the external file called "files".

This command works the same way as "g.find" with the following exceptions:

* The resulting list is written to an external file.

* Items (filenames) in the result are separated by "\0" characters. See find(1) option *-print0*.

* The result list is not sorted.

Throws: LibGuestFSException

findfs_label

public String findfs_label(String label)
find a filesystem by label

This command searches the filesystems and returns the one which has the given label. An error is returned if no such filesystem can be found.

To find the label of a filesystem, use "g.vfs_label".

Throws: LibGuestFSException

findfs_uuid

public String findfs_uuid(String uuid)
find a filesystem by UUID

This command searches the filesystems and returns the one which has the given UUID. An error is returned if no such filesystem can be found.

To find the UUID of a filesystem, use "g.vfs_uuid".

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

fstrim

public void fstrim(String mountpoint, Map<String,Object> optargs)
trim free space in a filesystem

Trim the free space in the filesystem mounted on "mountpoint". The filesystem must be mounted read-write.

The filesystem contents are not affected, but any free space in the filesystem is "trimmed", that is, given back to the host device, thus making disk images more sparse, allowing unused space in qcow2 files to be reused, etc.

This operation requires support in libguestfs, the mounted filesystem, the host filesystem, qemu and the host kernel. If this support isn't present it may give an error or even appear to run but do nothing.

See also "g.zero_free_space". That is a slightly different operation that turns free space in the filesystem into zeroes. It is valid to call "g.fstrim" either instead of, or after calling "g.zero_free_space".

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

fstrim

public void fstrim(String mountpoint)

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

getxattr

public String getxattr(String path, String name)
get a single extended attribute

Get a single extended attribute from file "path" named "name". This call follows symlinks. If you want to lookup an extended attribute for the symlink itself, use "g.lgetxattr".

Normally it is better to get all extended attributes from a file in one go by calling "g.getxattrs". However some Linux filesystem implementations are buggy and do not provide a way to list out attributes. For these filesystems (notably ntfs-3g) you have to know the names of the extended attributes you want in advance and call this function.

Extended attribute values are blobs of binary data. If there is no extended attribute named "name", this returns an error.

See also: "g.getxattrs", "g.lgetxattr", attr(5).

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_attach_method

public String get_attach_method()
get the attach method

Return the current attach method.

See "g.set_attach_method" and "ATTACH METHOD" in guestfs(3).

Throws: LibGuestFSException

get_autosync

public boolean get_autosync()
get autosync mode

Get the autosync flag.

Throws: LibGuestFSException

get_cachedir

public String get_cachedir()
get the appliance cache directory

Get the directory used by the handle to store the appliance cache.

Throws: LibGuestFSException

get_direct

public boolean get_direct()
get direct appliance mode flag

Return the direct appliance mode flag.

Throws: LibGuestFSException

get_e2attrs

public String get_e2attrs(String file)
get ext2 file attributes of a file

This returns the file attributes associated with "file".

The attributes are a set of bits associated with each inode which affect the behaviour of the file. The attributes are returned as a string of letters (described below). The string may be empty, indicating that no file attributes are set for this file.

These attributes are only present when the file is located on an ext2/3/4 filesystem. Using this call on other filesystem types will result in an error.

The characters (file attributes) in the returned string are currently:

'A' When the file is accessed, its atime is not modified.

'a' The file is append-only.

'c' The file is compressed on-disk.

'D' (Directories only.) Changes to this directory are written synchronously to disk.

'd' The file is not a candidate for backup (see dump(8)).

'E' The file has compression errors.

'e' The file is using extents.

'h' The file is storing its blocks in units of the filesystem blocksize instead of sectors.

'I' (Directories only.) The directory is using hashed trees.

'i' The file is immutable. It cannot be modified, deleted or renamed. No link can be created to this file.

'j' The file is data-journaled.

's' When the file is deleted, all its blocks will be zeroed.

'S' Changes to this file are written synchronously to disk.

'T' (Directories only.) This is a hint to the block allocator that subdirectories contained in this directory should be spread across blocks. If not present, the block allocator will try to group subdirectories together.

't' For a file, this disables tail-merging. (Not used by upstream implementations of ext2.)

'u' When the file is deleted, its blocks will be saved, allowing the file to be undeleted.

'X' The raw contents of the compressed file may be accessed.

'Z' The compressed file is dirty.

More file attributes may be added to this list later. Not all file attributes may be set for all kinds of files. For detailed information, consult the chattr(1) man page.

See also "g.set_e2attrs".

Don't confuse these attributes with extended attributes (see "g.getxattr").

Throws: LibGuestFSException

get_e2generation

public long get_e2generation(String file)
get ext2 file generation of a file

This returns the ext2 file generation of a file. The generation (which used to be called the "version") is a number associated with an inode. This is most commonly used by NFS servers.

The generation is only present when the file is located on an ext2/3/4 filesystem. Using this call on other filesystem types will result in an error.

See "g.set_e2generation".

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

*This function is deprecated.* In new code, use the "vfs_label" 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

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

*This function is deprecated.* In new code, use the "vfs_uuid" 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

get_libvirt_requested_credentials

public String[] get_libvirt_requested_credentials()
get list of credentials requested by libvirt

This should only be called during the event callback for events of type "GUESTFS_EVENT_LIBVIRT_AUTH".

Return the list of credentials requested by libvirt. Possible values are a subset of the strings provided when you called "g.set_libvirt_supported_credentials".

See "LIBVIRT AUTHENTICATION" in guestfs(3) for documentation and example code.

Throws: LibGuestFSException

get_libvirt_requested_credential_challenge

public String get_libvirt_requested_credential_challenge(int index)
challenge of i'th requested credential

Get the challenge (provided by libvirt) for the "index"'th requested credential. If libvirt did not provide a challenge, this returns the empty string "".

See "LIBVIRT AUTHENTICATION" in guestfs(3) for documentation and example code.

Throws: LibGuestFSException

get_libvirt_requested_credential_defresult

public String get_libvirt_requested_credential_defresult(int index)
default result of i'th requested credential

Get the default result (provided by libvirt) for the "index"'th requested credential. If libvirt did not provide a default result, this returns the empty string "".

See "LIBVIRT AUTHENTICATION" in guestfs(3) for documentation and example code.

Throws: LibGuestFSException

get_libvirt_requested_credential_prompt

public String get_libvirt_requested_credential_prompt(int index)
prompt of i'th requested credential

Get the prompt (provided by libvirt) for the "index"'th requested credential. If libvirt did not provide a prompt, this returns the empty string "".

See "LIBVIRT AUTHENTICATION" in guestfs(3) for documentation and example code.

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_network

public boolean get_network()
get enable network flag

This returns the enable network flag.

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_pgroup

public boolean get_pgroup()
get process group flag

This returns the process group flag.

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_recovery_proc

public boolean get_recovery_proc()
get recovery process enabled flag

Return the recovery process enabled flag.

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_smp

public int get_smp()
get number of virtual CPUs in appliance

This returns the number of virtual CPUs assigned to the appliance.

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_tmpdir

public String get_tmpdir()
get the temporary directory

Get the directory used by the handle to store temporary files.

Throws: LibGuestFSException

get_trace

public boolean get_trace()
get command trace enabled flag

Return the command trace flag.

Throws: LibGuestFSException

get_umask

public int get_umask()
get the current umask

Return the current umask. By default the umask is 022 unless it has been set by calling "g.umask".

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.

Notice that there is no equivalent command for expanding a device name (eg. "/dev/sd*"). Use "g.list_devices", "g.list_partitions" etc functions instead.

Throws: LibGuestFSException

grep

public String[] grep(String regex, String path, Map<String,Object> optargs)
return lines matching a pattern

This calls the external "grep" program and returns the matching lines.

The optional flags are:

"extended" Use extended regular expressions. This is the same as using the *-E* flag.

"fixed" Match fixed (don't use regular expressions). This is the same as using the *-F* flag.

"insensitive" Match case-insensitive. This is the same as using the *-i* flag.

"compressed" Use "zgrep" instead of "grep". This allows the input to be compress- or gzip-compressed.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).

Throws: LibGuestFSException

grep

public String[] grep(String regex, String path)

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. See "PROTOCOL LIMITS" in guestfs(3).

*This function is deprecated.* In new code, use the "grep" 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

grep_opts

public String[] grep_opts(String regex, String path, Map<String,Object> optargs)

grep_opts

public String[] grep_opts(String regex, String path)

grub_install

public void grub_install(String root, String device)
install GRUB 1

This command installs GRUB 1 (the Grand Unified Bootloader) on "device", with the root directory being "root".

Notes:

* There is currently no way in the API to install grub2, which is used by most modern Linux guests. It is possible to run the grub2 command from the guest, although see the caveats in "RUNNING COMMANDS" in guestfs(3).

* This uses "grub-install" from the host. Unfortunately grub is not always compatible with itself, so this only works in rather narrow circumstances. Careful testing with each guest version is advisable.

* If grub-install reports the error "No suitable drive was found in the generated device map." it may be that you need to create a "/boot/grub/device.map" file first that contains the mapping between grub device names and Linux device names. It is usually sufficient to create a file containing:

(hd0) /dev/vda

replacing "/dev/vda" with the name of the installation device.

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. See "PROTOCOL LIMITS" in guestfs(3).

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. See "PROTOCOL LIMITS" in guestfs(3).

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. See "PROTOCOL LIMITS" in guestfs(3).

Throws: LibGuestFSException

hivex_close

public void hivex_close()
close the current hivex handle

Close the current hivex handle.

This is a wrapper around the hivex(3) call of the same name.

Throws: LibGuestFSException

hivex_commit

public void hivex_commit(String filename)
commit (write) changes back to the hive

Commit (write) changes to the hive.

If the optional "filename" parameter is null, then the changes are written back to the same hive that was opened. If this is not null then they are written to the alternate filename given and the original hive is left untouched.

This is a wrapper around the hivex(3) call of the same name.

Throws: LibGuestFSException

hivex_node_add_child

public long hivex_node_add_child(long parent, String name)
add a child node

Add a child node to "parent" named "name".

This is a wrapper around the hivex(3) call of the same name.

Throws: LibGuestFSException

hivex_node_children

public HivexNode[] hivex_node_children(long nodeh)
return list of nodes which are subkeys of node

Return the list of nodes which are subkeys of "nodeh".

This is a wrapper around the hivex(3) call of the same name.

Throws: LibGuestFSException

hivex_node_delete_child

public void hivex_node_delete_child(long nodeh)
delete a node (recursively)

Delete "nodeh", recursively if necessary.

This is a wrapper around the hivex(3) call of the same name.

Throws: LibGuestFSException

hivex_node_get_child

public long hivex_node_get_child(long nodeh, String name)
return the named child of node

Return the child of "nodeh" with the name "name", if it exists. This can return 0 meaning the name was not found.

This is a wrapper around the hivex(3) call of the same name.

Throws: LibGuestFSException

hivex_node_get_value

public long hivex_node_get_value(long nodeh, String key)
return the named value

Return the value attached to "nodeh" which has the name "key", if it exists. This can return 0 meaning the key was not found.

This is a wrapper around the hivex(3) call of the same name.

Throws: LibGuestFSException

hivex_node_name

public String hivex_node_name(long nodeh)
return the name of the node

Return the name of "nodeh".

This is a wrapper around the hivex(3) call of the same name.

Throws: LibGuestFSException

hivex_node_parent

public long hivex_node_parent(long nodeh)
return the parent of node

Return the parent node of "nodeh".

This is a wrapper around the hivex(3) call of the same name.

Throws: LibGuestFSException

hivex_node_set_value

public void hivex_node_set_value(long nodeh, String key, long t, byte[] val)
set or replace a single value in a node

Set or replace a single value under the node "nodeh". The "key" is the name, "t" is the type, and "val" is the data.

This is a wrapper around the hivex(3) call of the same name.

Throws: LibGuestFSException

hivex_node_values

public HivexValue[] hivex_node_values(long nodeh)
return list of values attached to node

Return the array of (key, datatype, data) tuples attached to "nodeh".

This is a wrapper around the hivex(3) call of the same name.

Throws: LibGuestFSException

hivex_open

public void hivex_open(String filename, Map<String,Object> optargs)
open a Windows Registry hive file

Open the Windows Registry hive file named "filename". If there was any previous hivex handle associated with this guestfs session, then it is closed.

This is a wrapper around the hivex(3) call of the same name.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

hivex_open

public void hivex_open(String filename)

hivex_root

public long hivex_root()
return the root node of the hive

Return the root node of the hive.

This is a wrapper around the hivex(3) call of the same name.

Throws: LibGuestFSException

hivex_value_key

public String hivex_value_key(long valueh)
return the key field from the (key, datatype, data) tuple

Return the key (name) field of a (key, datatype, data) tuple.

This is a wrapper around the hivex(3) call of the same name.

Throws: LibGuestFSException

hivex_value_type

public long hivex_value_type(long valueh)
return the data type from the (key, datatype, data) tuple

Return the data type field from a (key, datatype, data) tuple.

This is a wrapper around the hivex(3) call of the same name.

Throws: LibGuestFSException

hivex_value_utf8

public String hivex_value_utf8(long valueh)
return the data field from the (key, datatype, data) tuple

This calls "g.hivex_value_value" (which returns the data field from a hivex value tuple). It then assumes that the field is a UTF-16LE string and converts the result to UTF-8 (or if this is not possible, it returns an error).

This is useful for reading strings out of the Windows registry. However it is not foolproof because the registry is not strongly-typed and fields can contain arbitrary or unexpected data.

Throws: LibGuestFSException

hivex_value_value

public String hivex_value_value(long valueh)
return the data field from the (key, datatype, data) tuple

Return the data field of a (key, datatype, data) tuple.

This is a wrapper around the hivex(3) call of the same name.

See also: "g.hivex_value_utf8".

Throws: LibGuestFSException

initrd_cat

public String initrd_cat(String initrdpath, String filename)
list the contents of a single file in an initrd

This command unpacks the file "filename" from the initrd file called "initrdpath". The filename must be given *without* the initial "/" character.

For example, in guestfish you could use the following command to examine the boot script (usually called "/init") contained in a Linux initrd or initramfs image:

initrd-cat /boot/initrd-.img init

See also "g.initrd_list".

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).

Throws: LibGuestFSException

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" and "g.inotify_rm_watch".

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

inspect_get_arch

public String inspect_get_arch(String root)
get architecture of inspected operating system

This returns the architecture of the inspected operating system. The possible return values are listed under "g.file_architecture".

If the architecture could not be determined, then the string "unknown" is returned.

Please read "INSPECTION" in guestfs(3) for more details.

Throws: LibGuestFSException

inspect_get_distro

public String inspect_get_distro(String root)
get distro of inspected operating system

This returns the distro (distribution) of the inspected operating system.

Currently defined distros are:

"archlinux" Arch Linux.

"buildroot" Buildroot-derived distro, but not one we specifically recognize.

"centos" CentOS.

"cirros" Cirros.

"debian" Debian.

"fedora" Fedora.

"freedos" FreeDOS.

"gentoo" Gentoo.

"linuxmint" Linux Mint.

"mageia" Mageia.

"mandriva" Mandriva.

"meego" MeeGo.

"openbsd" OpenBSD.

"opensuse" OpenSUSE.

"pardus" Pardus.

"redhat-based" Some Red Hat-derived distro.

"rhel" Red Hat Enterprise Linux.

"scientificlinux" Scientific Linux.

"slackware" Slackware.

"sles" SuSE Linux Enterprise Server or Desktop.

"suse-based" Some openSuSE-derived distro.

"ttylinux" ttylinux.

"ubuntu" Ubuntu.

"unknown" The distro could not be determined.

"windows" Windows does not have distributions. This string is returned if the OS type is Windows.

Future versions of libguestfs may return other strings here. The caller should be prepared to handle any string.

Please read "INSPECTION" in guestfs(3) for more details.

Throws: LibGuestFSException

inspect_get_drive_mappings

public Map<String,String> inspect_get_drive_mappings(String root)
get drive letter mappings

This call is useful for Windows which uses a primitive system of assigning drive letters (like "C:") to partitions. This inspection API examines the Windows Registry to find out how disks/partitions are mapped to drive letters, and returns a hash table as in the example below:

C => /dev/vda2 E => /dev/vdb1 F => /dev/vdc1

Note that keys are drive letters. For Windows, the key is case insensitive and just contains the drive letter, without the customary colon separator character.

In future we may support other operating systems that also used drive letters, but the keys for those might not be case insensitive and might be longer than 1 character. For example in OS-9, hard drives were named "h0", "h1" etc.

For Windows guests, currently only hard drive mappings are returned. Removable disks (eg. DVD-ROMs) are ignored.

For guests that do not use drive mappings, or if the drive mappings could not be determined, this returns an empty hash table.

Please read "INSPECTION" in guestfs(3) for more details. See also "g.inspect_get_mountpoints", "g.inspect_get_filesystems".

Throws: LibGuestFSException

inspect_get_filesystems

public String[] inspect_get_filesystems(String root)
get filesystems associated with inspected operating system

This returns a list of all the filesystems that we think are associated with this operating system. This includes the root filesystem, other ordinary filesystems, and non-mounted devices like swap partitions.

In the case of a multi-boot virtual machine, it is possible for a filesystem to be shared between operating systems.

Please read "INSPECTION" in guestfs(3) for more details. See also "g.inspect_get_mountpoints".

Throws: LibGuestFSException

inspect_get_format

public String inspect_get_format(String root)
get format of inspected operating system

This returns the format of the inspected operating system. You can use it to detect install images, live CDs and similar.

Currently defined formats are:

"installed" This is an installed operating system.

"installer" The disk image being inspected is not an installed operating system, but a *bootable* install disk, live CD, or similar.

"unknown" The format of this disk image is not known.

Future versions of libguestfs may return other strings here. The caller should be prepared to handle any string.

Please read "INSPECTION" in guestfs(3) for more details.

Throws: LibGuestFSException

inspect_get_hostname

public String inspect_get_hostname(String root)
get hostname of the operating system

This function returns the hostname of the operating system as found by inspection of the guest's configuration files.

If the hostname could not be determined, then the string "unknown" is returned.

Please read "INSPECTION" in guestfs(3) for more details.

Throws: LibGuestFSException

inspect_get_icon

public String inspect_get_icon(String root, Map<String,Object> optargs)
get the icon corresponding to this operating system

This function returns an icon corresponding to the inspected operating system. The icon is returned as a buffer containing a PNG image (re-encoded to PNG if necessary).

If it was not possible to get an icon this function returns a zero-length (non-NULL) buffer. *Callers must check for this case*.

Libguestfs will start by looking for a file called "/etc/favicon.png" or "C:\etc\favicon.png" and if it has the correct format, the contents of this file will be returned. You can disable favicons by passing the optional "favicon" boolean as false (default is true).

If finding the favicon fails, then we look in other places in the guest for a suitable icon.

If the optional "highquality" boolean is true then only high quality icons are returned, which means only icons of high resolution with an alpha channel. The default (false) is to return any icon we can, even if it is of substandard quality.

Notes:

* Unlike most other inspection API calls, the guest's disks must be mounted up before you call this, since it needs to read information from the guest filesystem during the call.

* Security: The icon data comes from the untrusted guest, and should be treated with caution. PNG files have been known to contain exploits. Ensure that libpng (or other relevant libraries) are fully up to date before trying to process or display the icon.

* The PNG image returned can be any size. It might not be square. Libguestfs tries to return the largest, highest quality icon available. The application must scale the icon to the required size.

* Extracting icons from Windows guests requires the external "wrestool" program from the "icoutils" package, and several programs ("bmptopnm", "pnmtopng", "pamcut") from the "netpbm" package. These must be installed separately.

* Operating system icons are usually trademarks. Seek legal advice before using trademarks in applications.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

inspect_get_icon

public String inspect_get_icon(String root)

inspect_get_major_version

public int inspect_get_major_version(String root)
get major version of inspected operating system

This returns the major version number of the inspected operating system.

Windows uses a consistent versioning scheme which is *not* reflected in the popular public names used by the operating system. Notably the operating system known as "Windows 7" is really version 6.1 (ie. major = 6, minor = 1). You can find out the real versions corresponding to releases of Windows by consulting Wikipedia or MSDN.

If the version could not be determined, then 0 is returned.

Please read "INSPECTION" in guestfs(3) for more details.

Throws: LibGuestFSException

inspect_get_minor_version

public int inspect_get_minor_version(String root)
get minor version of inspected operating system

This returns the minor version number of the inspected operating system.

If the version could not be determined, then 0 is returned.

Please read "INSPECTION" in guestfs(3) for more details. See also "g.inspect_get_major_version".

Throws: LibGuestFSException

inspect_get_mountpoints

public Map<String,String> inspect_get_mountpoints(String root)
get mountpoints of inspected operating system

This returns a hash of where we think the filesystems associated with this operating system should be mounted. Callers should note that this is at best an educated guess made by reading configuration files such as "/etc/fstab". *In particular note* that this may return filesystems which are non-existent or not mountable and callers should be prepared to handle or ignore failures if they try to mount them.

Each element in the returned hashtable has a key which is the path of the mountpoint (eg. "/boot") and a value which is the filesystem that would be mounted there (eg. "/dev/sda1").

Non-mounted devices such as swap devices are *not* returned in this list.

For operating systems like Windows which still use drive letters, this call will only return an entry for the first drive "mounted on" "/". For information about the mapping of drive letters to partitions, see "g.inspect_get_drive_mappings".

Please read "INSPECTION" in guestfs(3) for more details. See also "g.inspect_get_filesystems".

Throws: LibGuestFSException

inspect_get_package_format

public String inspect_get_package_format(String root)
get package format used by the operating system

This function and "g.inspect_get_package_management" return the package format and package management tool used by the inspected operating system. For example for Fedora these functions would return "rpm" (package format) and "yum" (package management).

This returns the string "unknown" if we could not determine the package format *or* if the operating system does not have a real packaging system (eg. Windows).

Possible strings include: "rpm", "deb", "ebuild", "pisi", "pacman", "pkgsrc". Future versions of libguestfs may return other strings.

Please read "INSPECTION" in guestfs(3) for more details.

Throws: LibGuestFSException

inspect_get_package_management

public String inspect_get_package_management(String root)
get package management tool used by the operating system

"g.inspect_get_package_format" and this function return the package format and package management tool used by the inspected operating system. For example for Fedora these functions would return "rpm" (package format) and "yum" (package management).

This returns the string "unknown" if we could not determine the package management tool *or* if the operating system does not have a real packaging system (eg. Windows).

Possible strings include: "yum", "up2date", "apt" (for all Debian derivatives), "portage", "pisi", "pacman", "urpmi", "zypper". Future versions of libguestfs may return other strings.

Please read "INSPECTION" in guestfs(3) for more details.

Throws: LibGuestFSException

inspect_get_product_name

public String inspect_get_product_name(String root)
get product name of inspected operating system

This returns the product name of the inspected operating system. The product name is generally some freeform string which can be displayed to the user, but should not be parsed by programs.

If the product name could not be determined, then the string "unknown" is returned.

Please read "INSPECTION" in guestfs(3) for more details.

Throws: LibGuestFSException

inspect_get_product_variant

public String inspect_get_product_variant(String root)
get product variant of inspected operating system

This returns the product variant of the inspected operating system.

For Windows guests, this returns the contents of the Registry key "HKLM\Software\Microsoft\Windows NT\CurrentVersion" "InstallationType" which is usually a string such as "Client" or "Server" (other values are possible). This can be used to distinguish consumer and enterprise versions of Windows that have the same version number (for example, Windows 7 and Windows 2008 Server are both version 6.1, but the former is "Client" and the latter is "Server").

For enterprise Linux guests, in future we intend this to return the product variant such as "Desktop", "Server" and so on. But this is not implemented at present.

If the product variant could not be determined, then the string "unknown" is returned.

Please read "INSPECTION" in guestfs(3) for more details. See also "g.inspect_get_product_name", "g.inspect_get_major_version".

Throws: LibGuestFSException

inspect_get_roots

public String[] inspect_get_roots()
return list of operating systems found by last inspection

This function is a convenient way to get the list of root devices, as returned from a previous call to "g.inspect_os", but without redoing the whole inspection process.

This returns an empty list if either no root devices were found or the caller has not called "g.inspect_os".

Please read "INSPECTION" in guestfs(3) for more details.

Throws: LibGuestFSException

inspect_get_type

public String inspect_get_type(String root)
get type of inspected operating system

This returns the type of the inspected operating system. Currently defined types are:

"linux" Any Linux-based operating system.

"windows" Any Microsoft Windows operating system.

"freebsd" FreeBSD.

"netbsd" NetBSD.

"openbsd" OpenBSD.

"hurd" GNU/Hurd.

"dos" MS-DOS, FreeDOS and others.

"unknown" The operating system type could not be determined.

Future versions of libguestfs may return other strings here. The caller should be prepared to handle any string.

Please read "INSPECTION" in guestfs(3) for more details.

Throws: LibGuestFSException

inspect_get_windows_current_control_set

public String inspect_get_windows_current_control_set(String root)
get Windows CurrentControlSet of inspected operating system

This returns the Windows CurrentControlSet of the inspected guest. The CurrentControlSet is a registry key name such as "ControlSet001".

This call assumes that the guest is Windows and that the Registry could be examined by inspection. If this is not the case then an error is returned.

Please read "INSPECTION" in guestfs(3) for more details.

Throws: LibGuestFSException

inspect_get_windows_systemroot

public String inspect_get_windows_systemroot(String root)
get Windows systemroot of inspected operating system

This returns the Windows systemroot of the inspected guest. The systemroot is a directory path such as "/WINDOWS".

This call assumes that the guest is Windows and that the systemroot could be determined by inspection. If this is not the case then an error is returned.

Please read "INSPECTION" in guestfs(3) for more details.

Throws: LibGuestFSException

inspect_is_live

public boolean inspect_is_live(String root)
get live flag for install disk

If "g.inspect_get_format" returns "installer" (this is an install disk), then this returns true if a live image was detected on the disk.

Please read "INSPECTION" in guestfs(3) for more details.

Throws: LibGuestFSException

inspect_is_multipart

public boolean inspect_is_multipart(String root)
get multipart flag for install disk

If "g.inspect_get_format" returns "installer" (this is an install disk), then this returns true if the disk is part of a set.

Please read "INSPECTION" in guestfs(3) for more details.

Throws: LibGuestFSException

inspect_is_netinst

public boolean inspect_is_netinst(String root)
get netinst (network installer) flag for install disk

If "g.inspect_get_format" returns "installer" (this is an install disk), then this returns true if the disk is a network installer, ie. not a self-contained install CD but one which is likely to require network access to complete the install.

Please read "INSPECTION" in guestfs(3) for more details.

Throws: LibGuestFSException

inspect_list_applications

public Application[] inspect_list_applications(String root)
get list of applications installed in the operating system

Return the list of applications installed in the operating system.

*Note:* This call works differently from other parts of the inspection API. You have to call "g.inspect_os", then "g.inspect_get_mountpoints", then mount up the disks, before calling this. Listing applications is a significantly more difficult operation which requires access to the full filesystem. Also note that unlike the other "g.inspect_get_*" calls which are just returning data cached in the libguestfs handle, this call actually reads parts of the mounted filesystems during the call.

This returns an empty list if the inspection code was not able to determine the list of applications.

The application structure contains the following fields:

"app_name" The name of the application. For Red Hat-derived and Debian-derived Linux guests, this is the package name.

"app_display_name" The display name of the application, sometimes localized to the install language of the guest operating system.

If unavailable this is returned as an empty string "". Callers needing to display something can use "app_name" instead.

"app_epoch" For package managers which use epochs, this contains the epoch of the package (an integer). If unavailable, this is returned as 0.

"app_version" The version string of the application or package. If unavailable this is returned as an empty string "".

"app_release" The release string of the application or package, for package managers that use this. If unavailable this is returned as an empty string "".

"app_install_path" The installation path of the application (on operating systems such as Windows which use installation paths). This path is in the format used by the guest operating system, it is not a libguestfs path.

If unavailable this is returned as an empty string "".

"app_trans_path" The install path translated into a libguestfs path. If unavailable this is returned as an empty string "".

"app_publisher" The name of the publisher of the application, for package managers that use this. If unavailable this is returned as an empty string "".

"app_url" The URL (eg. upstream URL) of the application. If unavailable this is returned as an empty string "".

"app_source_package" For packaging systems which support this, the name of the source package. If unavailable this is returned as an empty string "".

"app_summary" A short (usually one line) description of the application or package. If unavailable this is returned as an empty string "".

"app_description" A longer description of the application or package. If unavailable this is returned as an empty string "".

Please read "INSPECTION" in guestfs(3) for more details.

*This function is deprecated.* In new code, use the "inspect_list_applications2" 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

inspect_list_applications2

public Application2[] inspect_list_applications2(String root)
get list of applications installed in the operating system

Return the list of applications installed in the operating system.

*Note:* This call works differently from other parts of the inspection API. You have to call "g.inspect_os", then "g.inspect_get_mountpoints", then mount up the disks, before calling this. Listing applications is a significantly more difficult operation which requires access to the full filesystem. Also note that unlike the other "g.inspect_get_*" calls which are just returning data cached in the libguestfs handle, this call actually reads parts of the mounted filesystems during the call.

This returns an empty list if the inspection code was not able to determine the list of applications.

The application structure contains the following fields:

"app2_name" The name of the application. For Red Hat-derived and Debian-derived Linux guests, this is the package name.

"app2_display_name" The display name of the application, sometimes localized to the install language of the guest operating system.

If unavailable this is returned as an empty string "". Callers needing to display something can use "app2_name" instead.

"app2_epoch" For package managers which use epochs, this contains the epoch of the package (an integer). If unavailable, this is returned as 0.

"app2_version" The version string of the application or package. If unavailable this is returned as an empty string "".

"app2_release" The release string of the application or package, for package managers that use this. If unavailable this is returned as an empty string "".

"app2_arch" The architecture string of the application or package, for package managers that use this. If unavailable this is returned as an empty string "".

"app2_install_path" The installation path of the application (on operating systems such as Windows which use installation paths). This path is in the format used by the guest operating system, it is not a libguestfs path.

If unavailable this is returned as an empty string "".

"app2_trans_path" The install path translated into a libguestfs path. If unavailable this is returned as an empty string "".

"app2_publisher" The name of the publisher of the application, for package managers that use this. If unavailable this is returned as an empty string "".

"app2_url" The URL (eg. upstream URL) of the application. If unavailable this is returned as an empty string "".

"app2_source_package" For packaging systems which support this, the name of the source package. If unavailable this is returned as an empty string "".

"app2_summary" A short (usually one line) description of the application or package. If unavailable this is returned as an empty string "".

"app2_description" A longer description of the application or package. If unavailable this is returned as an empty string "".

Please read "INSPECTION" in guestfs(3) for more details.

Throws: LibGuestFSException

inspect_os

public String[] inspect_os()
inspect disk and return list of operating systems found

This function uses other libguestfs functions and certain heuristics to inspect the disk(s) (usually disks belonging to a virtual machine), looking for operating systems.

The list returned is empty if no operating systems were found.

If one operating system was found, then this returns a list with a single element, which is the name of the root filesystem of this operating system. It is also possible for this function to return a list containing more than one element, indicating a dual-boot or multi-boot virtual machine, with each element being the root filesystem of one of the operating systems.

You can pass the root string(s) returned to other "g.inspect_get_*" functions in order to query further information about each operating system, such as the name and version.

This function uses other libguestfs features such as "g.mount_ro" and "g.umount_all" in order to mount and unmount filesystems and look at the contents. This should be called with no disks currently mounted. The function may also use Augeas, so any existing Augeas handle will be closed.

This function cannot decrypt encrypted disks. The caller must do that first (supplying the necessary keys) if the disk is encrypted.

Please read "INSPECTION" in guestfs(3) for more details.

See also "g.list_filesystems".

Throws: LibGuestFSException

internal_autosync

public void internal_autosync()

internal_hot_add_drive

public void internal_hot_add_drive(String label)

internal_hot_remove_drive

public void internal_hot_remove_drive(String label)

internal_hot_remove_drive_precheck

public void internal_hot_remove_drive_precheck(String label)

internal_lstatlist

public Stat[] internal_lstatlist(String path, String[] names)

internal_lxattrlist

public XAttr[] internal_lxattrlist(String path, String[] names)

internal_readlinklist

public String[] internal_readlinklist(String path, String[] names)

internal_test

public void internal_test(String str, String optstr, String[] strlist, boolean b, int integer, long integer64, String filein, String fileout, byte[] bufferin, Map<String,Object> optargs)

internal_test

public void internal_test(String str, String optstr, String[] strlist, boolean b, int integer, long integer64, String filein, String fileout, byte[] bufferin)

internal_test_63_optargs

public void internal_test_63_optargs(Map<String,Object> optargs)

internal_test_63_optargs

public void internal_test_63_optargs()

internal_test_close_output

public void internal_test_close_output()

internal_test_only_optargs

public void internal_test_only_optargs(Map<String,Object> optargs)

internal_test_only_optargs

public void internal_test_only_optargs()

internal_test_rbool

public boolean internal_test_rbool(String val)

internal_test_rboolerr

public boolean internal_test_rboolerr()

internal_test_rbufferout

public String internal_test_rbufferout(String val)

internal_test_rbufferouterr

public String internal_test_rbufferouterr()

internal_test_rconstoptstring

public String internal_test_rconstoptstring(String val)

internal_test_rconstoptstringerr

public String internal_test_rconstoptstringerr()

internal_test_rconststring

public String internal_test_rconststring(String val)

internal_test_rconststringerr

public String internal_test_rconststringerr()

internal_test_rhashtable

public Map<String,String> internal_test_rhashtable(String val)

internal_test_rhashtableerr

public Map<String,String> internal_test_rhashtableerr()

internal_test_rint

public int internal_test_rint(String val)

internal_test_rint64

public long internal_test_rint64(String val)

internal_test_rint64err

public long internal_test_rint64err()

internal_test_rinterr

public int internal_test_rinterr()

internal_test_rstring

public String internal_test_rstring(String val)

internal_test_rstringerr

public String internal_test_rstringerr()

internal_test_rstringlist

public String[] internal_test_rstringlist(String val)

internal_test_rstringlisterr

public String[] internal_test_rstringlisterr()

internal_test_rstruct

public PV internal_test_rstruct(String val)

internal_test_rstructerr

public PV internal_test_rstructerr()

internal_test_rstructlist

public PV[] internal_test_rstructlist(String val)

internal_test_rstructlisterr

public PV[] internal_test_rstructlisterr()

internal_test_set_output

public void internal_test_set_output(String filename)

internal_write

public void internal_write(String path, byte[] content)

internal_write_append

public void internal_write_append(String path, byte[] content)

isoinfo

public ISOInfo isoinfo(String isofile)
get ISO information from primary volume descriptor of ISO file

This is the same as "g.isoinfo_device" except that it works for an ISO file located inside some other mounted filesystem. Note that in the common case where you have added an ISO file as a libguestfs device, you would *not* call this. Instead you would call "g.isoinfo_device".

Throws: LibGuestFSException

isoinfo_device

public ISOInfo isoinfo_device(String device)
get ISO information from primary volume descriptor of device

"device" is an ISO device. This returns a struct of information read from the primary volume descriptor (the ISO equivalent of the superblock) of the device.

Usually it is more efficient to use the isoinfo(1) command with the *-d* option on the host to analyze ISO files, instead of going through libguestfs.

For information on the primary volume descriptor fields, see

Throws: LibGuestFSException

is_blockdev

public boolean is_blockdev(String path)
test if block device

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

See also "g.stat".

Throws: LibGuestFSException

is_busy

public boolean is_busy()

is_chardev

public boolean is_chardev(String path)
test if character device

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

See also "g.stat".

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 a directory

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_fifo

public boolean is_fifo(String path)
test if FIFO (named pipe)

This returns "true" if and only if there is a FIFO (named pipe) with the given "path" name.

See also "g.stat".

Throws: LibGuestFSException

is_file

public boolean is_file(String path)
test if a regular file

This returns "true" if and only if there is a regular 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_lv

public boolean is_lv(String device)
test if device is a logical volume

This command tests whether "device" is a logical volume, and returns true iff this is the case.

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

is_socket

public boolean is_socket(String path)
test if socket

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

See also "g.stat".

Throws: LibGuestFSException

is_symlink

public boolean is_symlink(String path)
test if symbolic link

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

See also "g.stat".

Throws: LibGuestFSException

is_zero

public boolean is_zero(String path)
test if a file contains all zero bytes

This returns true iff the file exists and the file is empty or it contains all zero bytes.

Throws: LibGuestFSException

is_zero_device

public boolean is_zero_device(String device)
test if a device contains all zero bytes

This returns true iff the device exists and contains all zero bytes.

Note that for large devices this can take a long time to run.

Throws: LibGuestFSException

kill_subprocess

public void kill_subprocess()
kill the qemu subprocess

This kills the qemu subprocess.

Do not call this. See: "g.shutdown" instead.

*This function is deprecated.* In new code, use the "shutdown" 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

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.

Do not call "g.launch" twice on the same handle. Although it will not give an error (for historical reasons), the precise behaviour when you do this is not well defined. Handles are very cheap to create, so create a new one for each launch.

Throws: LibGuestFSException

lchown

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

Change the file owner to "owner" and group to "group". This is like "g.chown" but if "path" is a symlink then the link itself is changed, not the target.

Only numeric uid and gid are supported. If you want to use names, you will need to locate and parse the password file yourself (Augeas support makes this relatively easy).

Throws: LibGuestFSException

ldmtool_create_all

public void ldmtool_create_all()
scan and create Windows dynamic disk volumes

This function scans all block devices looking for Windows dynamic disk volumes and partitions, and creates devices for any that were found.

Call "g.list_ldm_volumes" and "g.list_ldm_partitions" to return all devices.

Note that you don't normally need to call this explicitly, since it is done automatically at "g.launch" time. However you might want to call this function if you have hotplugged disks or have just created a Windows dynamic disk.

Throws: LibGuestFSException

ldmtool_diskgroup_disks

public String[] ldmtool_diskgroup_disks(String diskgroup)
return the disks in a Windows dynamic disk group

Return the disks in a Windows dynamic disk group. The "diskgroup" parameter should be the GUID of a disk group, one element from the list returned by "g.ldmtool_scan".

Throws: LibGuestFSException

ldmtool_diskgroup_name

public String ldmtool_diskgroup_name(String diskgroup)
return the name of a Windows dynamic disk group

Return the name of a Windows dynamic disk group. The "diskgroup" parameter should be the GUID of a disk group, one element from the list returned by "g.ldmtool_scan".

Throws: LibGuestFSException

ldmtool_diskgroup_volumes

public String[] ldmtool_diskgroup_volumes(String diskgroup)
return the volumes in a Windows dynamic disk group

Return the volumes in a Windows dynamic disk group. The "diskgroup" parameter should be the GUID of a disk group, one element from the list returned by "g.ldmtool_scan".

Throws: LibGuestFSException

ldmtool_remove_all

public void ldmtool_remove_all()
remove all Windows dynamic disk volumes

This is essentially the opposite of "g.ldmtool_create_all". It removes the device mapper mappings for all Windows dynamic disk volumes

Throws: LibGuestFSException

ldmtool_scan

public String[] ldmtool_scan()
scan for Windows dynamic disks

This function scans for Windows dynamic disks. It returns a list of identifiers (GUIDs) for all disk groups that were found. These identifiers can be passed to other "g.ldmtool_*" functions.

This function scans all block devices. To scan a subset of block devices, call "g.ldmtool_scan_devices" instead.

Throws: LibGuestFSException

ldmtool_scan_devices

public String[] ldmtool_scan_devices(String[] devices)
scan for Windows dynamic disks

This function scans for Windows dynamic disks. It returns a list of identifiers (GUIDs) for all disk groups that were found. These identifiers can be passed to other "g.ldmtool_*" functions.

The parameter "devices" is a list of block devices which are scanned. If this list is empty, all block devices are scanned.

Throws: LibGuestFSException

ldmtool_volume_hint

public String ldmtool_volume_hint(String diskgroup, String volume)
return the hint field of a Windows dynamic disk volume

Return the hint field of the volume named "volume" in the disk group with GUID . This may not be defined, in which case the empty string is returned. The hint field is often, though not always, the name of a Windows drive, eg. "E:".

Throws: LibGuestFSException

ldmtool_volume_partitions

public String[] ldmtool_volume_partitions(String diskgroup, String volume)
return the partitions in a Windows dynamic disk volume

Return the list of partitions in the volume named "volume" in the disk group with GUID .

Throws: LibGuestFSException

ldmtool_volume_type

public String ldmtool_volume_type(String diskgroup, String volume)
return the type of a Windows dynamic disk volume

Return the type of the volume named "volume" in the disk group with GUID .

Possible volume types that can be returned here include: "simple", "spanned", "striped", "mirrored", "raid5". Other types may also be returned.

Throws: LibGuestFSException

lgetxattr

public String lgetxattr(String path, String name)
get a single extended attribute

Get a single extended attribute from file "path" named "name". If "path" is a symlink, then this call returns an extended attribute from the symlink.

Normally it is better to get all extended attributes from a file in one go by calling "g.getxattrs". However some Linux filesystem implementations are buggy and do not provide a way to list out attributes. For these filesystems (notably ntfs-3g) you have to know the names of the extended attributes you want in advance and call this function.

Extended attribute values are blobs of binary data. If there is no extended attribute named "name", this returns an error.

See also: "g.lgetxattrs", "g.getxattr", attr(5).

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_9p

public String[] list_9p()
list 9p filesystems

List all 9p filesystems attached to the guest. A list of mount tags is returned.

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

See also "g.list_filesystems".

Throws: LibGuestFSException

list_disk_labels

public Map<String,String> list_disk_labels()
mapping of disk labels to devices

If you add drives using the optional "label" parameter of "g.add_drive_opts", you can use this call to map between disk labels, and raw block device and partition names (like "/dev/sda" and "/dev/sda1").

This returns a hashtable, where keys are the disk labels (*without* the "/dev/disk/guestfs" prefix), and the values are the full raw block device and partition names (eg. "/dev/sda" and "/dev/sda1").

Throws: LibGuestFSException

list_dm_devices

public String[] list_dm_devices()
list device mapper devices

List all device mapper devices.

The returned list contains "/dev/mapper/*" devices, eg. ones created by a previous call to "g.luks_open".

Device mapper devices which correspond to logical volumes are *not* returned in this list. Call "g.lvs" if you want to list logical volumes.

Throws: LibGuestFSException

list_filesystems

public Map<String,String> list_filesystems()
list filesystems

This inspection command looks for filesystems on partitions, block devices and logical volumes, returning a list of devices containing filesystems and their type.

The return value is a hash, where the keys are the devices containing filesystems, and the values are the filesystem types. For example:

"/dev/sda1" => "ntfs" "/dev/sda2" => "ext2" "/dev/vg_guest/lv_root" => "ext4" "/dev/vg_guest/lv_swap" => "swap"

The value can have the special value "unknown", meaning the content of the device is undetermined or empty. "swap" means a Linux swap partition.

This command runs other libguestfs commands, which might include "g.mount" and "g.umount", and therefore you should use this soon after launch and only when nothing is mounted.

Not all of the filesystems returned will be mountable. In particular, swap partitions are returned in the list. Also this command does not check that each filesystem found is valid and mountable, and some filesystems might be mountable but require special options. Filesystems may not all belong to a single logical operating system (use "g.inspect_os" to look for OSes).

Throws: LibGuestFSException

list_ldm_partitions

public String[] list_ldm_partitions()
list all Windows dynamic disk partitions

This function returns all Windows dynamic disk partitions that were found at launch time. It returns a list of device names.

Throws: LibGuestFSException

list_ldm_volumes

public String[] list_ldm_volumes()
list all Windows dynamic disk volumes

This function returns all Windows dynamic disk volumes that were found at launch time. It returns a list of device names.

Throws: LibGuestFSException

list_md_devices

public String[] list_md_devices()
list Linux md (RAID) devices

List all Linux md devices.

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

See also "g.list_filesystems".

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

llz

public String llz(String directory)
list the files in a directory (long format with SELinux contexts)

List the files in "directory" in the format of 'ls -laZ'.

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.

Throws: LibGuestFSException

ls0

public void ls0(String dir, String filenames)
get list of files in a directory

This specialized command is used to get a listing of the filenames in the directory "dir". The list of filenames is written to the local file "filenames" (on the host).

In the output file, the filenames are separated by "\0" characters.

"." and ".." are not returned. The filenames are not sorted.

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

lstatlist

public Stat[] lstatlist(String path, String[] names)
lstat on multiple files

This call allows you to perform the "g.lstat" operation on multiple files, where all files are in the directory "path". "names" is the list of files from this directory.

On return you get a list of stat structs, with a one-to-one correspondence to the "names" list. If any name did not exist or could not be lstat'd, then the "ino" field of that structure is set to -1.

This call is intended for programs that want to efficiently list a directory contents without making many round-trips. See also "g.lxattrlist" for a similarly efficient call for getting extended attributes.

Throws: LibGuestFSException

luks_add_key

public void luks_add_key(String device, String key, String newkey, int keyslot)
add a key on a LUKS encrypted device

This command adds a new key on LUKS device "device". "key" is any existing key, and is used to access the device. "newkey" is the new key to add. "keyslot" is the key slot that will be replaced.

Note that if "keyslot" already contains a key, then this command will fail. You have to use "g.luks_kill_slot" first to remove that key.

Throws: LibGuestFSException

luks_close

public void luks_close(String device)
close a LUKS device

This closes a LUKS device that was created earlier by "g.luks_open" or "g.luks_open_ro". The "device" parameter must be the name of the LUKS mapping device (ie. "/dev/mapper/mapname") and *not* the name of the underlying block device.

Throws: LibGuestFSException

luks_format

public void luks_format(String device, String key, int keyslot)
format a block device as a LUKS encrypted device

This command erases existing data on "device" and formats the device as a LUKS encrypted device. "key" is the initial key, which is added to key slot "slot". (LUKS supports 8 key slots, numbered 0-7).

Throws: LibGuestFSException

luks_format_cipher

public void luks_format_cipher(String device, String key, int keyslot, String cipher)
format a block device as a LUKS encrypted device

This command is the same as "g.luks_format" but it also allows you to set the "cipher" used.

Throws: LibGuestFSException

luks_kill_slot

public void luks_kill_slot(String device, String key, int keyslot)
remove a key from a LUKS encrypted device

This command deletes the key in key slot "keyslot" from the encrypted LUKS device "device". "key" must be one of the *other* keys.

Throws: LibGuestFSException

luks_open

public void luks_open(String device, String key, String mapname)
open a LUKS-encrypted block device

This command opens a block device which has been encrypted according to the Linux Unified Key Setup (LUKS) standard.

"device" is the encrypted block device or partition.

The caller must supply one of the keys associated with the LUKS block device, in the "key" parameter.

This creates a new block device called "/dev/mapper/mapname". Reads and writes to this block device are decrypted from and encrypted to the underlying "device" respectively.

If this block device contains LVM volume groups, then calling "g.vgscan" followed by "g.vg_activate_all" will make them visible.

Use "g.list_dm_devices" to list all device mapper devices.

Throws: LibGuestFSException

luks_open_ro

public void luks_open_ro(String device, String key, String mapname)
open a LUKS-encrypted block device read-only

This is the same as "g.luks_open" except that a read-only mapping is created.

Throws: LibGuestFSException

lvcreate

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

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

Throws: LibGuestFSException

lvcreate_free

public void lvcreate_free(String logvol, String volgroup, int percent)
create an LVM logical volume in % remaining free space

Create an LVM logical volume called "/dev/volgroup/logvol", using approximately "percent" % of the free space remaining in the volume group. Most usefully, when "percent" is 100 this will create the largest possible LV.

Throws: LibGuestFSException

lvm_canonical_lv_name

public String lvm_canonical_lv_name(String lvname)
get canonical name of an LV

This converts alternative naming schemes for LVs that you might find to the canonical name. For example, "/dev/mapper/VG-LV" is converted to "/dev/VG/LV".

This command returns an error if the "lvname" parameter does not refer to a logical volume.

See also "g.is_lv", "g.canonical_device_name".

Throws: LibGuestFSException

lvm_clear_filter

public void lvm_clear_filter()
clear LVM device filter

This undoes the effect of "g.lvm_set_filter". LVM will be able to see every block device.

This command also clears the LVM cache and performs a volume group scan.

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.

Throws: LibGuestFSException

lvm_set_filter

public void lvm_set_filter(String[] devices)
set LVM device filter

This sets the LVM device filter so that LVM will only be able to "see" the block devices in the list "devices", and will ignore all other attached block devices.

Where disk image(s) contain duplicate PVs or VGs, this command is useful to get LVM to ignore the duplicates, otherwise LVM can get confused. Note also there are two types of duplication possible: either cloned PVs/VGs which have identical UUIDs; or VGs that are not cloned but just happen to have the same name. In normal operation you cannot create this situation, but you can do it outside LVM, eg. by cloning disk images or by bit twiddling inside the LVM metadata.

This command also clears the LVM cache and performs a volume group scan.

You can filter whole block devices or individual partitions.

You cannot use this if any VG is currently in use (eg. contains a mounted filesystem), even if you are not filtering out that VG.

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

lvrename

public void lvrename(String logvol, String newlogvol)
rename an LVM logical volume

Rename a logical volume "logvol" with the new name "newlogvol".

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

lvresize_free

public void lvresize_free(String lv, int percent)
expand an LV to fill free space

This expands an existing logical volume "lv" so that it fills "pc"% of the remaining free space in the volume group. Commonly you would call this with pc = 100 which expands the logical volume as much as possible, using all remaining free space in the volume group.

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", "g.list_filesystems".

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

lvuuid

public String lvuuid(String device)
get the UUID of a logical volume

This command returns the UUID of the LVM LV "device".

Throws: LibGuestFSException

lxattrlist

public XAttr[] lxattrlist(String path, String[] names)
lgetxattr on multiple files

This call allows you to get the extended attributes of multiple files, where all files are in the directory "path". "names" is the list of files from this directory.

On return you get a flat list of xattr structs which must be interpreted sequentially. The first xattr struct always has a zero-length "attrname". "attrval" in this struct is zero-length to indicate there was an error doing "lgetxattr" for this file, *or* is a C string which is a decimal number (the number of following attributes for this file, which could be "0"). Then after the first xattr struct are the zero or more attributes for the first named file. This repeats for the second and subsequent files.

This call is intended for programs that want to efficiently list a directory contents without making many round-trips. See also "g.lstatlist" for a similarly efficient call for getting standard stats.

Throws: LibGuestFSException

max_disks

public int max_disks()
maximum number of disks that may be added

Return the maximum number of disks that may be added to a handle (eg. by "g.add_drive_opts" and similar calls).

This function was added in libguestfs 1.19.7. In previous versions of libguestfs the limit was 25.

See "MAXIMUM NUMBER OF DISKS" in guestfs(3) for additional information on this topic.

Throws: LibGuestFSException

md_create

public void md_create(String name, String[] devices, Map<String,Object> optargs)
create a Linux md (RAID) device

Create a Linux md (RAID) device named "name" on the devices in the list "devices".

The optional parameters are:

"missingbitmap" A bitmap of missing devices. If a bit is set it means that a missing device is added to the array. The least significant bit corresponds to the first device in the array.

As examples:

If "devices = ["/dev/sda"]" and "missingbitmap = 0x1" then the resulting array would be "[, "/dev/sda"]".

If "devices = ["/dev/sda"]" and "missingbitmap = 0x2" then the resulting array would be "["/dev/sda", ]".

This defaults to 0 (no missing devices).

The length of "devices" + the number of bits set in "missingbitmap" must equal "nrdevices" + "spare".

"nrdevices" The number of active RAID devices.

If not set, this defaults to the length of "devices" plus the number of bits set in "missingbitmap".

"spare" The number of spare devices.

If not set, this defaults to 0.

"chunk" The chunk size in bytes.

"level" The RAID level, which can be one of: *linear*, *raid0*, *0*, *stripe*, *raid1*, *1*, *mirror*, *raid4*, *4*, *raid5*, *5*, *raid6*, *6*, *raid10*, *10*. Some of these are synonymous, and more levels may be added in future.

If not set, this defaults to "raid1".

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

md_create

public void md_create(String name, String[] devices)

md_detail

public Map<String,String> md_detail(String md)
obtain metadata for an MD device

This command exposes the output of 'mdadm -DY '. The following fields are usually present in the returned hash. Other fields may also be present.

"level" The raid level of the MD device.

"devices" The number of underlying devices in the MD device.

"metadata" The metadata version used.

"uuid" The UUID of the MD device.

"name" The name of the MD device.

Throws: LibGuestFSException

md_stat

public MDStat[] md_stat(String md)
get underlying devices from an MD device

This call returns a list of the underlying devices which make up the single software RAID array device "md".

To get a list of software RAID devices, call "g.list_md_devices".

Each structure returned corresponds to one device along with additional status information:

"mdstat_device" The name of the underlying device.

"mdstat_index" The index of this device within the array.

"mdstat_flags" Flags associated with this device. This is a string containing (in no specific order) zero or more of the following flags:

"W" write-mostly

"F" device is faulty

"S" device is a RAID spare

"R" replacement

Throws: LibGuestFSException

md_stop

public void md_stop(String md)
stop a Linux md (RAID) device

This command deactivates the MD array named "md". The device is stopped, but it is not destroyed or zeroed.

Throws: LibGuestFSException

mkdir

public void mkdir(String path)
create a directory

Create a directory named "path".

Throws: LibGuestFSException

mkdir_mode

public void mkdir_mode(String path, int mode)
create a directory with a particular mode

This command creates a directory, setting the initial permissions of the directory to "mode".

For common Linux filesystems, the actual mode which is set will be "mode & ~umask & 01777". Non-native-Linux filesystems may interpret the mode in other ways.

See also "g.mkdir", "g.umask"

Throws: LibGuestFSException

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 tmpl)
create a temporary directory

This command creates a temporary directory. The "tmpl" 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

public void mke2fs(String device, Map<String,Object> optargs)
create an ext2/ext3/ext4 filesystem on device

"mke2fs" is used to create an ext2, ext3, or ext4 filesystem on "device". The optional "blockscount" is the size of the filesystem in blocks. If omitted it defaults to the size of "device".

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

mke2fs

public void mke2fs(String device)

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

*This function is deprecated.* In new code, use the "mke2fs" 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

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

*This function is deprecated.* In new code, use the "mke2fs" 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

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

*This function is deprecated.* In new code, use the "mke2fs" 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

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

*This function is deprecated.* In new code, use the "mke2fs" 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

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

*This function is deprecated.* In new code, use the "mke2fs" 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

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

*This function is deprecated.* In new code, use the "mke2fs" 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

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

The mode actually set is affected by the umask.

Throws: LibGuestFSException

mkfs

public void mkfs(String fstype, String device, Map<String,Object> optargs)
make a filesystem

This function creates a filesystem on "device". The filesystem type is "fstype", for example "ext3".

The optional arguments are:

"blocksize" The filesystem block size. Supported block sizes depend on the filesystem type, but typically they are 1024, 2048 or 4096 for Linux ext2/3 filesystems.

For VFAT and NTFS the "blocksize" parameter is treated as the requested cluster size.

For UFS block sizes, please see mkfs.ufs(8).

"features" This passes the *-O* parameter to the external mkfs program.

For certain filesystem types, this allows extra filesystem features to be selected. See mke2fs(8) and mkfs.ufs(8) for more details.

You cannot use this optional parameter with the "gfs" or "gfs2" filesystem type.

"inode" This passes the *-I* parameter to the external mke2fs(8) program which sets the inode size (only for ext2/3/4 filesystems at present).

"sectorsize" This passes the *-S* parameter to external mkfs.ufs(8) program, which sets sector size for ufs filesystem.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

mkfs

public void mkfs(String fstype, String device)

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.

For VFAT and NTFS the "blocksize" parameter is treated as the requested cluster size.

*This function is deprecated.* In new code, use the "mkfs" 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

mkfs_btrfs

public void mkfs_btrfs(String[] devices, Map<String,Object> optargs)
create a btrfs filesystem

Create a btrfs filesystem, allowing all configurables to be set. For more information on the optional arguments, see mkfs.btrfs(8).

Since btrfs filesystems can span multiple devices, this takes a non-empty list of devices.

To create general filesystems, use "g.mkfs".

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

mkfs_btrfs

public void mkfs_btrfs(String[] devices)

mkfs_opts

public void mkfs_opts(String fstype, String device, Map<String,Object> optargs)

mkfs_opts

public void mkfs_opts(String fstype, String device)

mklost_and_found

public void mklost_and_found(String mountpoint)
make lost+found directory on an ext2/3/4 filesystem

Make the "lost+found" directory, normally in the root directory of an ext2/3/4 filesystem. "mountpoint" is the directory under which we try to create the "lost+found" directory.

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 /sqsh mkmountpoint /ext3fs mount /dev/sda /cd mount-loop /cd/LiveOS/squashfs.img /sqsh mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs

The inner filesystem is now unpacked under the /ext3fs mountpoint.

"g.mkmountpoint" is not compatible with "g.umount_all". You may get unexpected errors if you try to mix these calls. It is safest to manually unmount filesystems and remove mountpoints after use.

"g.umount_all" unmounts filesystems by sorting the paths longest first, so for this to work for manual mountpoints, you must ensure that the innermost mountpoints have the longest pathnames, as in the example code above.

For more details see

Autosync [see "g.set_autosync", this is set by default on handles] can cause "g.umount_all" to be called when the handle is closed which can also trigger these issues.

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.

Note that, just like mknod(2), the mode must be bitwise OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a regular file). These constants are available in the standard Linux header files, or you can use "g.mknod_b", "g.mknod_c" or "g.mkfifo" which are wrappers around this command which bitwise OR in the appropriate constant for you.

The mode actually set is affected by the umask.

Throws: LibGuestFSException

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

The mode actually set is affected by the umask.

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

The mode actually set is affected by the umask.

Throws: LibGuestFSException

mkswap

public void mkswap(String device, Map<String,Object> optargs)
create a swap partition

Create a Linux swap partition on "device".

The option arguments "label" and "uuid" allow you to set the label and/or UUID of the new swap partition.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

mkswap

public void mkswap(String device)

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.

*This function is deprecated.* In new code, use the "mkswap" 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

mkswap_opts

public void mkswap_opts(String device, Map<String,Object> optargs)

mkswap_opts

public void mkswap_opts(String device)

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

*This function is deprecated.* In new code, use the "mkswap" 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

mktemp

public String mktemp(String tmpl, Map<String,Object> optargs)
create a temporary file

This command creates a temporary file. The "tmpl" 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 file that was created is returned.

The temporary file is created with mode 0600 and is owned by root.

The caller is responsible for deleting the temporary file after use.

If the optional "suffix" parameter is given, then the suffix (eg. ".txt") is appended to the temporary name.

See also: "g.mkdtemp".

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

mktemp

public String mktemp(String tmpl)

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.

Before libguestfs 1.13.16, this call implicitly added the options "sync" and "noatime". The "sync" option greatly slowed writes and caused many problems for users. If your program might need to work with older versions of libguestfs, use "g.mount_options" instead (using an empty string for the first parameter if you don't want any options).

Throws: LibGuestFSException

mountpoints

public Map<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_9p

public void mount_9p(String mounttag, String mountpoint, Map<String,Object> optargs)
mount 9p filesystem

Mount the virtio-9p filesystem with the tag "mounttag" on the directory "mountpoint".

If required, "trans=virtio" will be automatically added to the options. Any other options required can be passed in the optional "options" parameter.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

mount_9p

public void mount_9p(String mounttag, String mountpoint)

mount_local

public void mount_local(String localmountpoint, Map<String,Object> optargs)
mount on the local filesystem

This call exports the libguestfs-accessible filesystem to a local mountpoint (directory) called "localmountpoint". Ordinary reads and writes to files and directories under "localmountpoint" are redirected through libguestfs.

If the optional "readonly" flag is set to true, then writes to the filesystem return error "EROFS".

"options" is a comma-separated list of mount options. See guestmount(1) for some useful options.

"cachetimeout" sets the timeout (in seconds) for cached directory entries. The default is 60 seconds. See guestmount(1) for further information.

If "debugcalls" is set to true, then additional debugging information is generated for every FUSE call.

When "g.mount_local" returns, the filesystem is ready, but is not processing requests (access to it will block). You have to call "g.mount_local_run" to run the main loop.

See "MOUNT LOCAL" in guestfs(3) for full documentation.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

mount_local

public void mount_local(String localmountpoint)

mount_local_run

public void mount_local_run()
run main loop of mount on the local filesystem

Run the main loop which translates kernel calls to libguestfs calls.

This should only be called after "g.mount_local" returns successfully. The call will not return until the filesystem is unmounted.

Note you must *not* make concurrent libguestfs calls on the same handle from another thread, with the exception of "g.umount_local".

You may call this from a different thread than the one which called "g.mount_local", subject to the usual rules for threads and libguestfs (see "MULTIPLE HANDLES AND MULTIPLE THREADS" in guestfs(3)).

See "MOUNT LOCAL" in guestfs(3) for full documentation.

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.

If the "options" parameter is an empty string, then no options are passed (all options default to whatever the filesystem uses).

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

nr_devices

public int nr_devices()
return number of whole block devices (disks) added

This returns the number of whole block devices that were added. This is the same as the number of devices that would be returned if you called "g.list_devices".

To find out the maximum number of devices that could be added, call "g.max_disks".

Throws: LibGuestFSException

ntfsclone_in

public void ntfsclone_in(String backupfile, String device)
restore NTFS from backup file

Restore the "backupfile" (from a previous call to "g.ntfsclone_out") to "device", overwriting any existing contents of this device.

Throws: LibGuestFSException

ntfsclone_out

public void ntfsclone_out(String device, String backupfile, Map<String,Object> optargs)
save NTFS to backup file

Stream the NTFS filesystem "device" to the local file "backupfile". The format used for the backup file is a special format used by the ntfsclone(8) tool.

If the optional "metadataonly" flag is true, then *only* the metadata is saved, losing all the user data (this is useful for diagnosing some filesystem problems).

The optional "rescue", "ignorefscheck", "preservetimestamps" and "force" flags have precise meanings detailed in the ntfsclone(8) man page.

Use "g.ntfsclone_in" to restore the file back to a libguestfs device.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

ntfsclone_out

public void ntfsclone_out(String device, String backupfile)

ntfsfix

public void ntfsfix(String device, Map<String,Object> optargs)
fix common errors and force Windows to check NTFS

This command repairs some fundamental NTFS inconsistencies, resets the NTFS journal file, and schedules an NTFS consistency check for the first boot into Windows.

This is *not* an equivalent of Windows "chkdsk". It does *not* scan the filesystem for inconsistencies.

The optional "clearbadsectors" flag clears the list of bad sectors. This is useful after cloning a disk with bad sectors to a new disk.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

ntfsfix

public void ntfsfix(String device)

ntfsresize

public void ntfsresize(String device, Map<String,Object> optargs)
resize an NTFS filesystem

This command resizes an NTFS filesystem, expanding or shrinking it to the size of the underlying device.

The optional parameters are:

"size" The new size (in bytes) of the filesystem. If omitted, the filesystem is resized to fit the container (eg. partition).

"force" If this option is true, then force the resize of the filesystem even if the filesystem is marked as requiring a consistency check.

After the resize operation, the filesystem is always marked as requiring a consistency check (for safety). You have to boot into Windows to perform this check and clear this condition. If you *don't* set the "force" option then it is not possible to call "g.ntfsresize" multiple times on a single filesystem without booting into Windows between each resize.

See also ntfsresize(8).

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

ntfsresize

public void ntfsresize(String device)

ntfsresize_opts

public void ntfsresize_opts(String device, Map<String,Object> optargs)

ntfsresize_opts

public void ntfsresize_opts(String device)

ntfsresize_size

public void ntfsresize_size(String device, long size)
resize an NTFS filesystem (with size)

This command is the same as "g.ntfsresize" except that it allows you to specify the new size (in bytes) explicitly.

*This function is deprecated.* In new code, use the "ntfsresize" 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

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

parse_environment

public void parse_environment()
parse the environment and set handle flags accordingly

Parse the program's environment and set flags in the handle accordingly. For example if "LIBGUESTFS_DEBUG=1" then the 'verbose' flag is set in the handle.

*Most programs do not need to call this*. It is done implicitly when you call "g.create".

See "ENVIRONMENT VARIABLES" in guestfs(3) for a list of environment variables that can affect libguestfs handles. See also "guestfs_create_flags" in guestfs(3), and "g.parse_environment_list".

Throws: LibGuestFSException

parse_environment_list

public void parse_environment_list(String[] environment)
parse the environment and set handle flags accordingly

Parse the list of strings in the argument "environment" and set flags in the handle accordingly. For example if "LIBGUESTFS_DEBUG=1" is a string in the list, then the 'verbose' flag is set in the handle.

This is the same as "g.parse_environment" except that it parses an explicit list of strings instead of the program's environment.

Throws: LibGuestFSException

part_add

public void part_add(String device, String prlogex, long startsect, long endsect)
add a partition to the device

This command adds a partition to "device". If there is no partition table on the device, call "g.part_init" first.

The "prlogex" parameter is the type of partition. Normally you should pass "p" or "primary" here, but MBR partition tables also support "l" (or "logical") and "e" (or "extended") partition types.

"startsect" and "endsect" are the start and end of the partition in *sectors*. "endsect" may be negative, which means it counts backwards from the end of the disk (-1 is the last sector).

Creating a partition which covers the whole disk is not so easy. Use "g.part_disk" to do that.

Throws: LibGuestFSException

part_del

public void part_del(String device, int partnum)
delete a partition

This command deletes the partition numbered "partnum" on "device".

Note that in the case of MBR partitioning, deleting an extended partition also deletes any logical partitions it contains.

Throws: LibGuestFSException

part_disk

public void part_disk(String device, String parttype)
partition whole disk with a single primary partition

This command is simply a combination of "g.part_init" followed by "g.part_add" to create a single primary partition covering the whole disk.

"parttype" is the partition table type, usually "mbr" or "gpt", but other possible values are described in "g.part_init".

Throws: LibGuestFSException

part_get_bootable

public boolean part_get_bootable(String device, int partnum)
return true if a partition is bootable

This command returns true if the partition "partnum" on "device" has the bootable flag set.

See also "g.part_set_bootable".

Throws: LibGuestFSException

part_get_mbr_id

public int part_get_mbr_id(String device, int partnum)
get the MBR type byte (ID byte) from a partition

Returns the MBR type byte (also known as the ID byte) from the numbered partition "partnum".

Note that only MBR (old DOS-style) partitions have type bytes. You will get undefined results for other partition table types (see "g.part_get_parttype").

Throws: LibGuestFSException

part_get_parttype

public String part_get_parttype(String device)
get the partition table type

This command examines the partition table on "device" and returns the partition table type (format) being used.

Common return values include: "msdos" (a DOS/Windows style MBR partition table), "gpt" (a GPT/EFI-style partition table). Other values are possible, although unusual. See "g.part_init" for a full list.

Throws: LibGuestFSException

part_init

public void part_init(String device, String parttype)
create an empty partition table

This creates an empty partition table on "device" of one of the partition types listed below. Usually "parttype" should be either "msdos" or "gpt" (for large disks).

Initially there are no partitions. Following this, you should call "g.part_add" for each partition required.

Possible values for "parttype" are:

efi gpt Intel EFI / GPT partition table.

This is recommended for >= 2 TB partitions that will be accessed from Linux and Intel-based Mac OS X. It also has limited backwards compatibility with the "mbr" format.

mbr msdos The standard PC "Master Boot Record" (MBR) format used by MS-DOS and Windows. This partition type will only work for device sizes up to 2 TB. For large disks we recommend using "gpt".

Other partition table types that may work but are not supported include:

aix AIX disk labels.

amiga rdb Amiga "Rigid Disk Block" format.

bsd BSD disk labels.

dasd DASD, used on IBM mainframes.

dvh MIPS/SGI volumes.

mac Old Mac partition format. Modern Macs use "gpt".

pc98 NEC PC-98 format, common in Japan apparently.

sun Sun disk labels.

Throws: LibGuestFSException

part_list

public Partition[] part_list(String device)
list partitions on a device

This command parses the partition table on "device" and returns the list of partitions found.

The fields in the returned structure are:

part_num Partition number, counting from 1.

part_start Start of the partition *in bytes*. To get sectors you have to divide by the device's sector size, see "g.blockdev_getss".

part_end End of the partition in bytes.

part_size Size of the partition in bytes.

Throws: LibGuestFSException

part_set_bootable

public void part_set_bootable(String device, int partnum, boolean bootable)
make a partition bootable

This sets the bootable flag on partition numbered "partnum" on device "device". Note that partitions are numbered from 1.

The bootable flag is used by some operating systems (notably Windows) to determine which partition to boot from. It is by no means universally recognized.

Throws: LibGuestFSException

part_set_mbr_id

public void part_set_mbr_id(String device, int partnum, int idbyte)
set the MBR type byte (ID byte) of a partition

Sets the MBR type byte (also known as the ID byte) of the numbered partition "partnum" to "idbyte". Note that the type bytes quoted in most documentation are in fact hexadecimal numbers, but usually documented without any leading "0x" which might be confusing.

Note that only MBR (old DOS-style) partitions have type bytes. You will get undefined results for other partition table types (see "g.part_get_parttype").

Throws: LibGuestFSException

part_set_name

public void part_set_name(String device, int partnum, String name)
set partition name

This sets the partition name on partition numbered "partnum" on device "device". Note that partitions are numbered from 1.

The partition name can only be set on certain types of partition table. This works on "gpt" but not on "mbr" partitions.

Throws: LibGuestFSException

part_to_dev

public String part_to_dev(String partition)
convert partition name to device name

This function takes a partition name (eg. "/dev/sdb1") and removes the partition number, returning the device name (eg. "/dev/sdb").

The named partition must exist, for example as a string returned from "g.list_partitions".

See also "g.part_to_partnum", "g.device_index".

Throws: LibGuestFSException

part_to_partnum

public int part_to_partnum(String partition)
convert partition name to partition number

This function takes a partition name (eg. "/dev/sdb1") and returns the partition number (eg. 1).

The named partition must exist, for example as a string returned from "g.list_partitions".

See also "g.part_to_dev".

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

pread

public String pread(String path, int count, long offset)
read part of a file

This command lets you read part of a file. It reads "count" bytes of the file, starting at "offset", from file "path".

This may read fewer bytes than requested. For further details see the pread(2) system call.

See also "g.pwrite", "g.pread_device".

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).

Throws: LibGuestFSException

pread_device

public String pread_device(String device, int count, long offset)
read part of a device

This command lets you read part of a file. It reads "count" bytes of "device", starting at "offset".

This may read fewer bytes than requested. For further details see the pread(2) system call.

See also "g.pread".

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).

Throws: LibGuestFSException

pvchange_uuid

public void pvchange_uuid(String device)
generate a new random UUID for a physical volume

Generate a new random UUID for the physical volume "device".

Throws: LibGuestFSException

pvchange_uuid_all

public void pvchange_uuid_all()
generate new random UUIDs for all physical volumes

Generate new random UUIDs for all physical volumes.

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

pvresize_size

public void pvresize_size(String device, long size)
resize an LVM physical volume (with size)

This command is the same as "g.pvresize" except that it allows you to specify the new size (in bytes) explicitly.

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

pvuuid

public String pvuuid(String device)
get the UUID of a physical volume

This command returns the UUID of the LVM PV "device".

Throws: LibGuestFSException

pwrite

public int pwrite(String path, byte[] content, long offset)
write to part of a file

This command writes to part of a file. It writes the data buffer "content" to the file "path" starting at offset "offset".

This command implements the pwrite(2) system call, and like that system call it may not write the full data requested. The return value is the number of bytes that were actually written to the file. This could even be 0, although short writes are unlikely for regular files in ordinary circumstances.

See also "g.pread", "g.pwrite_device".

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).

Throws: LibGuestFSException

pwrite_device

public int pwrite_device(String device, byte[] content, long offset)
write to part of a device

This command writes to part of a device. It writes the data buffer "content" to "device" starting at offset "offset".

This command implements the pwrite(2) system call, and like that system call it may not write the full data requested (although short writes to disk devices and partitions are probably impossible with standard Linux kernels).

See also "g.pwrite".

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).

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

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).

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

readlinklist

public String[] readlinklist(String path, String[] names)
readlink on multiple files

This call allows you to do a "readlink" operation on multiple files, where all files are in the directory "path". "names" is the list of files from this directory.

On return you get a list of strings, with a one-to-one correspondence to the "names" list. Each string is the value of the symbolic link.

If the readlink(2) operation fails on any name, then the corresponding result string is the empty string "". However the whole operation is completed even if there were readlink(2) errors, and so you can call this function with names where you don't know if they are symbolic links already (albeit slightly less efficient).

This call is intended for programs that want to efficiently list a directory contents without making many round-trips.

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.

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 string). For those you need to use the "g.read_file" function and split the buffer into lines yourself.

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

remove_drive

public void remove_drive(String label)
remove a disk image

This function is conceptually the opposite of "g.add_drive_opts". It removes the drive that was previously added with label "label".

Note that in order to remove drives, you have to add them with labels (see the optional "label" argument to "g.add_drive_opts"). If you didn't use a label, then they cannot be removed.

You can call this function before or after launching the handle. If called after launch, if the attach-method supports it, we try to hot unplug the drive: see "HOTPLUGGING" in guestfs(3). The disk must not be in use (eg. mounted) when you do this. We try to detect if the disk is in use and stop you from doing this.

Throws: LibGuestFSException

resize2fs

public void resize2fs(String device)
resize an ext2, ext3 or ext4 filesystem

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

See also "RESIZE2FS ERRORS" in guestfs(3).

Throws: LibGuestFSException

resize2fs_M

public void resize2fs_M(String device)
resize an ext2, ext3 or ext4 filesystem to the minimum size

This command is the same as "g.resize2fs", but the filesystem is resized to its minimum size. This works like the *-M* option to the "resize2fs" command.

To get the resulting size of the filesystem you should call "g.tune2fs_l" and read the "Block size" and "Block count" values. These two numbers, multiplied together, give the resulting size of the minimal filesystem in bytes.

See also "RESIZE2FS ERRORS" in guestfs(3).

Throws: LibGuestFSException

resize2fs_size

public void resize2fs_size(String device, long size)
resize an ext2, ext3 or ext4 filesystem (with size)

This command is the same as "g.resize2fs" except that it allows you to specify the new size (in bytes) explicitly.

See also "RESIZE2FS ERRORS" in guestfs(3).

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_f

public void rm_f(String path)
remove a file ignoring errors

Remove the file "path".

If the file doesn't exist, that error is ignored. (Other errors, eg. I/O errors or bad paths, are not ignored)

This call cannot remove directories. Use "g.rmdir" to remove an empty directory, or "g.rm_rf" to remove directories recursively.

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

rsync

public void rsync(String src, String dest, Map<String,Object> optargs)
synchronize the contents of two directories

This call may be used to copy or synchronize two directories under the same libguestfs handle. This uses the rsync(1) program which uses a fast algorithm that avoids copying files unnecessarily.

"src" and "dest" are the source and destination directories. Files are copied from "src" to "dest".

The optional arguments are:

"archive" Turns on archive mode. This is the same as passing the *--archive* flag to "rsync".

"deletedest" Delete files at the destination that do not exist at the source.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

rsync

public void rsync(String src, String dest)

rsync_in

public void rsync_in(String remote, String dest, Map<String,Object> optargs)
synchronize host or remote filesystem with filesystem

This call may be used to copy or synchronize the filesystem on the host or on a remote computer with the filesystem within libguestfs. This uses the rsync(1) program which uses a fast algorithm that avoids copying files unnecessarily.

This call only works if the network is enabled. See "g.set_network" or the *--network* option to various tools like guestfish(1).

Files are copied from the remote server and directory specified by "remote" to the destination directory "dest".

The format of the remote server string is defined by rsync(1). Note that there is no way to supply a password or passphrase so the target must be set up not to require one.

The optional arguments are the same as those of "g.rsync".

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

rsync_in

public void rsync_in(String remote, String dest)

rsync_out

public void rsync_out(String src, String remote, Map<String,Object> optargs)
synchronize filesystem with host or remote filesystem

This call may be used to copy or synchronize the filesystem within libguestfs with a filesystem on the host or on a remote computer. This uses the rsync(1) program which uses a fast algorithm that avoids copying files unnecessarily.

This call only works if the network is enabled. See "g.set_network" or the *--network* option to various tools like guestfish(1).

Files are copied from the source directory "src" to the remote server and directory specified by "remote".

The format of the remote server string is defined by rsync(1). Note that there is no way to supply a password or passphrase so the target must be set up not to require one.

The optional arguments are the same as those of "g.rsync".

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

rsync_out

public void rsync_out(String src, String remote)

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.

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_attach_method

public void set_attach_method(String attachmethod)
set the attach method

Set the method that libguestfs uses to connect to the back end guestfsd daemon.

See "ATTACH METHOD" in guestfs(3).

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 make filesystems consistent and synchronized when the handle is closed (also if the program exits without closing handles).

This is enabled by default (since libguestfs 1.5.24, previously it was disabled by default).

Throws: LibGuestFSException

set_cachedir

public void set_cachedir(String cachedir)
set the appliance cache directory

Set the directory used by the handle to store the appliance cache, when using a supermin appliance. The appliance is cached and shared between all handles which have the same effective user ID.

The environment variables "LIBGUESTFS_CACHEDIR" and "TMPDIR" control the default value: If "LIBGUESTFS_CACHEDIR" is set, then that is the default. Else if "TMPDIR" is set, then that is the default. Else "/var/tmp" is the 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_e2attrs

public void set_e2attrs(String file, String attrs, Map<String,Object> optargs)
set ext2 file attributes of a file

This sets or clears the file attributes "attrs" associated with the inode "file".

"attrs" is a string of characters representing file attributes. See "g.get_e2attrs" for a list of possible attributes. Not all attributes can be changed.

If optional boolean "clear" is not present or false, then the "attrs" listed are set in the inode.

If "clear" is true, then the "attrs" listed are cleared in the inode.

In both cases, other attributes not present in the "attrs" string are left unchanged.

These attributes are only present when the file is located on an ext2/3/4 filesystem. Using this call on other filesystem types will result in an error.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

set_e2attrs

public void set_e2attrs(String file, String attrs)

set_e2generation

public void set_e2generation(String file, long generation)
set ext2 file generation of a file

This sets the ext2 file generation of a file.

See "g.get_e2generation".

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.

*This function is deprecated.* In new code, use the "set_label" 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

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_label

public void set_label(String device, String label)
set filesystem label

Set the filesystem label on "device" to "label".

Only some filesystem types support labels, and libguestfs supports setting labels on only a subset of these.

On ext2/3/4 filesystems, labels are limited to 16 bytes.

On NTFS filesystems, labels are limited to 128 unicode characters.

To read the label on a filesystem, call "g.vfs_label".

Throws: LibGuestFSException

set_libvirt_requested_credential

public void set_libvirt_requested_credential(int index, byte[] cred)
pass requested credential back to libvirt

After requesting the "index"'th credential from the user, call this function to pass the answer back to libvirt.

See "LIBVIRT AUTHENTICATION" in guestfs(3) for documentation and example code.

Throws: LibGuestFSException

set_libvirt_supported_credentials

public void set_libvirt_supported_credentials(String[] creds)
set libvirt credentials supported by calling program

Call this function before setting an event handler for "GUESTFS_EVENT_LIBVIRT_AUTH", to supply the list of credential types that the program knows how to process.

The "creds" list must be a non-empty list of strings. Possible strings are:

"username" "authname" "language" "cnonce" "passphrase" "echoprompt" "noechoprompt" "realm" "external"

See libvirt documentation for the meaning of these credential types.

See "LIBVIRT AUTHENTICATION" in guestfs(3) for documentation and example code.

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_network

public void set_network(boolean network)
set enable network flag

If "network" is true, then the network is enabled in the libguestfs appliance. The default is false.

This affects whether commands are able to access the network (see "RUNNING COMMANDS" in guestfs(3)).

You must call this before calling "g.launch", otherwise it has no effect.

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_pgroup

public void set_pgroup(boolean pgroup)
set process group flag

If "pgroup" is true, child processes are placed into their own process group.

The practical upshot of this is that signals like "SIGINT" (from users pressing "^C") won't be received by the child process.

The default for this flag is false, because usually you want "^C" to kill the subprocess. Guestfish sets this flag to true when used interactively, so that "^C" can cancel long-running commands gracefully (see "g.user_cancel").

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.

Note that you should call this function as early as possible after creating the handle. This is because some pre-launch operations depend on testing qemu features (by running "qemu -help"). If the qemu binary changes, we don't retest features, and so you might see inconsistent results. Using the environment variable "LIBGUESTFS_QEMU" is safest of all since that picks the qemu binary at the same time as the handle is created.

Throws: LibGuestFSException

set_recovery_proc

public void set_recovery_proc(boolean recoveryproc)
enable or disable the recovery process

If this is called with the parameter "false" then "g.launch" does not create a recovery process. The purpose of the recovery process is to stop runaway qemu processes in the case where the main program aborts abruptly.

This only has any effect if called before "g.launch", and the default is true.

About the only time when you would want to disable this is if the main process will fork itself into the background ("daemonize" itself). In this case the recovery process thinks that the main program has disappeared and so kills qemu, which is not very helpful.

Throws: LibGuestFSException

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_smp

public void set_smp(int smp)
set number of virtual CPUs in appliance

Change the number of virtual CPUs assigned to the appliance. The default is 1. Increasing this may improve performance, though often it has no effect.

This function must be called before "g.launch".

Throws: LibGuestFSException

set_tmpdir

public void set_tmpdir(String tmpdir)
set the temporary directory

Set the directory used by the handle to store temporary files.

The environment variables "LIBGUESTFS_TMPDIR" and "TMPDIR" control the default value: If "LIBGUESTFS_TMPDIR" is set, then that is the default. Else if "TMPDIR" is set, then that is the default. Else "/tmp" is the default.

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 libguestfs calls, parameters and return values are traced.

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.

Trace messages are normally sent to "stderr", unless you register a callback to send them somewhere else (see "g.set_event_callback").

Throws: LibGuestFSException

set_verbose

public void set_verbose(boolean verbose)
set verbose mode

If "verbose" is true, this turns on verbose messages.

Verbose messages are disabled unless the environment variable "LIBGUESTFS_DEBUG" is defined and set to 1.

Verbose messages are normally sent to "stderr", unless you register a callback to send them somewhere else (see "g.set_event_callback").

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", "g.part_init"

*This function is deprecated.* In new code, use the "part_add" 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

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", the sfdisk(8) manpage and "g.part_disk"

*This function is deprecated.* In new code, use the "part_add" 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

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.

See also: "g.part_list"

*This function is deprecated.* In new code, use the "part_list" 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

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.

See also: "g.part_add"

*This function is deprecated.* In new code, use the "part_add" 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

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

shutdown

public void shutdown()
shutdown the qemu subprocess

This is the opposite of "g.launch". It performs an orderly shutdown of the backend process(es). If the autosync flag is set (which is the default) then the disk image is synchronized.

If the subprocess exits with an error then this function will return an error, which should *not* be ignored (it may indicate that the disk image could not be written out properly).

It is safe to call this multiple times. Extra calls are ignored.

This call does *not* close or free up the handle. You still need to call "g.close" afterwards.

"g.close" will call this if you don't do it explicitly, but note that any errors are ignored in that case.

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. See "PROTOCOL LIMITS" in guestfs(3).

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 of strings that are looked for in the source file "path".

Allowed encodings are:

s Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of ISO-8859-X (this is what "g.strings" uses).

S Single 8-bit-byte characters.

b 16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE.

l (lower case letter L) 16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for examining binaries in Windows guests.

B 32-bit big endian such as UCS-4BE.

L 32-bit little endian such as UCS-4LE.

The returned strings are transcoded to UTF-8.

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).

Throws: LibGuestFSException

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. See "PROTOCOL LIMITS" in guestfs(3).

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. See "PROTOCOL LIMITS" in guestfs(3).

Throws: LibGuestFSException

tar_in

public void tar_in(String tarfile, String directory, Map<String,Object> optargs)
unpack tarfile to directory

This command uploads and unpacks local file "tarfile" into "directory".

The optional "compress" flag controls compression. If not given, then the input should be an uncompressed tar file. Otherwise one of the following strings may be given to select the compression type of the input file: "compress", "gzip", "bzip2", "xz", "lzop". (Note that not all builds of libguestfs will support all of these compression types).

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

tar_in

public void tar_in(String tarfile, String directory)

tar_in_opts

public void tar_in_opts(String tarfile, String directory, Map<String,Object> optargs)

tar_in_opts

public void tar_in_opts(String tarfile, String directory)

tar_out

public void tar_out(String directory, String tarfile, Map<String,Object> optargs)
pack directory into tarfile

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

The optional "compress" flag controls compression. If not given, then the output will be an uncompressed tar file. Otherwise one of the following strings may be given to select the compression type of the output file: "compress", "gzip", "bzip2", "xz", "lzop". (Note that not all builds of libguestfs will support all of these compression types).

The other optional arguments are:

"excludes" A list of wildcards. Files are excluded if they match any of the wildcards.

"numericowner" If set to true, the output tar file will contain UID/GID numbers instead of user/group names.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

tar_out

public void tar_out(String directory, String tarfile)

tar_out_opts

public void tar_out_opts(String directory, String tarfile, Map<String,Object> optargs)

tar_out_opts

public void tar_out_opts(String directory, String tarfile)

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

*This function is deprecated.* In new code, use the "tar_in" 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

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

*This function is deprecated.* In new code, use the "tar_out" 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

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.

This command only works on regular files, and will fail on other file types such as directories, symbolic links, block special etc.

Throws: LibGuestFSException

truncate

public void truncate(String path)
truncate a file to zero size

This command truncates "path" to a zero-length file. The file must exist already.

Throws: LibGuestFSException

truncate_size

public void truncate_size(String path, long size)
truncate a file to a particular size

This command truncates "path" to size "size" bytes. The file must exist already.

If the current file size is less than "size" then the file is extended to the required size with zero bytes. This creates a sparse file (ie. disk blocks are not allocated for the file until you write to it). To create a non-sparse file of zeroes, use "g.fallocate64" instead.

Throws: LibGuestFSException

tune2fs

public void tune2fs(String device, Map<String,Object> optargs)
adjust ext2/ext3/ext4 filesystem parameters

This call allows you to adjust various filesystem parameters of an ext2/ext3/ext4 filesystem called "device".

The optional parameters are:

"force" Force tune2fs to complete the operation even in the face of errors. This is the same as the tune2fs "-f" option.

"maxmountcount" Set the number of mounts after which the filesystem is checked by e2fsck(8). If this is 0 then the number of mounts is disregarded. This is the same as the tune2fs "-c" option.

"mountcount" Set the number of times the filesystem has been mounted. This is the same as the tune2fs "-C" option.

"errorbehavior" Change the behavior of the kernel code when errors are detected. Possible values currently are: "continue", "remount-ro", "panic". In practice these options don't really make any difference, particularly for write errors.

This is the same as the tune2fs "-e" option.

"group" Set the group which can use reserved filesystem blocks. This is the same as the tune2fs "-g" option except that it can only be specified as a number.

"intervalbetweenchecks" Adjust the maximal time between two filesystem checks (in seconds). If the option is passed as 0 then time-dependent checking is disabled.

This is the same as the tune2fs "-i" option.

"reservedblockspercentage" Set the percentage of the filesystem which may only be allocated by privileged processes. This is the same as the tune2fs "-m" option.

"lastmounteddirectory" Set the last mounted directory. This is the same as the tune2fs "-M" option.

"reservedblockscount" Set the number of reserved filesystem blocks. This is the same as the tune2fs "-r" option. "user" Set the user who can use the reserved filesystem blocks. This is the same as the tune2fs "-u" option except that it can only be specified as a number.

To get the current values of filesystem parameters, see "g.tune2fs_l". For precise details of how tune2fs works, see the tune2fs(8) man page.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

tune2fs

public void tune2fs(String device)

tune2fs_l

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

txz_in

public void txz_in(String tarball, String directory)
unpack compressed tarball to directory

This command uploads and unpacks local file "tarball" (an *xz compressed* tar file) into "directory".

*This function is deprecated.* In new code, use the "tar_in" 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

txz_out

public void txz_out(String directory, String tarball)
pack directory into compressed tarball

This command packs the contents of "directory" and downloads it to local file "tarball" (as an xz compressed tar archive).

*This function is deprecated.* In new code, use the "tar_out" 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

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 "g.get_umask", umask(2), "g.mknod", "g.mkdir".

This call returns the previous umask.

Throws: LibGuestFSException

umount

public void umount(String pathordevice, Map<String,Object> optargs)
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.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

umount

public void umount(String pathordevice)

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

umount_local

public void umount_local(Map<String,Object> optargs)
unmount a locally mounted filesystem

If libguestfs is exporting the filesystem on a local mountpoint, then this unmounts it.

See "MOUNT LOCAL" in guestfs(3) for full documentation.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

umount_local

public void umount_local()

umount_opts

public void umount_opts(String pathordevice, Map<String,Object> optargs)

umount_opts

public void umount_opts(String pathordevice)

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

upload_offset

public void upload_offset(String filename, String remotefilename, long offset)
upload a file from the local machine with offset

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

"remotefilename" is overwritten starting at the byte "offset" specified. The intention is to overwrite parts of existing files or devices, although if a non-existant file is specified then it is created with a "hole" before "offset". The size of the data written is implicit in the size of the source "filename".

Note that there is no limit on the amount of data that can be uploaded with this call, unlike with "g.pwrite", and this call always writes the full amount unless an error occurs.

See also "g.upload", "g.pwrite".

Throws: LibGuestFSException

utimens

public void utimens(String path, long atsecs, long atnsecs, long mtsecs, long mtnsecs)
set timestamp of a file with nanosecond precision

This command sets the timestamps of a file with nanosecond precision.

"atsecs, atnsecs" are the last access time (atime) in secs and nanoseconds from the epoch.

"mtsecs, mtnsecs" are the last modification time (mtime) in secs and nanoseconds from the epoch.

If the *nsecs field contains the special value -1 then the corresponding timestamp is set to the current time. (The *secs field is ignored in this case).

If the *nsecs field contains the special value -2 then the corresponding timestamp is left unchanged. (The *secs field is ignored in this case).

Throws: LibGuestFSException

utsname

public UTSName utsname()
appliance kernel version

This returns the kernel version of the appliance, where this is available. This information is only useful for debugging. Nothing in the returned structure is defined by the API.

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 dynamic linker functions 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"

See also: "LIBGUESTFS VERSION NUMBERS" in guestfs(3).

*Note:* Don't use this call to test for availability of features. In enterprise distributions we backport features from later versions into earlier versions, making this an unreliable way to test for features. Use "g.available" instead.

Throws: LibGuestFSException

vfs_label

public String vfs_label(String device)
get the filesystem label

This returns the filesystem label of the filesystem on "device".

If the filesystem is unlabeled, this returns the empty string.

To find a filesystem from the label, use "g.findfs_label".

Throws: LibGuestFSException

vfs_type

public String vfs_type(String device)
get the Linux VFS type corresponding to a mounted device

This command gets the filesystem type corresponding to the filesystem on "device".

For most filesystems, the result is the name of the Linux VFS module which would be used to mount this filesystem if you mounted it without specifying the filesystem type. For example a string such as "ext3" or "ntfs".

Throws: LibGuestFSException

vfs_uuid

public String vfs_uuid(String device)
get the filesystem UUID

This returns the filesystem UUID of the filesystem on "device".

If the filesystem does not have a UUID, this returns the empty string.

To find a filesystem from the UUID, use "g.findfs_uuid".

Throws: LibGuestFSException

vgchange_uuid

public void vgchange_uuid(String vg)
generate a new random UUID for a volume group

Generate a new random UUID for the volume group "vg".

Throws: LibGuestFSException

vgchange_uuid_all

public void vgchange_uuid_all()
generate new random UUIDs for all volume groups

Generate new random UUIDs for all volume groups.

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

vglvuuids

public String[] vglvuuids(String vgname)
get the LV UUIDs of all LVs in the volume group

Given a VG called "vgname", this returns the UUIDs of all the logical volumes created in this volume group.

You can use this along with "g.lvs" and "g.lvuuid" calls to associate logical volumes and volume groups.

See also "g.vgpvuuids".

Throws: LibGuestFSException

vgmeta

public String vgmeta(String vgname)
get volume group metadata

"vgname" is an LVM volume group. This command examines the volume group and returns its metadata.

Note that the metadata is an internal structure used by LVM, subject to change at any time, and is provided for information only.

Throws: LibGuestFSException

vgpvuuids

public String[] vgpvuuids(String vgname)
get the PV UUIDs containing the volume group

Given a VG called "vgname", this returns the UUIDs of all the physical volumes that this volume group resides on.

You can use this along with "g.pvs" and "g.pvuuid" calls to associate physical volumes and volume groups.

See also "g.vglvuuids".

Throws: LibGuestFSException

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

vgrename

public void vgrename(String volgroup, String newvolgroup)
rename an LVM volume group

Rename a volume group "volgroup" with the new name "newvolgroup".

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

vgscan

public void vgscan()
rescan for LVM physical volumes, volume groups and logical volumes

This rescans all block devices and rebuilds the list of LVM physical volumes, volume groups and logical volumes.

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

vguuid

public String vguuid(String vgname)
get the UUID of a volume group

This command returns the UUID of the LVM VG named "vgname".

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

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.

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.

*This function is deprecated.* In new code, use the "launch" 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

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

wipefs

public void wipefs(String device)
wipe a filesystem signature from a device

This command erases filesystem or RAID signatures from the specified "device" to make the filesystem invisible to libblkid.

This does not erase the filesystem itself nor any other data from the "device".

Compare with "g.zero" which zeroes the first few blocks of a device.

Throws: LibGuestFSException

write

public void write(String path, byte[] content)
create a new file

This call creates a file called "path". The content of the file is the string "content" (which can contain any 8 bit data).

See also "g.write_append".

Throws: LibGuestFSException

write_append

public void write_append(String path, byte[] content)
append content to end of file

This call appends "content" to the end of file "path". If "path" does not exist, then a new file is created.

See also "g.write".

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.

Because of the message protocol, there is a transfer limit of somewhere between 2MB and 4MB. See "PROTOCOL LIMITS" in guestfs(3).

*This function is deprecated.* In new code, use the "write" 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

xfs_admin

public void xfs_admin(String device, Map<String,Object> optargs)
change parameters of an XFS filesystem

Change the parameters of the XFS filesystem on "device".

Devices that are mounted cannot be modified. Administrators must unmount filesystems before this call can modify parameters.

Some of the parameters of a mounted filesystem can be examined and modified using the "g.xfs_info" and "g.xfs_growfs" calls.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

xfs_admin

public void xfs_admin(String device)

xfs_growfs

public void xfs_growfs(String path, Map<String,Object> optargs)
expand an existing XFS filesystem

Grow the XFS filesystem mounted at "path".

The returned struct contains geometry information. Missing fields are returned as -1 (for numeric fields) or empty string.

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

xfs_growfs

public void xfs_growfs(String path)

xfs_info

public XFSInfo xfs_info(String pathordevice)
get geometry of XFS filesystem

"pathordevice" is a mounted XFS filesystem or a device containing an XFS filesystem. This command returns the geometry of the filesystem.

The returned struct contains geometry information. Missing fields are returned as -1 (for numeric fields) or empty string.

Throws: LibGuestFSException

xfs_repair

public int xfs_repair(String device, Map<String,Object> optargs)
repair an XFS filesystem

Repair corrupt or damaged XFS filesystem on "device".

The filesystem is specified using the "device" argument which should be the device name of the disk partition or volume containing the filesystem. If given the name of a block device, "xfs_repair" will attempt to find the raw device associated with the specified block device and will use the raw device instead.

Regardless, the filesystem to be repaired must be unmounted, otherwise, the resulting filesystem may be inconsistent or corrupt.

The returned status indicates whether filesystem corruption was detected (returns 1) or was not detected (returns 0).

Optional arguments are supplied in the final Map parameter, which is a hash of the argument name to its value (cast to Object). Pass an empty Map or null for no optional arguments.

Throws: LibGuestFSException

xfs_repair

public int xfs_repair(String device)

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. See "PROTOCOL LIMITS" in guestfs(3).

*This function is deprecated.* In new code, use the "grep" 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

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. See "PROTOCOL LIMITS" in guestfs(3).

*This function is deprecated.* In new code, use the "grep" 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

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.

If blocks are already zero, then this command avoids writing zeroes. This prevents the underlying device from becoming non-sparse or growing unnecessarily.

See also: "g.zero_device", "g.scrub_device", "g.is_zero_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

zero_device

public void zero_device(String device)
write zeroes to an entire device

This command writes zeroes over the entire "device". Compare with "g.zero" which just zeroes the first few blocks of a device.

If blocks are already zero, then this command avoids writing zeroes. This prevents the underlying device from becoming non-sparse or growing unnecessarily.

Throws: LibGuestFSException

zero_free_space

public void zero_free_space(String directory)
zero free space in a filesystem

Zero the free space in the filesystem mounted on "directory". The filesystem must be mounted read-write.

The filesystem contents are not affected, but any free space in the filesystem is freed.

Free space is not "trimmed". You may want to call "g.fstrim" either as an alternative to this, or after calling this, depending on your requirements.

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. See "PROTOCOL LIMITS" in guestfs(3).

*This function is deprecated.* In new code, use the "grep" 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

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. See "PROTOCOL LIMITS" in guestfs(3).

*This function is deprecated.* In new code, use the "grep" 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

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. See "PROTOCOL LIMITS" in guestfs(3).

*This function is deprecated.* In new code, use the "grep" 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

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. See "PROTOCOL LIMITS" in guestfs(3).

*This function is deprecated.* In new code, use the "grep" 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