# Class GuestFS

java.lang.Object
com.redhat.et.libguestfs.GuestFS

public class GuestFS extends Object

Libguestfs handle.

The `GuestFS` object corresponds to a libguestfs handle.

Note that the main documentation for the libguestfs API is in the following man pages:

1. `guestfs-java(3)` and
2. `guestfs(3)`.

This javadoc is not a good introduction to using libguestfs.

## Field Summary

Fields
Modifier and Type
Field
Description
`static final long`
`EVENT_ALL`
Bitmask of all events.
`static final long`
`EVENT_APPLIANCE`
Event 'appliance'.
`static final long`
`EVENT_CLOSE`
Event 'close'.
`static final long`
`EVENT_ENTER`
Event 'enter'.
`static final long`
`EVENT_LAUNCH_DONE`
Event 'launch_done'.
`static final long`
`EVENT_LIBRARY`
Event 'library'.
`static final long`
`EVENT_LIBVIRT_AUTH`
Event 'libvirt_auth'.
`static final long`
`EVENT_PROGRESS`
Event 'progress'.
`static final long`
`EVENT_SUBPROCESS_QUIT`
Event 'subprocess_quit'.
`static final long`
`EVENT_TRACE`
Event 'trace'.
`static final long`
`EVENT_WARNING`
Event 'warning'.

## Constructor Summary

Constructors
Constructor
Description
`GuestFS()`
Create a libguestfs handle.
`GuestFS(Map<String,Object> optargs)`
Create a libguestfs handle, setting flags.

## Method Summary

Modifier and Type
Method
Description
`void`
`acl_delete_def_file(String dir)`
delete the default POSIX ACL of a directory
`String`
`acl_get_file(String path, String acltype)`
get the POSIX ACL attached to a file
`void`
`acl_set_file(String path, String acltype, String acl)`
set the POSIX ACL attached to a file
`void`
`add_cdrom(String filename)`
Deprecated.
In new code, use `add_drive_ro(String)` instead
`int`
`add_domain(String dom)`
`int`
`add_domain(String dom, Map<String,Object> optargs)`
add the disk(s) from a named libvirt domain
`void`
`add_drive(String filename)`
`void`
`add_drive(String filename, Map<String,Object> optargs)`
add an image to examine or modify
`void`
`add_drive_opts(String filename)`
`void`
`add_drive_opts(String filename, Map<String,Object> optargs)`
`void`
`add_drive_ro(String filename)`
add a drive in snapshot mode (read-only)
`void`
`add_drive_ro_with_if(String filename, String iface)`
Deprecated.
In new code, use `add_drive(String, Map)` instead
`void`
`add_drive_scratch(long size)`
`void`
`add_drive_scratch(long size, Map<String,Object> optargs)`
add a temporary scratch drive
`void`
`add_drive_with_if(String filename, String iface)`
Deprecated.
In new code, use `add_drive(String, Map)` instead
`int`
`add_libvirt_dom(long dom)`
`int`
`add_libvirt_dom(long dom, Map<String,Object> optargs)`
add the disk(s) from a libvirt domain
`void`
`aug_clear(String augpath)`
clear Augeas path
`void`
`aug_close()`
close the current Augeas handle
`IntBool`
`aug_defnode(String name, String expr, String val)`
define an Augeas node
`int`
`aug_defvar(String name, String expr)`
define an Augeas variable
`String`
`aug_get(String augpath)`
look up the value of an Augeas path
`void`
`aug_init(String root, int flags)`
create a new Augeas handle
`void`
`aug_insert(String augpath, String label, boolean before)`
insert a sibling Augeas node
`String`
`aug_label(String augpath)`
return the label from an Augeas path expression
`void`
`aug_load()`
load files into the tree
`String[]`
`aug_ls(String augpath)`
list Augeas nodes under augpath
`String[]`
`aug_match(String augpath)`
return Augeas nodes which match augpath
`void`
`aug_mv(String src, String dest)`
move Augeas node
`int`
`aug_rm(String augpath)`
remove an Augeas path
`void`
`aug_save()`
write all pending Augeas changes to disk
`void`
`aug_set(String augpath, String val)`
set Augeas path to value
`int`
`aug_setm(String base, String sub, String val)`
set multiple Augeas nodes
`void`
`aug_transform(String lens, String file)`
`void`
`aug_transform(String lens, String file, Map<String,Object> optargs)`
add/remove an Augeas lens transformation
`void`
`available(String[] groups)`
test availability of some parts of the API
`String[]`
`available_all_groups()`
return a list of all optional groups
`void`
`base64_in(String base64file, String filename)`
upload base64-encoded data to file
`void`
`base64_out(String filename, String base64file)`
download file and encode as base64
`void`
`blkdiscard(String device)`
discard all blocks on a device
`boolean`
`blkdiscardzeroes(String device)`
return true if discarded blocks are read as zeroes
`Map<String,String>`
`blkid(String device)`
print block device attributes
`void`
`blockdev_flushbufs(String device)`
flush device buffers
`int`
`blockdev_getbsz(String device)`
get blocksize of block device
`boolean`
`blockdev_getro(String device)`
is block device set to read-only
`long`
`blockdev_getsize64(String device)`
get total size of device in bytes
`int`
`blockdev_getss(String device)`
get sectorsize of block device
`long`
`blockdev_getsz(String device)`
get total size of device in 512-byte sectors
`void`
`blockdev_rereadpt(String device)`
reread partition table
`void`
`blockdev_setbsz(String device, int blocksize)`
Deprecated.
There is no documented replacement
`void`
`blockdev_setra(String device, int sectors)`
set readahead
`void`
`blockdev_setro(String device)`
set block device to read-only
`void`
`blockdev_setrw(String device)`
set block device to read-write
`void`
`btrfs_balance_cancel(String path)`
cancel a running or paused balance
`void`
`btrfs_balance_pause(String path)`
pause a running balance
`void`
`btrfs_balance_resume(String path)`
resume a paused balance
`BTRFSBalance`
`btrfs_balance_status(String path)`
show the status of a running or paused balance
`void`
`btrfs_device_add(String[] devices, String fs)`
add devices to a btrfs filesystem
`void`
`btrfs_device_delete(String[] devices, String fs)`
remove devices from a btrfs filesystem
`void`
`btrfs_filesystem_balance(String fs)`
balance a btrfs filesystem
`void`
`btrfs_filesystem_defragment(String path)`
`void`
`btrfs_filesystem_defragment(String path, Map<String,Object> optargs)`
defragment a file or directory
`void`
`btrfs_filesystem_resize(String mountpoint)`
`void`
`btrfs_filesystem_resize(String mountpoint, Map<String,Object> optargs)`
resize a btrfs filesystem
`String[]`
`btrfs_filesystem_show(String device)`
list devices for btrfs filesystem
`void`
`btrfs_filesystem_sync(String fs)`
sync a btrfs filesystem
`void`
`btrfs_fsck(String device)`
`void`
`btrfs_fsck(String device, Map<String,Object> optargs)`
Deprecated.
In new code, use `btrfs_scrub_full(String, Map)` instead
`void`
`btrfs_image(String[] source, String image)`
`void`
`btrfs_image(String[] source, String image, Map<String,Object> optargs)`
create an image of a btrfs filesystem
`void`
`btrfs_qgroup_assign(String src, String dst, String path)`
add a qgroup to a parent qgroup
`void`
`btrfs_qgroup_create(String qgroupid, String subvolume)`
create a subvolume quota group
`void`
`btrfs_qgroup_destroy(String qgroupid, String subvolume)`
destroy a subvolume quota group
`void`
`btrfs_qgroup_limit(String subvolume, long size)`
limit the size of a subvolume
`void`
`btrfs_qgroup_remove(String src, String dst, String path)`
remove a qgroup from its parent qgroup
`BTRFSQgroup[]`
`btrfs_qgroup_show(String path)`
show subvolume quota groups
`void`
`btrfs_quota_enable(String fs, boolean enable)`
enable or disable subvolume quota support
`void`
`btrfs_quota_rescan(String fs)`
trash all qgroup numbers and scan the metadata again with the current config
`void`
`btrfs_replace(String srcdev, String targetdev, String mntpoint)`
replace a btrfs managed device with another device
`void`
`btrfs_rescue_chunk_recover(String device)`
recover the chunk tree of btrfs filesystem
`void`
`btrfs_rescue_super_recover(String device)`
recover bad superblocks from good copies
`void`
`btrfs_scrub_cancel(String path)`
cancel a running scrub
`void`
`btrfs_scrub_full(String path)`
`void`
`btrfs_scrub_full(String path, Map<String,Object> optargs)`
run a full scrub on a btrfs filesystem
`void`
`btrfs_scrub_resume(String path)`
resume a previously canceled or interrupted scrub
`void`
`btrfs_scrub_start(String path)`
read all data from all disks and verify checksums
`BTRFSScrub`
`btrfs_scrub_status(String path)`
show status of running or finished scrub
`void`
`btrfs_set_seeding(String device, boolean seeding)`
enable or disable the seeding feature of device
`void`
`btrfs_subvolume_create(String dest)`
`void`
`btrfs_subvolume_create(String dest, Map<String,Object> optargs)`
create a btrfs subvolume
`void`
`btrfs_subvolume_create_opts(String dest)`
`void`
`btrfs_subvolume_create_opts(String dest, Map<String,Object> optargs)`
`void`
`btrfs_subvolume_delete(String subvolume)`
delete a btrfs subvolume or snapshot
`long`
`btrfs_subvolume_get_default(String fs)`
get the default subvolume or snapshot of a filesystem
`BTRFSSubvolume[]`
`btrfs_subvolume_list(String fs)`
list btrfs snapshots and subvolumes
`void`
`btrfs_subvolume_set_default(long id, String fs)`
set default btrfs subvolume
`Map<String,String>`
`btrfs_subvolume_show(String subvolume)`
return detailed information of the subvolume
`void`
`btrfs_subvolume_snapshot(String source, String dest)`
`void`
`btrfs_subvolume_snapshot(String source, String dest, Map<String,Object> optargs)`
create a btrfs snapshot
`void`
`btrfs_subvolume_snapshot_opts(String source, String dest)`
`void`
`btrfs_subvolume_snapshot_opts(String source, String dest, Map<String,Object> optargs)`
`void`
`btrfstune_enable_extended_inode_refs(String device)`
enable extended inode refs
`void`
`btrfstune_enable_skinny_metadata_extent_refs(String device)`
enable skinny metadata extent refs
`void`
`btrfstune_seeding(String device, boolean seeding)`
enable or disable seeding of a btrfs device
`long`
`c_pointer()`
return the C pointer to the guestfs_h handle
`String`
`canonical_device_name(String device)`
return canonical device name
`String`
`cap_get_file(String path)`
get the Linux capabilities attached to a file
`void`
`cap_set_file(String path, String cap)`
set the Linux capabilities attached to a file
`String`
`case_sensitive_path(String path)`
return true path on case-insensitive filesystem
`String`
`cat(String path)`
list the contents of a file
`String`
`checksum(String csumtype, String path)`
compute MD5, SHAx or CRC checksum of file
`String`
`checksum_device(String csumtype, String device)`
compute MD5, SHAx or CRC checksum of the contents of a device
`void`
`checksums_out(String csumtype, String directory, String sumsfile)`
compute MD5, SHAx or CRC checksum of files in a directory
`void`
`chmod(int mode, String path)`
change file mode
`void`
`chown(int owner, int group, String path)`
change file owner and group
`int`
`clear_backend_setting(String name)`
remove a single per-backend settings string
`void`
`clevis_luks_unlock(String device, String mapname)`
open an encrypted LUKS block device with Clevis and Tang
`void`
`close()`
Close a libguestfs handle.
`String`
`command(String[] arguments)`
run a command from the guest filesystem
`String[]`
`command_lines(String[] arguments)`
run a command, returning lines
`void`
`command_out(String[] arguments, String output)`
run a command from the guest filesystem
`void`
`compress_device_out(String ctype, String device, String zdevice)`
`void`
`compress_device_out(String ctype, String device, String zdevice, Map<String,Object> optargs)`
output compressed device
`void`
`compress_out(String ctype, String file, String zfile)`
`void`
`compress_out(String ctype, String file, String zfile, Map<String,Object> optargs)`
output compressed file
`void`
`config(String hvparam, String hvvalue)`
add hypervisor parameters
`void`
`copy_attributes(String src, String dest)`
`void`
`copy_attributes(String src, String dest, Map<String,Object> optargs)`
copy the attributes of a path (file/directory) to another
`void`
`copy_device_to_device(String src, String dest)`
`void`
`copy_device_to_device(String src, String dest, Map<String,Object> optargs)`
copy from source device to destination device
`void`
`copy_device_to_file(String src, String dest)`
`void`
`copy_device_to_file(String src, String dest, Map<String,Object> optargs)`
copy from source device to destination file
`void`
`copy_file_to_device(String src, String dest)`
`void`
`copy_file_to_device(String src, String dest, Map<String,Object> optargs)`
copy from source file to destination device
`void`
`copy_file_to_file(String src, String dest)`
`void`
`copy_file_to_file(String src, String dest, Map<String,Object> optargs)`
copy from source file to destination file
`void`
`copy_in(String localpath, String remotedir)`
copy local files or directories into an image
`void`
`copy_out(String remotepath, String localdir)`
copy remote files or directories out of an image
`void`
`copy_size(String src, String dest, long size)`
Deprecated.
In new code, use `copy_device_to_device(String, String, Map)` instead
`void`
`cp(String src, String dest)`
copy a file
`void`
`cp_a(String src, String dest)`
copy a file or directory recursively
`void`
`cp_r(String src, String dest)`
copy a file or directory recursively
`void`
`cpio_out(String directory, String cpiofile)`
`void`
`cpio_out(String directory, String cpiofile, Map<String,Object> optargs)`
pack directory into cpio file
`void`
`cryptsetup_close(String device)`
close an encrypted device
`void`
`cryptsetup_open(String device, String key, String mapname)`
`void`
`cryptsetup_open(String device, String key, String mapname, Map<String,Object> optargs)`
open an encrypted block device
`void`
`dd(String src, String dest)`
Deprecated.
In new code, use `copy_device_to_device(String, String, Map)` instead
`String`
`debug(String subcmd, String[] extraargs)`
`String[]`
`debug_drives()`
`void`
`debug_upload(String filename, String tmpname, int mode)`
`void`
`delete_event_callback(int eh)`
Delete an event handler.
`int`
`device_index(String device)`
convert device to index
`String`
`device_name(int index)`
convert device index to name
`String`
`df()`
report file system disk space usage
`String`
`df_h()`
report file system disk space usage (human readable)
`void`
`disk_create(String filename, String format, long size)`
`void`
`disk_create(String filename, String format, long size, Map<String,Object> optargs)`
create a blank disk image
`String`
`disk_format(String filename)`
detect the disk format of a disk image
`boolean`
`disk_has_backing_file(String filename)`
return whether disk has a backing file
`long`
`disk_virtual_size(String filename)`
return virtual size of a disk
`String`
`dmesg()`
return kernel messages
`void`
`download(String remotefilename, String filename)`
download a file to the local machine
`void`
`download_blocks(String device, long start, long stop, String filename)`
`void`
`download_blocks(String device, long start, long stop, String filename, Map<String,Object> optargs)`
download the given data units from the disk
`void`
`download_inode(String device, long inode, String filename)`
download a file to the local machine given its inode
`void`
`download_offset(String remotefilename, String filename, long offset, long size)`
download a file to the local machine with offset and size
`void`
`drop_caches(int whattodrop)`
drop kernel page cache, dentries and inodes
`long`
`du(String path)`
estimate file space usage
`void`
`e2fsck(String device)`
`void`
`e2fsck(String device, Map<String,Object> optargs)`
check an ext2/ext3 filesystem
`void`
`e2fsck_f(String device)`
Deprecated.
In new code, use `e2fsck(String, Map)` instead
`String`
`echo_daemon(String[] words)`
echo arguments back to the client
`String[]`
`egrep(String regex, String path)`
Deprecated.
In new code, use `grep(String, String, Map)` instead
`String[]`
`egrepi(String regex, String path)`
Deprecated.
In new code, use `grep(String, String, Map)` instead
`boolean`
`equal(String file1, String file2)`
test if two files have equal contents
`static String`
`eventToString(long events)`
Utility function to turn an event number or bitmask into a string.
`boolean`
`exists(String path)`
test if file or directory exists
`void`
`extlinux(String directory)`
install the SYSLINUX bootloader on an ext2/3/4 or btrfs filesystem
`void`
`f2fs_expand(String device)`
expand a f2fs filesystem
`void`
`fallocate(String path, int len)`
Deprecated.
In new code, use `fallocate64(String, long)` instead
`void`
`fallocate64(String path, long len)`
preallocate a file in the guest filesystem
`boolean`
`feature_available(String[] groups)`
test availability of some parts of the API
`String[]`
`fgrep(String pattern, String path)`
Deprecated.
In new code, use `grep(String, String, Map)` instead
`String[]`
`fgrepi(String pattern, String path)`
Deprecated.
In new code, use `grep(String, String, Map)` instead
`String`
`file(String path)`
determine file type
`String`
`file_architecture(String filename)`
detect the architecture of a binary file
`long`
`filesize(String file)`
return the size of the file in bytes
`boolean`
`filesystem_available(String filesystem)`
check if filesystem is available
`TSKDirent[]`
`filesystem_walk(String device)`
walk through the filesystem content
`void`
`fill(int c, int len, String path)`
fill a file with octets
`void`
`fill_dir(String dir, int nr)`
fill a directory with empty files
`void`
`fill_pattern(String pattern, int len, String path)`
fill a file with a repeating pattern of bytes
`void`
`finalize()`
`String[]`
`find(String directory)`
find all files and directories
`TSKDirent[]`
`find_inode(String device, long inode)`
search the entries associated to the given inode
`void`
`find0(String directory, String files)`
find all files and directories, returning NUL-separated list
`String`
`findfs_label(String label)`
find a filesystem by label
`String`
`findfs_partlabel(String label)`
find a partition by label
`String`
`findfs_partuuid(String uuid)`
find a partition by UUID
`String`
`findfs_uuid(String uuid)`
find a filesystem by UUID
`int`
`fsck(String fstype, String device)`
run the filesystem checker
`void`
`fstrim(String mountpoint)`
`void`
`fstrim(String mountpoint, Map<String,Object> optargs)`
trim free space in a filesystem
`String`
`get_append()`
get the additional kernel options
`String`
`get_attach_method()`
Deprecated.
In new code, use `get_backend()` instead
`boolean`
`get_autosync()`
get autosync mode
`String`
`get_backend()`
get the backend
`String`
`get_backend_setting(String name)`
get a single per-backend settings string
`String[]`
`get_backend_settings()`
get per-backend settings
`String`
`get_cachedir()`
get the appliance cache directory
`boolean`
`get_direct()`
Deprecated.
This is replaced by method #internal_get_console_socket which is not exported by the Java bindings
`String`
`get_e2attrs(String file)`
get ext2 file attributes of a file
`long`
`get_e2generation(String file)`
get ext2 file generation of a file
`String`
`get_e2label(String device)`
Deprecated.
In new code, use `vfs_label(String)` instead
`String`
`get_e2uuid(String device)`
Deprecated.
In new code, use `vfs_uuid(String)` instead
`String`
`get_hv()`
get the hypervisor binary
`String`
`get_identifier()`
get the handle identifier
`String`
`get_libvirt_requested_credential_challenge(int index)`
challenge of i'th requested credential
`String`
`get_libvirt_requested_credential_defresult(int index)`
default result of i'th requested credential
`String`
`get_libvirt_requested_credential_prompt(int index)`
prompt of i'th requested credential
`String[]`
`get_libvirt_requested_credentials()`
get list of credentials requested by libvirt
`int`
`get_memsize()`
get memory allocated to the hypervisor
`boolean`
`get_network()`
get enable network flag
`String`
`get_path()`
get the search path
`boolean`
`get_pgroup()`
get process group flag
`int`
`get_pid()`
get PID of hypervisor
`String`
`get_program()`
get the program name
`String`
`get_qemu()`
Deprecated.
In new code, use `get_hv()` instead
`boolean`
`get_recovery_proc()`
get recovery process enabled flag
`boolean`
`get_selinux()`
Deprecated.
In new code, use `selinux_relabel(String, String, Map)` instead
`int`
`get_smp()`
get number of virtual CPUs in appliance
`String`
`get_sockdir()`
get the temporary directory for sockets and PID files
`int`
`get_state()`
get the current state
`String`
`get_tmpdir()`
get the temporary directory
`boolean`
`get_trace()`
get command trace enabled flag
`int`
`get_umask()`
get the current umask
`boolean`
`get_verbose()`
get verbose mode
`String`
`getcon()`
Deprecated.
In new code, use `selinux_relabel(String, String, Map)` instead
`String`
`getxattr(String path, String name)`
get a single extended attribute
`XAttr[]`
`getxattrs(String path)`
list extended attributes of a file or directory
`String[]`
`glob_expand(String pattern)`
`String[]`
`glob_expand(String pattern, Map<String,Object> optargs)`
expand a wildcard path
`String[]`
`glob_expand_opts(String pattern)`
`String[]`
`glob_expand_opts(String pattern, Map<String,Object> optargs)`
`String[]`
`grep(String regex, String path)`
`String[]`
`grep(String regex, String path, Map<String,Object> optargs)`
return lines matching a pattern
`String[]`
`grep_opts(String regex, String path)`
`String[]`
`grep_opts(String regex, String path, Map<String,Object> optargs)`
`String[]`
`grepi(String regex, String path)`
Deprecated.
In new code, use `grep(String, String, Map)` instead
`void`
`grub_install(String root, String device)`
install GRUB 1
`String[]`
`head(String path)`
return first 10 lines of a file
`String[]`
`head_n(int nrlines, String path)`
return first N lines of a file
`String`
`hexdump(String path)`
dump a file in hexadecimal
`void`
`hivex_close()`
close the current hivex handle
`void`
`hivex_commit(String filename)`
commit (write) changes back to the hive
`long`
`hivex_node_add_child(long parent, String name)`
add a child node
`HivexNode[]`
`hivex_node_children(long nodeh)`
return list of nodes which are subkeys of node
`void`
`hivex_node_delete_child(long nodeh)`
delete a node (recursively)
`long`
`hivex_node_get_child(long nodeh, String name)`
return the named child of node
`long`
`hivex_node_get_value(long nodeh, String key)`
return the named value
`String`
`hivex_node_name(long nodeh)`
return the name of the node
`long`
`hivex_node_parent(long nodeh)`
return the parent of node
`void`
`hivex_node_set_value(long nodeh, String key, long t, byte[] val)`
set or replace a single value in a node
`HivexValue[]`
`hivex_node_values(long nodeh)`
return list of values attached to node
`void`
`hivex_open(String filename)`
`void`
`hivex_open(String filename, Map<String,Object> optargs)`
open a Windows Registry hive file
`long`
`hivex_root()`
return the root node of the hive
`String`
`hivex_value_key(long valueh)`
return the key field from the (key, datatype, data) tuple
`String`
`hivex_value_string(long valueh)`
return the data field as a UTF-8 string
`long`
`hivex_value_type(long valueh)`
return the data type from the (key, datatype, data) tuple
`String`
`hivex_value_utf8(long valueh)`
Deprecated.
In new code, use `hivex_value_string(long)` instead
`String`
`hivex_value_value(long valueh)`
return the data field from the (key, datatype, data) tuple
`String`
`initrd_cat(String initrdpath, String filename)`
list the contents of a single file in an initrd
`String[]`
`initrd_list(String path)`
list files in an initrd
`long`
`inotify_add_watch(String path, int mask)`
add an inotify watch
`void`
`inotify_close()`
close the inotify handle
`String[]`
`inotify_files()`
return list of watched files that had events
`void`
`inotify_init(int maxevents)`
create an inotify handle
`INotifyEvent[]`
`inotify_read()`
return list of inotify events
`void`
`inotify_rm_watch(int wd)`
remove an inotify watch
`String`
`inspect_get_arch(String root)`
get architecture of inspected operating system
`String`
`inspect_get_build_id(String root)`
get the system build ID
`String`
`inspect_get_distro(String root)`
get distro of inspected operating system
`Map<String,String>`
`inspect_get_drive_mappings(String root)`
get drive letter mappings
`String[]`
`inspect_get_filesystems(String root)`
get filesystems associated with inspected operating system
`String`
`inspect_get_format(String root)`
Deprecated.
There is no documented replacement
`String`
`inspect_get_hostname(String root)`
get hostname of the operating system
`String`
`inspect_get_icon(String root)`
`String`
`inspect_get_icon(String root, Map<String,Object> optargs)`
get the icon corresponding to this operating system
`int`
`inspect_get_major_version(String root)`
get major version of inspected operating system
`int`
`inspect_get_minor_version(String root)`
get minor version of inspected operating system
`Map<String,String>`
`inspect_get_mountpoints(String root)`
get mountpoints of inspected operating system
`String`
`inspect_get_osinfo(String root)`
get a possible osinfo short ID corresponding to this operating system
`String`
`inspect_get_package_format(String root)`
get package format used by the operating system
`String`
`inspect_get_package_management(String root)`
get package management tool used by the operating system
`String`
`inspect_get_product_name(String root)`
get product name of inspected operating system
`String`
`inspect_get_product_variant(String root)`
get product variant of inspected operating system
`String[]`
`inspect_get_roots()`
return list of operating systems found by last inspection
`String`
`inspect_get_type(String root)`
get type of inspected operating system
`String`
`inspect_get_windows_current_control_set(String root)`
get Windows CurrentControlSet of inspected operating system
`boolean`
`inspect_get_windows_group_policy(String root)`
return if Windows guest has group policy
`String`
`inspect_get_windows_software_hive(String root)`
get the path of the Windows software hive
`String`
`inspect_get_windows_system_hive(String root)`
get the path of the Windows system hive
`String`
`inspect_get_windows_systemroot(String root)`
get Windows systemroot of inspected operating system
`boolean`
`inspect_is_live(String root)`
Deprecated.
There is no documented replacement
`boolean`
`inspect_is_multipart(String root)`
Deprecated.
There is no documented replacement
`boolean`
`inspect_is_netinst(String root)`
Deprecated.
There is no documented replacement
`Application[]`
`inspect_list_applications(String root)`
Deprecated.
In new code, use `inspect_list_applications2(String)` instead
`Application2[]`
`inspect_list_applications2(String root)`
get list of applications installed in the operating system
`String[]`
`inspect_os()`
inspect disk and return list of operating systems found
`void`
`internal_exit()`
`void`
`internal_test(String str, String optstr, String[] strlist, boolean b, int integer, long integer64, String filein, String fileout, byte[] bufferin)`
`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)`
`void`
`internal_test_63_optargs()`
`void`
`internal_test_63_optargs(Map<String,Object> optargs)`
`void`
`internal_test_close_output()`
`void`
`internal_test_only_optargs()`
`void`
`internal_test_only_optargs(Map<String,Object> optargs)`
`boolean`
`internal_test_rbool(String val)`
`boolean`
`internal_test_rboolerr()`
`String`
`internal_test_rbufferout(String val)`
`String`
`internal_test_rbufferouterr()`
`String`
`internal_test_rconstoptstring(String val)`
`String`
`internal_test_rconstoptstringerr()`
`String`
`internal_test_rconststring(String val)`
`String`
`internal_test_rconststringerr()`
`Map<String,String>`
`internal_test_rhashtable(String val)`
`Map<String,String>`
`internal_test_rhashtableerr()`
`int`
`internal_test_rint(String val)`
`long`
`internal_test_rint64(String val)`
`long`
`internal_test_rint64err()`
`int`
`internal_test_rinterr()`
`String`
`internal_test_rstring(String val)`
`String`
`internal_test_rstringerr()`
`String[]`
`internal_test_rstringlist(String val)`
`String[]`
`internal_test_rstringlisterr()`
`PV`
`internal_test_rstruct(String val)`
`PV`
`internal_test_rstructerr()`
`PV[]`
`internal_test_rstructlist(String val)`
`PV[]`
`internal_test_rstructlisterr()`
`void`
`internal_test_set_output(String filename)`
`boolean`
`is_blockdev(String path)`
`boolean`
`is_blockdev(String path, Map<String,Object> optargs)`
test if block device
`boolean`
`is_blockdev_opts(String path)`
`boolean`
`is_blockdev_opts(String path, Map<String,Object> optargs)`
`boolean`
`is_busy()`
is busy processing a command
`boolean`
`is_chardev(String path)`
`boolean`
`is_chardev(String path, Map<String,Object> optargs)`
test if character device
`boolean`
`is_chardev_opts(String path)`
`boolean`
`is_chardev_opts(String path, Map<String,Object> optargs)`
`boolean`
`is_config()`
is in configuration state
`boolean`
`is_dir(String path)`
`boolean`
`is_dir(String path, Map<String,Object> optargs)`
test if a directory
`boolean`
`is_dir_opts(String path)`
`boolean`
`is_dir_opts(String path, Map<String,Object> optargs)`
`boolean`
`is_fifo(String path)`
`boolean`
`is_fifo(String path, Map<String,Object> optargs)`
test if FIFO (named pipe)
`boolean`
`is_fifo_opts(String path)`
`boolean`
`is_fifo_opts(String path, Map<String,Object> optargs)`
`boolean`
`is_file(String path)`
`boolean`
`is_file(String path, Map<String,Object> optargs)`
test if a regular file
`boolean`
`is_file_opts(String path)`
`boolean`
`is_file_opts(String path, Map<String,Object> optargs)`
`boolean`
`is_launching()`
is launching subprocess
`boolean`
`is_lv(String mountable)`
test if mountable is a logical volume
`boolean`
`is_ready()`
is ready to accept commands
`boolean`
`is_socket(String path)`
`boolean`
`is_socket(String path, Map<String,Object> optargs)`
test if socket
`boolean`
`is_socket_opts(String path)`
`boolean`
`is_socket_opts(String path, Map<String,Object> optargs)`
`boolean`
`is_symlink(String path)`
test if symbolic link
`boolean`
`is_whole_device(String device)`
test if a device is a whole device
`boolean`
`is_zero(String path)`
test if a file contains all zero bytes
`boolean`
`is_zero_device(String device)`
test if a device contains all zero bytes
`ISOInfo`
`isoinfo(String isofile)`
get ISO information from primary volume descriptor of ISO file
`ISOInfo`
`isoinfo_device(String device)`
get ISO information from primary volume descriptor of device
`void`
`journal_close()`
close the systemd journal
`XAttr[]`
`journal_get()`
read the current journal entry
`long`
`journal_get_data_threshold()`
get the data threshold for reading journal entries
`long`
`journal_get_realtime_usec()`
get the timestamp of the current journal entry
`boolean`
`journal_next()`
move to the next journal entry
`void`
`journal_open(String directory)`
open the systemd journal
`void`
`journal_set_data_threshold(long threshold)`
set the data threshold for reading journal entries
`long`
`journal_skip(long skip)`
skip forwards or backwards in the journal
`void`
`kill_subprocess()`
Deprecated.
In new code, use `shutdown()` instead
`void`
`launch()`
launch the backend
`void`
`lchown(int owner, int group, String path)`
change file owner and group
`void`
`ldmtool_create_all()`
scan and create Windows dynamic disk volumes
`String[]`
`ldmtool_diskgroup_disks(String diskgroup)`
return the disks in a Windows dynamic disk group
`String`
`ldmtool_diskgroup_name(String diskgroup)`
return the name of a Windows dynamic disk group
`String[]`
`ldmtool_diskgroup_volumes(String diskgroup)`
return the volumes in a Windows dynamic disk group
`void`
`ldmtool_remove_all()`
remove all Windows dynamic disk volumes
`String[]`
`ldmtool_scan()`
scan for Windows dynamic disks
`String[]`
`ldmtool_scan_devices(String[] devices)`
scan for Windows dynamic disks
`String`
`ldmtool_volume_hint(String diskgroup, String volume)`
return the hint field of a Windows dynamic disk volume
`String[]`
`ldmtool_volume_partitions(String diskgroup, String volume)`
return the partitions in a Windows dynamic disk volume
`String`
`ldmtool_volume_type(String diskgroup, String volume)`
return the type of a Windows dynamic disk volume
`String`
`lgetxattr(String path, String name)`
get a single extended attribute
`XAttr[]`
`lgetxattrs(String path)`
list extended attributes of a file or directory
`String[]`
`list_9p()`
Deprecated.
There is no documented replacement
`String[]`
`list_devices()`
list the block devices
`Map<String,String>`
`list_disk_labels()`
mapping of disk labels to devices
`String[]`
`list_dm_devices()`
list device mapper devices
`Map<String,String>`
`list_filesystems()`
list filesystems
`String[]`
`list_ldm_partitions()`
list all Windows dynamic disk partitions
`String[]`
`list_ldm_volumes()`
list all Windows dynamic disk volumes
`String[]`
`list_md_devices()`
list Linux md (RAID) devices
`String[]`
`list_partitions()`
list the partitions
`String`
`ll(String directory)`
list the files in a directory (long format)
`String`
`llz(String directory)`
Deprecated.
In new code, use `lgetxattrs(String)` instead
`void`
`ln(String target, String linkname)`
create a hard link
`void`
`ln_f(String target, String linkname)`
create a hard link
`void`
`ln_s(String target, String linkname)`
create a symbolic link
`void`
`ln_sf(String target, String linkname)`
create a symbolic link
`void`
`lremovexattr(String xattr, String path)`
remove extended attribute of a file or directory
`String[]`
`ls(String directory)`
list the files in a directory
`void`
`ls0(String dir, String filenames)`
get list of files in a directory
`void`
`lsetxattr(String xattr, String val, int vallen, String path)`
set extended attribute of a file or directory
`Stat`
`lstat(String path)`
Deprecated.
In new code, use `lstatns(String)` instead
`Stat[]`
`lstatlist(String path, String[] names)`
Deprecated.
In new code, use `lstatnslist(String, String[])` instead
`StatNS`
`lstatns(String path)`
get file information for a symbolic link
`StatNS[]`
`lstatnslist(String path, String[] names)`
lstat on multiple files
`void`
`luks_add_key(String device, String key, String newkey, int keyslot)`
add a key on a LUKS encrypted device
`void`
`luks_close(String device)`
Deprecated.
In new code, use `cryptsetup_close(String)` instead
`void`
`luks_format(String device, String key, int keyslot)`
format a block device as a LUKS encrypted device
`void`
`luks_format_cipher(String device, String key, int keyslot, String cipher)`
format a block device as a LUKS encrypted device
`void`
`luks_kill_slot(String device, String key, int keyslot)`
remove a key from a LUKS encrypted device
`void`
`luks_open(String device, String key, String mapname)`
Deprecated.
In new code, use `cryptsetup_open(String, String, String, Map)` instead
`void`
`luks_open_ro(String device, String key, String mapname)`
Deprecated.
In new code, use `cryptsetup_open(String, String, String, Map)` instead
`String`
`luks_uuid(String device)`
get the UUID of a LUKS device
`void`
`lvcreate(String logvol, String volgroup, int mbytes)`
create an LVM logical volume
`void`
`lvcreate_free(String logvol, String volgroup, int percent)`
create an LVM logical volume in % remaining free space
`String`
`lvm_canonical_lv_name(String lvname)`
get canonical name of an LV
`void`
`lvm_clear_filter()`
clear LVM device filter
`void`
`lvm_remove_all()`
remove all LVM LVs, VGs and PVs
`void`
`lvm_scan(boolean activate)`
scan for LVM physical volumes, volume groups and logical volumes
`void`
`lvm_set_filter(String[] devices)`
set LVM device filter
`void`
`lvremove(String device)`
remove an LVM logical volume
`void`
`lvrename(String logvol, String newlogvol)`
rename an LVM logical volume
`void`
`lvresize(String device, int mbytes)`
resize an LVM logical volume
`void`
`lvresize_free(String lv, int percent)`
expand an LV to fill free space
`String[]`
`lvs()`
list the LVM logical volumes (LVs)
`LV[]`
`lvs_full()`
list the LVM logical volumes (LVs)
`String`
`lvuuid(String device)`
get the UUID of a logical volume
`XAttr[]`
`lxattrlist(String path, String[] names)`
lgetxattr on multiple files
`int`
`max_disks()`
maximum number of disks that may be added
`void`
`md_create(String name, String[] devices)`
`void`
`md_create(String name, String[] devices, Map<String,Object> optargs)`
create a Linux md (RAID) device
`Map<String,String>`
`md_detail(String md)`
obtain metadata for an MD device
`MDStat[]`
`md_stat(String md)`
get underlying devices from an MD device
`void`
`md_stop(String md)`
stop a Linux md (RAID) device
`void`
`mkdir(String path)`
create a directory
`void`
`mkdir_mode(String path, int mode)`
create a directory with a particular mode
`void`
`mkdir_p(String path)`
create a directory and parents
`String`
`mkdtemp(String tmpl)`
create a temporary directory
`void`
`mke2fs(String device)`
`void`
`mke2fs(String device, Map<String,Object> optargs)`
create an ext2/ext3/ext4 filesystem on device
`void`
`mke2fs_J(String fstype, int blocksize, String device, String journal)`
Deprecated.
In new code, use `mke2fs(String, Map)` instead
`void`
`mke2fs_JL(String fstype, int blocksize, String device, String label)`
Deprecated.
In new code, use `mke2fs(String, Map)` instead
`void`
`mke2fs_JU(String fstype, int blocksize, String device, String uuid)`
Deprecated.
In new code, use `mke2fs(String, Map)` instead
`void`
`mke2journal(int blocksize, String device)`
Deprecated.
In new code, use `mke2fs(String, Map)` instead
`void`
`mke2journal_L(int blocksize, String label, String device)`
Deprecated.
In new code, use `mke2fs(String, Map)` instead
`void`
`mke2journal_U(int blocksize, String uuid, String device)`
Deprecated.
In new code, use `mke2fs(String, Map)` instead
`void`
`mkfifo(int mode, String path)`
make FIFO (named pipe)
`void`
`mkfs(String fstype, String device)`
`void`
`mkfs(String fstype, String device, Map<String,Object> optargs)`
make a filesystem
`void`
`mkfs_b(String fstype, int blocksize, String device)`
Deprecated.
In new code, use `mkfs(String, String, Map)` instead
`void`
`mkfs_btrfs(String[] devices)`
`void`
`mkfs_btrfs(String[] devices, Map<String,Object> optargs)`
create a btrfs filesystem
`void`
`mkfs_opts(String fstype, String device)`
`void`
`mkfs_opts(String fstype, String device, Map<String,Object> optargs)`
`void`
`mklost_and_found(String mountpoint)`
make lost+found directory on an ext2/3/4 filesystem
`void`
`mkmountpoint(String exemptpath)`
create a mountpoint
`void`
`mknod(int mode, int devmajor, int devminor, String path)`
make block, character or FIFO devices
`void`
`mknod_b(int mode, int devmajor, int devminor, String path)`
make block device node
`void`
`mknod_c(int mode, int devmajor, int devminor, String path)`
make char device node
`void`
`mksquashfs(String path, String filename)`
`void`
`mksquashfs(String path, String filename, Map<String,Object> optargs)`
create a squashfs filesystem
`void`
`mkswap(String device)`
`void`
`mkswap(String device, Map<String,Object> optargs)`
create a swap partition
`void`
`mkswap_file(String path)`
create a swap file
`void`
`mkswap_L(String label, String device)`
Deprecated.
In new code, use `mkswap(String, Map)` instead
`void`
`mkswap_opts(String device)`
`void`
`mkswap_opts(String device, Map<String,Object> optargs)`
`void`
`mkswap_U(String uuid, String device)`
Deprecated.
In new code, use `mkswap(String, Map)` instead
`String`
`mktemp(String tmpl)`
`String`
`mktemp(String tmpl, Map<String,Object> optargs)`
create a temporary file
`void`
`modprobe(String modulename)`
load a kernel module
`void`
`mount(String mountable, String mountpoint)`
mount a guest disk at a position in the filesystem
`void`
`mount_9p(String mounttag, String mountpoint)`
`void`
`mount_9p(String mounttag, String mountpoint, Map<String,Object> optargs)`
Deprecated.
There is no documented replacement
`void`
`mount_local(String localmountpoint)`
`void`
`mount_local(String localmountpoint, Map<String,Object> optargs)`
mount on the local filesystem
`void`
`mount_local_run()`
run main loop of mount on the local filesystem
`void`
`mount_loop(String file, String mountpoint)`
mount a file using the loop device
`void`
`mount_options(String options, String mountable, String mountpoint)`
mount a guest disk with mount options
`void`
`mount_ro(String mountable, String mountpoint)`
mount a guest disk, read-only
`void`
`mount_vfs(String options, String vfstype, String mountable, String mountpoint)`
mount a guest disk with mount options and vfstype
`String`
`mountable_device(String mountable)`
extract the device part of a mountable
`String`
`mountable_subvolume(String mountable)`
extract the subvolume part of a mountable
`Map<String,String>`
`mountpoints()`
show mountpoints
`String[]`
`mounts()`
show mounted filesystems
`void`
`mv(String src, String dest)`
move a file
`int`
`nr_devices()`
return number of whole block devices (disks) added
`int`
`ntfs_3g_probe(boolean rw, String device)`
probe NTFS volume
`void`
`ntfs_chmod(String device, int mode, String path)`
`void`
`ntfs_chmod(String device, int mode, String path, Map<String,Object> optargs)`
change file permissions on NTFS filesystem
`void`
`ntfscat_i(String device, long inode, String filename)`
download a file to the local machine given its inode
`void`
`ntfsclone_in(String backupfile, String device)`
restore NTFS from backup file
`void`
`ntfsclone_out(String device, String backupfile)`
`void`
`ntfsclone_out(String device, String backupfile, Map<String,Object> optargs)`
save NTFS to backup file
`void`
`ntfsfix(String device)`
`void`
`ntfsfix(String device, Map<String,Object> optargs)`
fix common errors and force Windows to check NTFS
`void`
`ntfsresize(String device)`
`void`
`ntfsresize(String device, Map<String,Object> optargs)`
resize an NTFS filesystem
`void`
`ntfsresize_opts(String device)`
`void`
`ntfsresize_opts(String device, Map<String,Object> optargs)`
`void`
`ntfsresize_size(String device, long size)`
Deprecated.
In new code, use `ntfsresize(String, Map)` instead
`void`
`parse_environment()`
parse the environment and set handle flags accordingly
`void`
`parse_environment_list(String[] environment)`
parse the environment and set handle flags accordingly
`void`
`part_add(String device, String prlogex, long startsect, long endsect)`
add a partition to the device
`void`
`part_del(String device, int partnum)`
delete a partition
`void`
`part_disk(String device, String parttype)`
partition whole disk with a single primary partition
`void`
`part_expand_gpt(String device)`
move backup GPT header to the end of the disk
`boolean`
`part_get_bootable(String device, int partnum)`
return true if a partition is bootable
`String`
`part_get_disk_guid(String device)`
get the GUID of a GPT-partitioned disk
`long`
`part_get_gpt_attributes(String device, int partnum)`
get the attribute flags of a GPT partition
`String`
`part_get_gpt_guid(String device, int partnum)`
get the GUID of a GPT partition
`String`
`part_get_gpt_type(String device, int partnum)`
get the type GUID of a GPT partition
`int`
`part_get_mbr_id(String device, int partnum)`
get the MBR type byte (ID byte) from a partition
`String`
`part_get_mbr_part_type(String device, int partnum)`
get the MBR partition type
`String`
`part_get_name(String device, int partnum)`
get partition name
`String`
`part_get_parttype(String device)`
get the partition table type
`void`
`part_init(String device, String parttype)`
create an empty partition table
`Partition[]`
`part_list(String device)`
list partitions on a device
`void`
`part_resize(String device, int partnum, long endsect)`
resize a partition
`void`
`part_set_bootable(String device, int partnum, boolean bootable)`
make a partition bootable
`void`
`part_set_disk_guid(String device, String guid)`
set the GUID of a GPT-partitioned disk
`void`
`part_set_disk_guid_random(String device)`
set the GUID of a GPT-partitioned disk to random value
`void`
`part_set_gpt_attributes(String device, int partnum, long attributes)`
set the attribute flags of a GPT partition
`void`
`part_set_gpt_guid(String device, int partnum, String guid)`
set the GUID of a GPT partition
`void`
`part_set_gpt_type(String device, int partnum, String guid)`
set the type GUID of a GPT partition
`void`
`part_set_mbr_id(String device, int partnum, int idbyte)`
set the MBR type byte (ID byte) of a partition
`void`
`part_set_name(String device, int partnum, String name)`
set partition name
`String`
`part_to_dev(String partition)`
convert partition name to device name
`int`
`part_to_partnum(String partition)`
convert partition name to partition number
`void`
`ping_daemon()`
ping the guest daemon
`String`
`pread(String path, int count, long offset)`
read part of a file
`String`
`pread_device(String device, int count, long offset)`
read part of a device
`void`
`pvchange_uuid(String device)`
generate a new random UUID for a physical volume
`void`
`pvchange_uuid_all()`
generate new random UUIDs for all physical volumes
`void`
`pvcreate(String device)`
create an LVM physical volume
`void`
`pvremove(String device)`
remove an LVM physical volume
`void`
`pvresize(String device)`
resize an LVM physical volume
`void`
`pvresize_size(String device, long size)`
resize an LVM physical volume (with size)
`String[]`
`pvs()`
list the LVM physical volumes (PVs)
`PV[]`
`pvs_full()`
list the LVM physical volumes (PVs)
`String`
`pvuuid(String device)`
get the UUID of a physical volume
`int`
`pwrite(String path, byte[] content, long offset)`
write to part of a file
`int`
`pwrite_device(String device, byte[] content, long offset)`
write to part of a device
`String`
`read_file(String path)`
read a file
`String[]`
`read_lines(String path)`
read file as lines
`Dirent[]`
`readdir(String dir)`
read directories entries
`String`
`readlink(String path)`
read the target of a symbolic link
`String[]`
`readlinklist(String path, String[] names)`
readlink on multiple files
`String`
`realpath(String path)`
canonicalized absolute pathname
`void`
`remount(String mountpoint)`
`void`
`remount(String mountpoint, Map<String,Object> optargs)`
remount a filesystem with different options
`void`
`remove_drive(String label)`
Deprecated.
There is no documented replacement
`void`
`removexattr(String xattr, String path)`
remove extended attribute of a file or directory
`void`
`rename(String oldpath, String newpath)`
rename a file on the same filesystem
`void`
`resize2fs(String device)`
resize an ext2, ext3 or ext4 filesystem
`void`
`resize2fs_M(String device)`
resize an ext2, ext3 or ext4 filesystem to the minimum size
`void`
`resize2fs_size(String device, long size)`
resize an ext2, ext3 or ext4 filesystem (with size)
`void`
`rm(String path)`
remove a file
`void`
`rm_f(String path)`
remove a file ignoring errors
`void`
`rm_rf(String path)`
remove a file or directory recursively
`void`
`rmdir(String path)`
remove a directory
`void`
`rmmountpoint(String exemptpath)`
remove a mountpoint
`void`
`rsync(String src, String dest)`
`void`
`rsync(String src, String dest, Map<String,Object> optargs)`
synchronize the contents of two directories
`void`
`rsync_in(String remote, String dest)`
`void`
`rsync_in(String remote, String dest, Map<String,Object> optargs)`
synchronize host or remote filesystem with filesystem
`void`
`rsync_out(String src, String remote)`
`void`
`rsync_out(String src, String remote, Map<String,Object> optargs)`
synchronize filesystem with host or remote filesystem
`void`
`scrub_device(String device)`
scrub (securely wipe) a device
`void`
`scrub_file(String file)`
scrub (securely wipe) a file
`void`
`scrub_freespace(String dir)`
scrub (securely wipe) free space
`void`
`selinux_relabel(String specfile, String path)`
`void`
`selinux_relabel(String specfile, String path, Map<String,Object> optargs)`
Deprecated.
In new code, use `setfiles(String, String[], Map)` instead
`void`
`set_append(String append)`
add options to kernel command line
`void`
`set_attach_method(String backend)`
Deprecated.
In new code, use `set_backend(String)` instead
`void`
`set_autosync(boolean autosync)`
set autosync mode
`void`
`set_backend(String backend)`
set the backend
`void`
`set_backend_setting(String name, String val)`
set a single per-backend settings string
`void`
`set_backend_settings(String[] settings)`
replace per-backend settings strings
`void`
`set_cachedir(String cachedir)`
set the appliance cache directory
`void`
`set_direct(boolean direct)`
Deprecated.
This is replaced by method #internal_get_console_socket which is not exported by the Java bindings
`void`
`set_e2attrs(String file, String attrs)`
`void`
`set_e2attrs(String file, String attrs, Map<String,Object> optargs)`
set ext2 file attributes of a file
`void`
`set_e2generation(String file, long generation)`
set ext2 file generation of a file
`void`
`set_e2label(String device, String label)`
Deprecated.
In new code, use `set_label(String, String)` instead
`void`
`set_e2uuid(String device, String uuid)`
Deprecated.
In new code, use `set_uuid(String, String)` instead
`int`
`set_event_callback(EventCallback callback, long events)`
Set an event handler.
`void`
`set_hv(String hv)`
set the hypervisor binary
`void`
`set_identifier(String identifier)`
set the handle identifier
`void`
`set_label(String mountable, String label)`
set filesystem label
`void`
`set_libvirt_requested_credential(int index, byte[] cred)`
pass requested credential back to libvirt
`void`
`set_libvirt_supported_credentials(String[] creds)`
set libvirt credentials supported by calling program
`void`
`set_memsize(int memsize)`
set memory allocated to the hypervisor
`void`
`set_network(boolean network)`
set enable network flag
`void`
`set_path(String searchpath)`
set the search path
`void`
`set_pgroup(boolean pgroup)`
set process group flag
`void`
`set_program(String program)`
set the program name
`void`
`set_qemu(String hv)`
Deprecated.
In new code, use `set_hv(String)` instead
`void`
`set_recovery_proc(boolean recoveryproc)`
enable or disable the recovery process
`void`
`set_selinux(boolean selinux)`
Deprecated.
In new code, use `selinux_relabel(String, String, Map)` instead
`void`
`set_smp(int smp)`
set number of virtual CPUs in appliance
`void`
`set_tmpdir(String tmpdir)`
set the temporary directory
`void`
`set_trace(boolean trace)`
enable or disable command traces
`void`
`set_uuid(String device, String uuid)`
set the filesystem UUID
`void`
`set_uuid_random(String device)`
set a random UUID for the filesystem
`void`
`set_verbose(boolean verbose)`
set verbose mode
`void`
`setcon(String context)`
Deprecated.
In new code, use `selinux_relabel(String, String, Map)` instead
`void`
`setfiles(String specfile, String[] paths)`
`void`
`setfiles(String specfile, String[] paths, Map<String,Object> optargs)`
low level relabel parts of the filesystem
`void`
`setxattr(String xattr, String val, int vallen, String path)`
set extended attribute of a file or directory
`void`
`sfdisk(String device, int cyls, int heads, int sectors, String[] lines)`
Deprecated.
In new code, use `part_add(String, String, long, long)` instead
`String`
`sfdisk_disk_geometry(String device)`
display the disk geometry from the partition table
`String`
`sfdisk_kernel_geometry(String device)`
display the kernel geometry
`String`
`sfdisk_l(String device)`
Deprecated.
In new code, use `part_list(String)` instead
`void`
`sfdisk_N(String device, int partnum, int cyls, int heads, int sectors, String line)`
Deprecated.
In new code, use `part_add(String, String, long, long)` instead
`void`
`sfdiskM(String device, String[] lines)`
Deprecated.
In new code, use `part_add(String, String, long, long)` instead
`String`
`sh(String command)`
run a command via the shell
`String[]`
`sh_lines(String command)`
run a command via the shell returning lines
`void`
`sh_out(String command, String output)`
run a command via the shell
`void`
`shutdown()`
shutdown the hypervisor
`void`
`sleep(int secs)`
sleep for some seconds
`Stat`
`stat(String path)`
Deprecated.
In new code, use `statns(String)` instead
`StatNS`
`statns(String path)`
get file information
`StatVFS`
`statvfs(String path)`
get file system statistics
`String[]`
`strings(String path)`
print the printable strings in a file
`String[]`
`strings_e(String encoding, String path)`
print the printable strings in a file
`void`
`swapoff_device(String device)`
disable swap on device
`void`
`swapoff_file(String file)`
disable swap on file
`void`
`swapoff_label(String label)`
disable swap on labeled swap partition
`void`
`swapoff_uuid(String uuid)`
disable swap on swap partition by UUID
`void`
`swapon_device(String device)`
enable swap on device
`void`
`swapon_file(String file)`
enable swap on file
`void`
`swapon_label(String label)`
enable swap on labeled swap partition
`void`
`swapon_uuid(String uuid)`
enable swap on swap partition by UUID
`void`
`sync()`
sync disks, writes are flushed through to the disk image
`void`
`syslinux(String device)`
`void`
`syslinux(String device, Map<String,Object> optargs)`
install the SYSLINUX bootloader
`String[]`
`tail(String path)`
return last 10 lines of a file
`String[]`
`tail_n(int nrlines, String path)`
return last N lines of a file
`void`
`tar_in(String tarfile, String directory)`
`void`
`tar_in(String tarfile, String directory, Map<String,Object> optargs)`
unpack tarfile to directory
`void`
`tar_in_opts(String tarfile, String directory)`
`void`
`tar_in_opts(String tarfile, String directory, Map<String,Object> optargs)`
`void`
`tar_out(String directory, String tarfile)`
`void`
`tar_out(String directory, String tarfile, Map<String,Object> optargs)`
pack directory into tarfile
`void`
`tar_out_opts(String directory, String tarfile)`
`void`
`tar_out_opts(String directory, String tarfile, Map<String,Object> optargs)`
`void`
`tgz_in(String tarball, String directory)`
Deprecated.
In new code, use `tar_in(String, String, Map)` instead
`void`
`tgz_out(String directory, String tarball)`
Deprecated.
In new code, use `tar_out(String, String, Map)` instead
`void`
`touch(String path)`
update file timestamps or create a new file
`void`
`truncate(String path)`
truncate a file to zero size
`void`
`truncate_size(String path, long size)`
truncate a file to a particular size
`void`
`tune2fs(String device)`
`void`
`tune2fs(String device, Map<String,Object> optargs)`
adjust ext2/ext3/ext4 filesystem parameters
`Map<String,String>`
`tune2fs_l(String device)`
get ext2/ext3/ext4 superblock details
`void`
`txz_in(String tarball, String directory)`
Deprecated.
In new code, use `tar_in(String, String, Map)` instead
`void`
`txz_out(String directory, String tarball)`
Deprecated.
In new code, use `tar_out(String, String, Map)` instead
`int`
`umask(int mask)`
set file mode creation mask (umask)
`void`
`umount(String pathordevice)`
`void`
`umount(String pathordevice, Map<String,Object> optargs)`
unmount a filesystem
`void`
`umount_all()`
unmount all filesystems
`void`
`umount_local()`
`void`
`umount_local(Map<String,Object> optargs)`
unmount a locally mounted filesystem
`void`
`umount_opts(String pathordevice)`
`void`
`umount_opts(String pathordevice, Map<String,Object> optargs)`
`void`
`upload(String filename, String remotefilename)`
upload a file from the local machine
`void`
`upload_offset(String filename, String remotefilename, long offset)`
upload a file from the local machine with offset
`void`
`user_cancel()`
cancel the current upload or download operation
`void`
`utimens(String path, long atsecs, long atnsecs, long mtsecs, long mtnsecs)`
set timestamp of a file with nanosecond precision
`UTSName`
`utsname()`
appliance kernel version
`Version`
`version()`
get the library version number
`String`
`vfs_label(String mountable)`
get the filesystem label
`long`
`vfs_minimum_size(String mountable)`
get minimum filesystem size
`String`
`vfs_type(String mountable)`
get the Linux VFS type corresponding to a mounted device
`String`
`vfs_uuid(String mountable)`
get the filesystem UUID
`void`
`vg_activate(boolean activate, String[] volgroups)`
activate or deactivate some volume groups
`void`
`vg_activate_all(boolean activate)`
activate or deactivate all volume groups
`void`
`vgchange_uuid(String vg)`
generate a new random UUID for a volume group
`void`
`vgchange_uuid_all()`
generate new random UUIDs for all volume groups
`void`
`vgcreate(String volgroup, String[] physvols)`
create an LVM volume group
`String[]`
`vglvuuids(String vgname)`
get the LV UUIDs of all LVs in the volume group
`String`
`vgmeta(String vgname)`
get volume group metadata
`String[]`
`vgpvuuids(String vgname)`
get the PV UUIDs containing the volume group
`void`
`vgremove(String vgname)`
remove an LVM volume group
`void`
`vgrename(String volgroup, String newvolgroup)`
rename an LVM volume group
`String[]`
`vgs()`
list the LVM volume groups (VGs)
`VG[]`
`vgs_full()`
list the LVM volume groups (VGs)
`void`
`vgscan()`
Deprecated.
In new code, use `lvm_scan(boolean)` instead
`String`
`vguuid(String vgname)`
get the UUID of a volume group
`void`
`wait_ready()`
Deprecated.
There is no documented replacement
`int`
`wc_c(String path)`
count characters in a file
`int`
`wc_l(String path)`
count lines in a file
`int`
`wc_w(String path)`
count words in a file
`void`
`wipefs(String device)`
wipe a filesystem signature from a device
`void`
`write(String path, byte[] content)`
create a new file
`void`
`write_append(String path, byte[] content)`
append content to end of file
`void`
`write_file(String path, String content, int size)`
Deprecated.
In new code, use `write(String, byte[])` instead
`void`
`xfs_admin(String device)`
`void`
`xfs_admin(String device, Map<String,Object> optargs)`
change parameters of an XFS filesystem
`void`
`xfs_growfs(String path)`
`void`
`xfs_growfs(String path, Map<String,Object> optargs)`
expand an existing XFS filesystem
`XFSInfo`
`xfs_info(String pathordevice)`
get geometry of XFS filesystem
`int`
`xfs_repair(String device)`
`int`
`xfs_repair(String device, Map<String,Object> optargs)`
repair an XFS filesystem
`void`
`yara_destroy()`
destroy previously loaded yara rules
`void`
`yara_load(String filename)`
load yara rules within libguestfs
`YaraDetection[]`
`yara_scan(String path)`
scan a file with the loaded yara rules
`String[]`
`zegrep(String regex, String path)`
Deprecated.
In new code, use `grep(String, String, Map)` instead
`String[]`
`zegrepi(String regex, String path)`
Deprecated.
In new code, use `grep(String, String, Map)` instead
`void`
`zero(String device)`
write zeroes to the device
`void`
`zero_device(String device)`
write zeroes to an entire device
`void`
`zero_free_space(String directory)`
zero free space in a filesystem
`void`
`zerofree(String device)`
zero unused inodes and disk blocks on ext2/3 filesystem
`String[]`
`zfgrep(String pattern, String path)`
Deprecated.
In new code, use `grep(String, String, Map)` instead
`String[]`
`zfgrepi(String pattern, String path)`
Deprecated.
In new code, use `grep(String, String, Map)` instead
`String`
`zfile(String meth, String path)`
Deprecated.
In new code, use `file(String)` instead
`String[]`
`zgrep(String regex, String path)`
Deprecated.
In new code, use `grep(String, String, Map)` instead
`String[]`
`zgrepi(String regex, String path)`
Deprecated.
In new code, use `grep(String, String, Map)` instead

### Methods inherited from class Object

`clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

## Field Details

### EVENT_CLOSE

public static final long EVENT_CLOSE
Event 'close'.

See Also:
  - `set_event_callback(EventCallback, long)`
  - Constant Field Values

### EVENT_SUBPROCESS_QUIT

public static final long EVENT_SUBPROCESS_QUIT
Event 'subprocess_quit'.

See Also:
  - `set_event_callback(EventCallback, long)`
  - Constant Field Values

### EVENT_LAUNCH_DONE

public static final long EVENT_LAUNCH_DONE
Event 'launch_done'.

See Also:
  - `set_event_callback(EventCallback, long)`
  - Constant Field Values

### EVENT_PROGRESS

public static final long EVENT_PROGRESS
Event 'progress'.

See Also:
  - `set_event_callback(EventCallback, long)`
  - Constant Field Values

### EVENT_APPLIANCE

public static final long EVENT_APPLIANCE
Event 'appliance'.

See Also:
  - `set_event_callback(EventCallback, long)`
  - Constant Field Values

### EVENT_LIBRARY

public static final long EVENT_LIBRARY
Event 'library'.

See Also:
  - `set_event_callback(EventCallback, long)`
  - Constant Field Values

### EVENT_TRACE

public static final long EVENT_TRACE
Event 'trace'.

See Also:
  - `set_event_callback(EventCallback, long)`
  - Constant Field Values

### EVENT_ENTER

public static final long EVENT_ENTER
Event 'enter'.

See Also:
  - `set_event_callback(EventCallback, long)`
  - Constant Field Values

### EVENT_LIBVIRT_AUTH

public static final long EVENT_LIBVIRT_AUTH
Event 'libvirt_auth'.

See Also:
  - `set_event_callback(EventCallback, long)`
  - Constant Field Values

### EVENT_WARNING

public static final long EVENT_WARNING
Event 'warning'.

See Also:
  - `set_event_callback(EventCallback, long)`
  - Constant Field Values

### EVENT_ALL

public static final long EVENT_ALL
Bitmask of all events.

See Also:
  - Constant Field Values

## Constructor Details

### GuestFS

public GuestFS(Map<String,Object> optargs) throws LibGuestFSException
Create a libguestfs handle, setting flags.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.

### GuestFS

public GuestFS() throws LibGuestFSException
Create a libguestfs handle.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.

## Method Details

### close

public void close() throws LibGuestFSException

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` - If there is a libguestfs error.

### finalize

public void finalize() throws LibGuestFSException

Overrides:
  `finalize` in class `Object`
Throws:
  `LibGuestFSException`

### eventToString

public static String eventToString(long events)
Utility function to turn an event number or bitmask into a string.

Parameters:
  `events` - the event number to convert
Returns:
  text representation of event

### set_event_callback

public int set_event_callback(EventCallback callback, long events) throws LibGuestFSException

Set an event handler.

Set an event handler (`callback`) which is called when any event from the set (`events`) is raised by the API. `events` is one or more `EVENT_*` constants, bitwise ORed together.

When an event happens, the callback object’s `event` method is invoked like this:

    callback.event (event,    // the specific event which fired (long)
                    eh,       // the event handle (int)
                    buffer,   // event data (String)
                    array     // event data (long[])
                    );

Note that you can pass arbitrary data from the main program to the callback by putting it into your `callback object`, then accessing it in the callback via `this`.

This function returns an event handle which may be used to delete the event. Note that event handlers are deleted automatically when the libguestfs handle is closed.

Returns:
  handle for the event
Throws:
  `LibGuestFSException` - If there is a libguestfs error.
See Also:
  - "The section &quot;EVENTS&quot; in the guestfs(3) manual"
  - `delete_event_callback(int)`

### delete_event_callback

public void delete_event_callback(int eh) throws LibGuestFSException

Delete an event handler.

Delete a previously registered event handler. The 'eh' parameter is the event handle returned from a previous call to `set_event_callback`.

Note that event handlers are deleted automatically when the libguestfs handle is closed.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
See Also:
  - `set_event_callback(EventCallback, long)`

### acl_delete_def_file

public void acl_delete_def_file(String dir) throws LibGuestFSException

delete the default POSIX ACL of a directory

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

This function depends on the feature "acl". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.63

### acl_get_file

public String acl_get_file(String path, String acltype) throws LibGuestFSException

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.

This function depends on the feature "acl". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.63

### acl_set_file

public void acl_set_file(String path, String acltype, String acl) throws LibGuestFSException

set the POSIX ACL attached to a file

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

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.

The "acl" parameter is the new ACL in either "long text form" or "short text form" (see acl(5)). The new ACL completely replaces any previous ACL on the file. The ACL must contain the full Unix permissions (eg. "u::rwx,g::rx,o::rx").

If you are specifying individual users or groups, then the mask field is also required (eg. "m::rwx"), followed by the "u:*ID*:..." and/or "g:*ID*:..." field(s). A full ACL string might therefore look like this:

u::rwx,g::rwx,o::rwx,m::rwx,u:500:rwx,g:500:rwx \ Unix permissions / \mask/ \ ACL /

You should use numeric UIDs and GIDs. To map usernames and groupnames to the correct numeric ID in the context of the guest, use the Augeas functions (see "g.aug_init").

This function depends on the feature "acl". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.63

### add_cdrom

@Deprecated public void add_cdrom(String filename) throws LibGuestFSException
Deprecated.
In new code, use `add_drive_ro(String)` instead

add a CD-ROM disk image to examine

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

The image is added as read-only drive, so this function is equivalent of "g.add_drive_ro".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.3

### add_domain

public int add_domain(String dom, Map<String,Object> optargs) throws LibGuestFSException

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 <https://libvirt.org/remote.html>) will fail unless those disks are accessible via the same device path locally too.

The optional "libvirturi" parameter sets the libvirt URI (see <https://libvirt.org/uri.html>). 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 is ignored in libguestfs ≥ 1.48.

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 <readonly/> 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 <readonly/> flag is found.

If "readonly" is true:

Disks with the <readonly/> flag are added read-only.

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

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

If "readonly" is true:

Disks with the <readonly/> flag are added read-only.

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

Disks with the <readonly/> flag are added read/write.

If "readonly" is true:

Disks with the <readonly/> flag are added read-only.

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

Disks with the <readonly/> flag are skipped.

If present, the value of "logical_block_size" attribute of <blockio/> tag in libvirt XML will be passed as "blocksize" parameter to "g.add_drive_opts".

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

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.7.4

### add_domain

public int add_domain(String dom) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### add_drive

public void add_drive(String filename, Map<String,Object> optargs) throws LibGuestFSException

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.

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" This field used to be passed as a hint for guest inspection, but it is no longer used.

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

"protocol" The optional protocol argument can be used to select an alternate source protocol.

See also: "REMOTE STORAGE" in guestfs(3).

"protocol = "file"" filename is interpreted as a local file or device. This is the default if the optional protocol parameter is omitted.

"protocol = "ftp"|"ftps"|"http"|"https"" Connect to a remote FTP or HTTP server. The "server" parameter must also be supplied - see below.

See also: "FTP AND HTTP" in guestfs(3)

"protocol = "iscsi"" Connect to the iSCSI server. The "server" parameter must also be supplied - see below. The "username" parameter may be supplied. See below. The "secret" parameter may be supplied. See below.

See also: "ISCSI" in guestfs(3).

"protocol = "nbd"" Connect to the Network Block Device server. The "server" parameter must also be supplied - see below.

See also: "NETWORK BLOCK DEVICE" in guestfs(3).

"protocol = "rbd"" Connect to the Ceph (librbd/RBD) server. The "server" parameter must also be supplied - see below. The "username" parameter may be supplied. See below. The "secret" parameter may be supplied. See below.

See also: "CEPH" in guestfs(3).

"protocol = "ssh"" Connect to the Secure Shell (ssh) server.

The "server" parameter must be supplied. The "username" parameter may be supplied. See below.

See also: "SSH" in guestfs(3).

"server" For protocols which require access to a remote server, this is a list of server(s).

Protocol Number of servers required -------- -------------------------- file List must be empty or param not used at all ftp|ftps|http|https Exactly one iscsi Exactly one nbd Exactly one rbd Zero or more ssh Exactly one

Each list element is a string specifying a server. The string must be in one of the following formats:

hostname hostname:port tcp:hostname tcp:hostname:port unix:/path/to/socket

If the port number is omitted, then the standard port number for the protocol is used (see /etc/services).

"username" For the "ftp", "ftps", "http", "https", "iscsi", "rbd" and "ssh" protocols, this specifies the remote username.

If not given, then the local username is used for "ssh", and no authentication is attempted for ceph. But note this sometimes may give unexpected results, for example if using the libvirt backend and if the libvirt backend is configured to start the qemu appliance as a special user such as "qemu.qemu". If in doubt, specify the remote username you want.

"secret" For the "rbd" protocol only, this specifies the ‘secret’ to use when connecting to the remote device. It must be base64 encoded.

If not given, then a secret matching the given username will be looked up in the default keychain locations, or if no username is given, then no authentication will be used.

"cachemode" Choose whether or not libguestfs will obey sync operations (safe but slow) or not (unsafe but fast). The possible values for this string are:

"cachemode = "writeback"" This is the default.

Write operations in the API do not return until a write(2) call has completed in the host [but note this does not imply that anything gets written to disk].

Sync operations in the API, including implicit syncs caused by filesystem journalling, will not return until an fdatasync(2) call has completed in the host, indicating that data has been committed to disk.

"cachemode = "unsafe"" In this mode, there are no guarantees. Libguestfs may cache anything and ignore sync requests. This is suitable only for scratch or temporary disks.

"discard" Enable or disable discard (a.k.a. trim or unmap) support on this drive. If enabled, operations such as "g.fstrim" will be able to discard / make thin / punch holes in the underlying host file or device.

Possible discard settings are:

"discard = "disable"" Disable discard support. This is the default.

"discard = "enable"" Enable discard support. Fail if discard is not possible.

"discard = "besteffort"" Enable discard support if possible, but don't fail if it is not supported.

Since not all backends and not all underlying systems support discard, this is a good choice if you want to use discard if possible, but don't mind if it doesn't work.

"copyonread" The boolean parameter "copyonread" enables copy-on-read support. This only affects disk formats which have backing files, and causes reads to be stored in the overlay layer, speeding up multiple reads of the same area of disk.

The default is false.

"blocksize" This parameter sets the sector size of the disk. Possible values are 512 (the default if the parameter is omitted) or 4096. Use 4096 when handling an "Advanced Format" disk that uses 4K sector size (<https://en.wikipedia.org/wiki/Advanced_Format>).

Only a subset of the backends support this parameter (currently only the libvirt and direct backends do).

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  0.3

### add_drive

public void add_drive(String filename) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### add_drive_opts

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

Throws:
  `LibGuestFSException`

### add_drive_opts

public void add_drive_opts(String filename) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### add_drive_ro

public void add_drive_ro(String filename) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.38

### add_drive_ro_with_if

@Deprecated public void add_drive_ro_with_if(String filename, String iface) throws LibGuestFSException
Deprecated.
In new code, use `add_drive(String, Map)` instead

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. Both the direct and the libvirt backends ignore "iface".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.84

### add_drive_scratch

public void add_drive_scratch(long size, Map<String,Object> optargs) throws LibGuestFSException

add a temporary scratch drive

This command adds a temporary scratch drive to the handle. The "size" parameter is the virtual size (in bytes). The scratch drive is blank initially (all reads return zeroes until you start writing to it). The drive is deleted when the handle is closed.

The optional arguments "name", "label" and "blocksize" are passed through to "g.add_drive_opts".

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.23.10

### add_drive_scratch

public void add_drive_scratch(long size) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### add_drive_with_if

@Deprecated public void add_drive_with_if(String filename, String iface) throws LibGuestFSException
Deprecated.
In new code, use `add_drive(String, Map)` instead

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. Both the direct and the libvirt backends ignore "iface".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.84

### add_libvirt_dom

public int add_libvirt_dom(long dom, Map<String,Object> optargs) throws LibGuestFSException

add the disk(s) from a libvirt domain

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

In the C API we declare "void *dom", but really it has type "virDomainPtr dom". This is so we don't need <libvirt.h>.

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 <https://libvirt.org/remote.html>) will fail unless those disks are accessible via the same device path locally too.

The optional "live" flag is ignored in libguestfs ≥ 1.48.

The optional "readonlydisk" parameter controls what we do for disks which are marked <readonly/> in the libvirt XML. See "g.add_domain" for possible values.

If present, the value of "logical_block_size" attribute of <blockio/> tag in libvirt XML will be passed as "blocksize" parameter to "g.add_drive_opts".

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

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.29.14

### add_libvirt_dom

public int add_libvirt_dom(long dom) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### aug_clear

public void aug_clear(String augpath) throws LibGuestFSException

clear Augeas path

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.3.4

### aug_close

public void aug_close() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.7

### aug_defnode

public IntBool aug_defnode(String name, String expr, String val) throws LibGuestFSException

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", "val". "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` - If there is a libguestfs error.
Since:
  0.7

### aug_defvar

public int aug_defvar(String name, String expr) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.7

### aug_get

public String aug_get(String augpath) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.7

### aug_init

public void aug_init(String root, int flags) throws LibGuestFSException

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 <augeas.h>, 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 <http://augeas.net/>.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.7

### aug_insert

public void aug_insert(String augpath, String label, boolean before) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.7

### aug_label

public String aug_label(String augpath) throws LibGuestFSException

return the label from an Augeas path expression

The label (name of the last element) of the Augeas path expression "augpath" is returned. "augpath" must match exactly one node, else this function returns an error.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.23.14

### aug_load

public void aug_load() throws LibGuestFSException

load files into the tree

Load files into the tree.

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.7

### aug_ls

public String[] aug_ls(String augpath) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.8

### aug_match

public String[] aug_match(String augpath) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.7

### aug_mv

public void aug_mv(String src, String dest) throws LibGuestFSException

move Augeas node

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.7

### aug_rm

public int aug_rm(String augpath) throws LibGuestFSException

remove an Augeas path

Remove "path" and all of its children.

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.7

### aug_save

public void aug_save() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.7

### aug_set

public void aug_set(String augpath, String val) throws LibGuestFSException

set Augeas path to value

Set the value associated with "augpath" 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` - If there is a libguestfs error.
Since:
  0.7

### aug_setm

public int aug_setm(String base, String sub, String val) throws LibGuestFSException

set multiple Augeas nodes

Change multiple Augeas nodes in a single operation. "base" is an expression matching multiple nodes. "sub" is a path expression relative to "base". All nodes matching "base" are found, and then for each node, "sub" is changed to "val". "sub" may also be "NULL" in which case the "base" nodes are modified.

This returns the number of nodes modified.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.23.14

### aug_transform

public void aug_transform(String lens, String file, Map<String,Object> optargs) throws LibGuestFSException

add/remove an Augeas lens transformation

Add an Augeas transformation for the specified "lens" so it can handle "file".

If "remove" is true ("false" by default), then the transformation is removed.

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.35.2

### aug_transform

public void aug_transform(String lens, String file) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### available

public void available(String[] groups) throws LibGuestFSException

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:*

* "g.feature_available" is the same as this call, but with a slightly simpler to use API: that call returns a boolean true/false instead of throwing an error.

* 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` - If there is a libguestfs error.
Since:
  1.0.80

### available_all_groups

public String[] available_all_groups() throws LibGuestFSException

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" / "g.feature_available" on each member of the returned list.

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.3.15

### base64_in

public void base64_in(String base64file, String filename) throws LibGuestFSException

upload base64-encoded data to file

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.3.5

### base64_out

public void base64_out(String filename, String base64file) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.3.5

### blkdiscard

public void blkdiscard(String device) throws LibGuestFSException

discard all blocks on a device

This discards all blocks on the block device "device", giving the free space back to the host.

This operation requires support in libguestfs, 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. You must also set the "discard" attribute on the underlying drive (see "g.add_drive_opts").

This function depends on the feature "blkdiscard". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.25.44

### blkdiscardzeroes

public boolean blkdiscardzeroes(String device) throws LibGuestFSException

return true if discarded blocks are read as zeroes

This call returns true if blocks on "device" that have been discarded by a call to "g.blkdiscard" are returned as blocks of zero bytes when read the next time.

If it returns false, then it may be that discarded blocks are read as stale or random data.

This function depends on the feature "blkdiscardzeroes". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.25.44

### blkid

public Map<String,String> blkid(String device) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.15.9

### blockdev_flushbufs

public void blockdev_flushbufs(String device) throws LibGuestFSException

flush device buffers

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

This uses the blockdev(8) command.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.9.3

### blockdev_getbsz

public int blockdev_getbsz(String device) throws LibGuestFSException

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*. Also this setting is not really used by anything. You should probably not use it for anything. Filesystems have their own idea about what block size to choose.

This uses the blockdev(8) command.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.9.3

### blockdev_getro

public boolean blockdev_getro(String device) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.9.3

### blockdev_getsize64

public long blockdev_getsize64(String device) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.9.3

### blockdev_getss

public int blockdev_getss(String device) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.9.3

### blockdev_getsz

public long blockdev_getsz(String device) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.9.3

### blockdev_rereadpt

public void blockdev_rereadpt(String device) throws LibGuestFSException

reread partition table

Reread the partition table on "device".

This uses the blockdev(8) command.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.9.3

### blockdev_setbsz

@Deprecated public void blockdev_setbsz(String device, int blocksize) throws LibGuestFSException
Deprecated.
There is no documented replacement

set blocksize of block device

This call does nothing and has never done anything because of a bug in blockdev. Do not use it.

If you need to set the filesystem block size, use the "blocksize" option of "g.mkfs".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.9.3

### blockdev_setra

public void blockdev_setra(String device, int sectors) throws LibGuestFSException

set readahead

Set readahead (in 512-byte sectors) for the device.

This uses the blockdev(8) command.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.10

### blockdev_setro

public void blockdev_setro(String device) throws LibGuestFSException

set block device to read-only

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

This uses the blockdev(8) command.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.9.3

### blockdev_setrw

public void blockdev_setrw(String device) throws LibGuestFSException

set block device to read-write

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

This uses the blockdev(8) command.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.9.3

### btrfs_balance_cancel

public void btrfs_balance_cancel(String path) throws LibGuestFSException

cancel a running or paused balance

Cancel a running balance on a btrfs filesystem.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.22

### btrfs_balance_pause

public void btrfs_balance_pause(String path) throws LibGuestFSException

pause a running balance

Pause a running balance on a btrfs filesystem.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.22

### btrfs_balance_resume

public void btrfs_balance_resume(String path) throws LibGuestFSException

resume a paused balance

Resume a paused balance on a btrfs filesystem.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.22

### btrfs_balance_status

public BTRFSBalance btrfs_balance_status(String path) throws LibGuestFSException

show the status of a running or paused balance

Show the status of a running or paused balance on a btrfs filesystem.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.26

### btrfs_device_add

public void btrfs_device_add(String[] devices, String fs) throws LibGuestFSException

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.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.35

### btrfs_device_delete

public void btrfs_device_delete(String[] devices, String fs) throws LibGuestFSException

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.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.35

### btrfs_filesystem_balance

public void btrfs_filesystem_balance(String fs) throws LibGuestFSException

balance a btrfs filesystem

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

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.35

### btrfs_filesystem_defragment

public void btrfs_filesystem_defragment(String path, Map<String,Object> optargs) throws LibGuestFSException

defragment a file or directory

Defragment a file or directory on a btrfs filesystem. compress is one of zlib or lzo.

Optional arguments are supplied in the final Map<String,Object> 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.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.22

### btrfs_filesystem_defragment

public void btrfs_filesystem_defragment(String path) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### btrfs_filesystem_resize

public void btrfs_filesystem_resize(String mountpoint, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.11.17

### btrfs_filesystem_resize

public void btrfs_filesystem_resize(String mountpoint) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### btrfs_filesystem_show

public String[] btrfs_filesystem_show(String device) throws LibGuestFSException

list devices for btrfs filesystem

Show all the devices where the filesystems in "device" is spanned over.

If not all the devices for the filesystems are present, then this function fails and the "errno" is set to "ENODEV".

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.33.29

### btrfs_filesystem_sync

public void btrfs_filesystem_sync(String fs) throws LibGuestFSException

sync a btrfs filesystem

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

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.35

### btrfs_fsck

@Deprecated public void btrfs_fsck(String device, Map<String,Object> optargs) throws LibGuestFSException
Deprecated.
In new code, use `btrfs_scrub_full(String, Map)` instead

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<String,Object> 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.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.43

### btrfs_fsck

public void btrfs_fsck(String device) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### btrfs_image

public void btrfs_image(String[] source, String image, Map<String,Object> optargs) throws LibGuestFSException

create an image of a btrfs filesystem

This is used to create an image of a btrfs filesystem. All data will be zeroed, but metadata and the like is preserved.

Optional arguments are supplied in the final Map<String,Object> 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.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.32

### btrfs_image

public void btrfs_image(String[] source, String image) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### btrfs_qgroup_assign

public void btrfs_qgroup_assign(String src, String dst, String path) throws LibGuestFSException

add a qgroup to a parent qgroup

Add qgroup "src" to parent qgroup "dst". This command can group several qgroups into a parent qgroup to share common limit.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.17

### btrfs_qgroup_create

public void btrfs_qgroup_create(String qgroupid, String subvolume) throws LibGuestFSException

create a subvolume quota group

Create a quota group (qgroup) for subvolume at "subvolume".

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.17

### btrfs_qgroup_destroy

public void btrfs_qgroup_destroy(String qgroupid, String subvolume) throws LibGuestFSException

destroy a subvolume quota group

Destroy a quota group.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.17

### btrfs_qgroup_limit

public void btrfs_qgroup_limit(String subvolume, long size) throws LibGuestFSException

limit the size of a subvolume

Limit the size of the subvolume with path "subvolume".

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.17

### btrfs_qgroup_remove

public void btrfs_qgroup_remove(String src, String dst, String path) throws LibGuestFSException

remove a qgroup from its parent qgroup

Remove qgroup "src" from the parent qgroup "dst".

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.17

### btrfs_qgroup_show

public BTRFSQgroup[] btrfs_qgroup_show(String path) throws LibGuestFSException

show subvolume quota groups

Show all subvolume quota groups in a btrfs filesystem, including their usages.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.17

### btrfs_quota_enable

public void btrfs_quota_enable(String fs, boolean enable) throws LibGuestFSException

enable or disable subvolume quota support

Enable or disable subvolume quota support for filesystem which contains "path".

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.17

### btrfs_quota_rescan

public void btrfs_quota_rescan(String fs) throws LibGuestFSException

trash all qgroup numbers and scan the metadata again with the current config

Trash all qgroup numbers and scan the metadata again with the current config.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.17

### btrfs_replace

public void btrfs_replace(String srcdev, String targetdev, String mntpoint) throws LibGuestFSException

replace a btrfs managed device with another device

Replace device of a btrfs filesystem. On a live filesystem, duplicate the data to the target device which is currently stored on the source device. After completion of the operation, the source device is wiped out and removed from the filesystem.

The "targetdev" needs to be same size or larger than the "srcdev". Devices which are currently mounted are never allowed to be used as the "targetdev".

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.48

### btrfs_rescue_chunk_recover

public void btrfs_rescue_chunk_recover(String device) throws LibGuestFSException

recover the chunk tree of btrfs filesystem

Recover the chunk tree of btrfs filesystem by scanning the devices one by one.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.22

### btrfs_rescue_super_recover

public void btrfs_rescue_super_recover(String device) throws LibGuestFSException

recover bad superblocks from good copies

Recover bad superblocks from good copies.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.22

### btrfs_scrub_cancel

public void btrfs_scrub_cancel(String path) throws LibGuestFSException

cancel a running scrub

Cancel a running scrub on a btrfs filesystem.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.22

### btrfs_scrub_full

public void btrfs_scrub_full(String path, Map<String,Object> optargs) throws LibGuestFSException

run a full scrub on a btrfs filesystem

Run a full scrub on a btrfs filesystem and wait for it to finish. If the filesystem has errors this will return an error.

Optional arguments are supplied in the final Map<String,Object> 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.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.55.12

### btrfs_scrub_full

public void btrfs_scrub_full(String path) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### btrfs_scrub_resume

public void btrfs_scrub_resume(String path) throws LibGuestFSException

resume a previously canceled or interrupted scrub

Resume a previously canceled or interrupted scrub on a btrfs filesystem.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.22

### btrfs_scrub_start

public void btrfs_scrub_start(String path) throws LibGuestFSException

read all data from all disks and verify checksums

Reads all the data and metadata on the filesystem, and uses checksums and the duplicate copies from RAID storage to identify and repair any corrupt data.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.22

### btrfs_scrub_status

public BTRFSScrub btrfs_scrub_status(String path) throws LibGuestFSException

show status of running or finished scrub

Show status of running or finished scrub on a btrfs filesystem.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.26

### btrfs_set_seeding

public void btrfs_set_seeding(String device, boolean seeding) throws LibGuestFSException

enable or disable the seeding feature of device

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

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.43

### btrfs_subvolume_create

public void btrfs_subvolume_create(String dest, Map<String,Object> optargs) throws LibGuestFSException

create a btrfs subvolume

Create a btrfs subvolume. The "dest" argument is the destination directory and the name of the subvolume, in the form /path/to/dest/name. The optional parameter "qgroupid" represents the qgroup which the newly created subvolume will be added to.

Optional arguments are supplied in the final Map<String,Object> 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.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.35

### btrfs_subvolume_create

public void btrfs_subvolume_create(String dest) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### btrfs_subvolume_create_opts

public void btrfs_subvolume_create_opts(String dest, Map<String,Object> optargs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### btrfs_subvolume_create_opts

public void btrfs_subvolume_create_opts(String dest) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### btrfs_subvolume_delete

public void btrfs_subvolume_delete(String subvolume) throws LibGuestFSException

delete a btrfs subvolume or snapshot

Delete the named btrfs subvolume or snapshot.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.35

### btrfs_subvolume_get_default

public long btrfs_subvolume_get_default(String fs) throws LibGuestFSException

get the default subvolume or snapshot of a filesystem

Get the default subvolume or snapshot of a filesystem mounted at "mountpoint".

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.17

### btrfs_subvolume_list

public BTRFSSubvolume[] btrfs_subvolume_list(String fs) throws LibGuestFSException

list btrfs snapshots and subvolumes

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

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.35

### btrfs_subvolume_set_default

public void btrfs_subvolume_set_default(long id, String fs) throws LibGuestFSException

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.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.35

### btrfs_subvolume_show

public Map<String,String> btrfs_subvolume_show(String subvolume) throws LibGuestFSException

return detailed information of the subvolume

Return detailed information of the subvolume.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.17

### btrfs_subvolume_snapshot

public void btrfs_subvolume_snapshot(String source, String dest, Map<String,Object> optargs) throws LibGuestFSException

create a btrfs snapshot

Create a 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. By default the newly created snapshot is writable, if the value of optional parameter "ro" is true, then a readonly snapshot is created. The optional parameter "qgroupid" represents the qgroup which the newly created snapshot will be added to.

Optional arguments are supplied in the final Map<String,Object> 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.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.35

### btrfs_subvolume_snapshot

public void btrfs_subvolume_snapshot(String source, String dest) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### btrfs_subvolume_snapshot_opts

public void btrfs_subvolume_snapshot_opts(String source, String dest, Map<String,Object> optargs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### btrfs_subvolume_snapshot_opts

public void btrfs_subvolume_snapshot_opts(String source, String dest) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### btrfstune_enable_extended_inode_refs

public void btrfstune_enable_extended_inode_refs(String device) throws LibGuestFSException

enable extended inode refs

This will Enable extended inode refs.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.29

### btrfstune_enable_skinny_metadata_extent_refs

public void btrfstune_enable_skinny_metadata_extent_refs(String device) throws LibGuestFSException

enable skinny metadata extent refs

This enable skinny metadata extent refs.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.29

### btrfstune_seeding

public void btrfstune_seeding(String device, boolean seeding) throws LibGuestFSException

enable or disable seeding of a btrfs device

Enable seeding of a btrfs device, this will force a fs readonly so that you can use it to build other filesystems.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.29

### c_pointer

public long c_pointer() throws LibGuestFSException

return the C pointer to the guestfs_h handle

In non-C language bindings, this allows you to retrieve the underlying C pointer to the handle (ie. "g.h *"). The purpose of this is to allow other libraries to interwork with libguestfs.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.17

### canonical_device_name

public String canonical_device_name(String device) throws LibGuestFSException

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

Other strings are returned unmodified.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.7

### cap_get_file

public String cap_get_file(String path) throws LibGuestFSException

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

If no capabilities are attached to a file, an empty string is returned.

This function depends on the feature "linuxcaps". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.63

### cap_set_file

public void cap_set_file(String path, String cap) throws LibGuestFSException

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

This function depends on the feature "linuxcaps". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.63

### case_sensitive_path

public String case_sensitive_path(String path) throws LibGuestFSException

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. See the relevant entry in the ntfs-3g FAQ: <https://github.com/tuxera/ntfs-3g/wiki/NTFS-3G-FAQ>

"g.case_sensitive_path" attempts to resolve the true case of each element in the path. It will return a resolved path if either the full path or its parent directory exists. If the parent directory exists but the full path does not, the case of the parent directory will be correctly resolved, and the remainder appended unmodified. For example, if the file "/Windows/System32/netkvm.sys" exists:

"g.case_sensitive_path" ("/windows/system32/netkvm.sys") "Windows/System32/netkvm.sys"

"g.case_sensitive_path" ("/windows/system32/NoSuchFile") "Windows/System32/NoSuchFile"

"g.case_sensitive_path" ("/windows/system33/netkvm.sys") *ERROR*

*Note*: Because of the above behaviour, "g.case_sensitive_path" cannot be used to check for the existence of a file.

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

See also "g.realpath".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.75

### cat

public String cat(String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.4

### checksum

public String checksum(String csumtype, String path) throws LibGuestFSException

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.

"gost" "gost12" Compute the checksum using GOST R34.11-94 or GOST R34.11-2012 message digest.

"md5" Compute the MD5 hash (using the md5sum(1) program).

"sha1" Compute the SHA1 hash (using the sha1sum(1) program).

"sha224" Compute the SHA224 hash (using the sha224sum(1) program).

"sha256" Compute the SHA256 hash (using the sha256sum(1) program).

"sha384" Compute the SHA384 hash (using the sha384sum(1) program).

"sha512" Compute the SHA512 hash (using the sha512sum(1) 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` - If there is a libguestfs error.
Since:
  1.0.2

### checksum_device

public String checksum_device(String csumtype, String device) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.3.2

### checksums_out

public void checksums_out(String csumtype, String directory, String sumsfile) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.3.7

### chmod

public void chmod(int mode, String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.8

### chown

public void chown(int owner, int group, String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.8

### clear_backend_setting

public int clear_backend_setting(String name) throws LibGuestFSException

remove a single per-backend settings string

If there is a backend setting string matching "name" or beginning with "name=", then that string is removed from the backend settings.

This call returns the number of strings which were removed (which may be 0, 1 or greater than 1).

See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in guestfs(3).

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.27.2

### clevis_luks_unlock

public void clevis_luks_unlock(String device, String mapname) throws LibGuestFSException

open an encrypted LUKS block device with Clevis and Tang

This command opens a block device that has been encrypted according to the Linux Unified Key Setup (LUKS) standard, using network-bound disk encryption (NBDE).

"device" is the encrypted block device.

The appliance will connect to the Tang servers noted in the tree of Clevis pins that is bound to a keyslot of the LUKS header. The Clevis pin tree may comprise "sss" (redundancy) pins as internal nodes (optionally), and "tang" pins as leaves. "tpm2" pins are not supported. The appliance unlocks the encrypted block device by combining responses from the Tang servers with metadata from the LUKS header; there is no "key" parameter.

This command will fail if networking has not been enabled for the appliance. Refer to "g.set_network".

The command 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. Close the decrypted block device with "g.cryptsetup_close".

"mapname" cannot be "control" because that name is reserved by device-mapper.

If this block device contains LVM volume groups, then calling "g.lvm_scan" with the "activate" parameter "true" will make them visible.

Use "g.list_dm_devices" to list all device mapper devices.

This function depends on the feature "clevisluks". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.49.3

### command

public String command(String[] arguments) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.9.1

### command_lines

public String[] command_lines(String[] arguments) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.9.1

### command_out

public void command_out(String[] arguments, String output) throws LibGuestFSException

run a command from the guest filesystem

This is the same as "g.command", but streams the output back, handling the case where the output from the command is larger than the protocol limit.

See also: "g.sh_out"

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.55.6

### compress_device_out

public void compress_device_out(String ctype, String device, String zdevice, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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` - If there is a libguestfs error.
Since:
  1.13.15

### compress_device_out

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

Throws:
  `LibGuestFSException`

### compress_out

public void compress_out(String ctype, String file, String zfile, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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` - If there is a libguestfs error.
Since:
  1.13.15

### compress_out

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

Throws:
  `LibGuestFSException`

### config

public void config(String hvparam, String hvvalue) throws LibGuestFSException

add hypervisor parameters

This can be used to add arbitrary hypervisor 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 "hvparam" string must be a "-" (dash).

"hvvalue" can be NULL.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.3

### copy_attributes

public void copy_attributes(String src, String dest, Map<String,Object> optargs) throws LibGuestFSException

copy the attributes of a path (file/directory) to another

Copy the attributes of a path (which can be a file or a directory) to another path.

By default no attribute is copied, so make sure to specify any (or "all" to copy everything).

The optional arguments specify which attributes can be copied:

"mode" Copy part of the file mode from "source" to "destination". Only the UNIX permissions and the sticky/setuid/setgid bits can be copied.

"xattributes" Copy the Linux extended attributes (xattrs) from "source" to "destination". This flag does nothing if the *linuxxattrs* feature is not available (see "g.feature_available").

"ownership" Copy the owner uid and the group gid of "source" to "destination".

"all" Copy all the attributes from "source" to "destination". Enabling it enables all the other flags, if they are not specified already.

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.25.21

### copy_attributes

public void copy_attributes(String src, String dest) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### copy_device_to_device

public void copy_device_to_device(String src, String dest, Map<String,Object> optargs) throws LibGuestFSException

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.

If the destination is a file and the "append" flag is not set, then the destination file is truncated. If the "append" flag is set, then the copy appends to the destination file. The "append" flag currently cannot be set for devices.

If the "sparse" flag is true then the call avoids writing blocks that contain only zeroes, which can help in some situations where the backing disk is thin-provisioned. Note that unless the target is already zeroed, using this option will result in incorrect copying.

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.13.25

### copy_device_to_device

public void copy_device_to_device(String src, String dest) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### copy_device_to_file

public void copy_device_to_file(String src, String dest, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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` - If there is a libguestfs error.
Since:
  1.13.25

### copy_device_to_file

public void copy_device_to_file(String src, String dest) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### copy_file_to_device

public void copy_file_to_device(String src, String dest, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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` - If there is a libguestfs error.
Since:
  1.13.25

### copy_file_to_device

public void copy_file_to_device(String src, String dest) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### copy_file_to_file

public void copy_file_to_file(String src, String dest, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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` - If there is a libguestfs error.
Since:
  1.13.25

### copy_file_to_file

public void copy_file_to_file(String src, String dest) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### copy_in

public void copy_in(String localpath, String remotedir) throws LibGuestFSException

copy local files or directories into an image

"g.copy_in" copies local files or directories recursively into the disk image, placing them in the directory called "remotedir" (which must exist).

Wildcards cannot be used.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.24

### copy_out

public void copy_out(String remotepath, String localdir) throws LibGuestFSException

copy remote files or directories out of an image

"g.copy_out" copies remote files or directories recursively out of the disk image, placing them on the host disk in a local directory called "localdir" (which must exist).

To download to the current directory, use "." as in:

C<g.copy_out> /home .

Wildcards cannot be used.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.24

### copy_size

@Deprecated public void copy_size(String src, String dest, long size) throws LibGuestFSException
Deprecated.
In new code, use `copy_device_to_device(String, String, Map)` instead

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.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.87

### cp

public void cp(String src, String dest) throws LibGuestFSException

copy a file

This copies a file from "src" to "dest" where "dest" is either a destination filename or destination directory.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.18

### cp_a

public void cp_a(String src, String dest) throws LibGuestFSException

copy a file or directory recursively

This copies a file or directory from "src" to "dest" recursively using the "cp -a" command.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.18

### cp_r

public void cp_r(String src, String dest) throws LibGuestFSException

copy a file or directory recursively

This copies a file or directory from "src" to "dest" recursively using the "cp -rP" command.

Most users should use "g.cp_a" instead. This command is useful when you don't want to preserve permissions, because the target filesystem does not support it (primarily when writing to DOS FAT filesystems).

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.21.38

### cpio_out

public void cpio_out(String directory, String cpiofile, Map<String,Object> optargs) throws LibGuestFSException

pack directory into cpio file

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

The optional "format" parameter can be used to select the format. Only the following formats are currently permitted:

"newc" New (SVR4) portable format. This format happens to be compatible with the cpio-like format used by the Linux kernel for initramfs.

This is the default format.

"crc" New (SVR4) portable format with a checksum.

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.27.9

### cpio_out

public void cpio_out(String directory, String cpiofile) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### cryptsetup_close

public void cryptsetup_close(String device) throws LibGuestFSException

close an encrypted device

This closes an encrypted device that was created earlier by "g.cryptsetup_open". The "device" parameter must be the name of the mapping device (ie. /dev/mapper/mapname) and *not* the name of the underlying block device.

This function depends on the feature "luks". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.43.2

### cryptsetup_open

public void cryptsetup_open(String device, String key, String mapname, Map<String,Object> optargs) throws LibGuestFSException

open an encrypted block device

This command opens a block device which has been encrypted according to the Linux Unified Key Setup (LUKS) standard, Windows BitLocker, or some other types.

"device" is the encrypted block device or partition.

The caller must supply one of the keys associated with the encrypted 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.

"mapname" cannot be "control" because that name is reserved by device-mapper.

If the optional "crypttype" parameter is not present then libguestfs tries to guess the correct type (for example LUKS or BitLocker). However you can override this by specifying one of the following types:

"luks" A Linux LUKS device.

"bitlk" A Windows BitLocker device.

The optional "readonly" flag, if set to true, creates a read-only mapping.

The optional "cipher" parameter allows specifying which cipher to use.

If this block device contains LVM volume groups, then calling "g.lvm_scan" with the "activate" parameter "true" will make them visible.

Use "g.list_dm_devices" to list all device mapper devices.

Optional arguments are supplied in the final Map<String,Object> 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.

This function depends on the feature "luks". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.43.2

### cryptsetup_open

public void cryptsetup_open(String device, String key, String mapname) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### dd

@Deprecated public void dd(String src, String dest) throws LibGuestFSException
Deprecated.
In new code, use `copy_device_to_device(String, String, Map)` instead

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.80

### debug

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

Throws:
  `LibGuestFSException`

### debug_drives

public String[] debug_drives() throws LibGuestFSException

Throws:
  `LibGuestFSException`

### debug_upload

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

Throws:
  `LibGuestFSException`

### device_index

public int device_index(String device) throws LibGuestFSException

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", "g.device_name".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.7

### device_name

public String device_name(int index) throws LibGuestFSException

convert device index to name

This function takes a device index and returns the device name. For example index 0 will return the string "/dev/sda".

The drive index must have been added to the handle.

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.49.1

### df

public String df() throws LibGuestFSException

report file system disk space usage

This command runs the df(1) 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` - If there is a libguestfs error.
Since:
  1.0.54

### df_h

public String df_h() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.54

### disk_create

public void disk_create(String filename, String format, long size, Map<String,Object> optargs) throws LibGuestFSException

create a blank disk image

Create a blank disk image called filename (a host file) with format "format" (usually "raw" or "qcow2"). The size is "size" bytes.

If used with the optional "backingfile" parameter, then a snapshot is created on top of the backing file. In this case, "size" must be passed as -1. The size of the snapshot is the same as the size of the backing file, which is discovered automatically. You are encouraged to also pass "backingformat" to describe the format of "backingfile".

If filename refers to a block device, then the device is formatted. The "size" is ignored since block devices have an intrinsic size.

The other optional parameters are:

"preallocation" If format is "raw", then this can be either "off" (or "sparse") or "full" to create a sparse or fully allocated file respectively. The default is "off".

If format is "qcow2", then this can be "off" (or "sparse"), "metadata" or "full". Preallocating metadata can be faster when doing lots of writes, but uses more space. The default is "off".

"compat" "qcow2" only: Pass the string 1.1 to use the advanced qcow2 format supported by qemu ≥ 1.1.

"clustersize" "qcow2" only: Change the qcow2 cluster size. The default is 65536 (bytes) and this setting may be any power of two between 512 and 2097152.

Note that this call does not add the new disk to the handle. You may need to call "g.add_drive_opts" separately.

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.25.31

### disk_create

public void disk_create(String filename, String format, long size) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### disk_format

public String disk_format(String filename) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.38

### disk_has_backing_file

public boolean disk_has_backing_file(String filename) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.39

### disk_virtual_size

public long disk_virtual_size(String filename) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.39

### dmesg

public String dmesg() throws LibGuestFSException

return kernel messages

This returns the kernel messages (dmesg(1) 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` - If there is a libguestfs error.
Since:
  1.0.18

### download

public void download(String remotefilename, String filename) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.2

### download_blocks

public void download_blocks(String device, long start, long stop, String filename, Map<String,Object> optargs) throws LibGuestFSException

download the given data units from the disk

Download the data units from start address to stop from the disk partition (eg. /dev/sda1) and save them as filename on the local machine.

The use of this API on sparse disk image formats such as QCOW, may result in large zero-filled files downloaded on the host.

The size of a data unit varies across filesystem implementations. On NTFS filesystems data units are referred as clusters while on ExtX ones they are referred as fragments.

If the optional "unallocated" flag is true (default is false), only the unallocated blocks will be extracted. This is useful to detect hidden data or to retrieve deleted files which data units have not been overwritten yet.

Optional arguments are supplied in the final Map<String,Object> 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.

This function depends on the feature "sleuthkit". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.33.45

### download_blocks

public void download_blocks(String device, long start, long stop, String filename) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### download_inode

public void download_inode(String device, long inode, String filename) throws LibGuestFSException

download a file to the local machine given its inode

Download a file given its inode from the disk partition (eg. /dev/sda1) and save it as filename on the local machine.

It is not required to mount the disk to run this command.

The command is capable of downloading deleted or inaccessible files.

This function depends on the feature "sleuthkit". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.33.14

### download_offset

public void download_offset(String remotefilename, String filename, long offset, long size) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.5.17

### drop_caches

public void drop_caches(int whattodrop) throws LibGuestFSException

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 <https://linux-mm.org/Drop_Caches>

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` - If there is a libguestfs error.
Since:
  1.0.18

### du

public long du(String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.54

### e2fsck

public void e2fsck(String device, Map<String,Object> optargs) throws LibGuestFSException

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" or "forceno" options.

"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" or "forceno" options.

"forceno" Open the filesystem readonly and assume an answer of ‘no’ to all questions; allows e2fsck to be used non-interactively.

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

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.15.17

### e2fsck

public void e2fsck(String device) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### e2fsck_f

@Deprecated public void e2fsck_f(String device) throws LibGuestFSException
Deprecated.
In new code, use `e2fsck(String, Map)` instead

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.29

### echo_daemon

public String echo_daemon(String[] words) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.69

### egrep

@Deprecated public String[] egrep(String regex, String path) throws LibGuestFSException
Deprecated.
In new code, use `grep(String, String, Map)` instead

return lines matching a pattern

This calls the external egrep(1) program and returns the matching lines.

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### egrepi

@Deprecated public String[] egrepi(String regex, String path) throws LibGuestFSException
Deprecated.
In new code, use `grep(String, String, Map)` instead

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### equal

public boolean equal(String file1, String file2) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.18

### exists

public boolean exists(String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.8

### extlinux

public void extlinux(String directory) throws LibGuestFSException

install the SYSLINUX bootloader on an ext2/3/4 or btrfs filesystem

Install the SYSLINUX bootloader on the device mounted at directory. Unlike "g.syslinux" which requires a FAT filesystem, this can be used on an ext2/3/4 or btrfs filesystem.

The directory parameter can be either a mountpoint, or a directory within the mountpoint.

You also have to mark the partition as "active" ("g.part_set_bootable") and a Master Boot Record must be installed (eg. using "g.pwrite_device") on the first sector of the whole disk. The SYSLINUX package comes with some suitable Master Boot Records. See the extlinux(1) man page for further information.

Additional configuration can be supplied to SYSLINUX by placing a file called extlinux.conf on the filesystem under directory. For further information about the contents of this file, see extlinux(1).

See also "g.syslinux".

This function depends on the feature "extlinux". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.21.27

### f2fs_expand

public void f2fs_expand(String device) throws LibGuestFSException

expand a f2fs filesystem

This expands a f2fs filesystem to match the size of the underlying device.

This function depends on the feature "f2fs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.39.3

### fallocate

@Deprecated public void fallocate(String path, int len) throws LibGuestFSException
Deprecated.
In new code, use `fallocate64(String, long)` instead

preallocate a file in the guest filesystem

This command preallocates a file (containing zero bytes) named "path" of size "len" bytes. If the file exists already, it is overwritten.

Do not confuse this with the guestfish-specific "alloc" command which allocates a file in the host and attaches it as a device.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### fallocate64

public void fallocate64(String path, long len) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.3.17

### feature_available

public boolean feature_available(String[] groups) throws LibGuestFSException

test availability of some parts of the API

This is the same as "g.available", but unlike that call it returns a simple true/false boolean result, instead of throwing an exception if a feature is not found. For other documentation see "g.available".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.21.26

### fgrep

@Deprecated public String[] fgrep(String pattern, String path) throws LibGuestFSException
Deprecated.
In new code, use `grep(String, String, Map)` instead

return lines matching a pattern

This calls the external fgrep(1) program and returns the matching lines.

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### fgrepi

@Deprecated public String[] fgrepi(String pattern, String path) throws LibGuestFSException
Deprecated.
In new code, use `grep(String, String, Map)` instead

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### file

public String file(String path) throws LibGuestFSException

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 filename is not prepended to the output (like the file command *-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` - If there is a libguestfs error.
Since:
  1.9.1

### file_architecture

public String file_architecture(String filename) throws LibGuestFSException

detect the architecture of a binary file

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

Currently defined architectures are:

"aarch64" 64 bit ARM.

"arm" 32 bit ARM.

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

"ia64" Intel Itanium.

"ppc" 32 bit Power PC.

"ppc64" 64 bit Power PC (big endian).

"ppc64le" 64 bit Power PC (little endian).

"loongarch64" 64 bit LoongArch64 (little endian).

"riscv32" "riscv64" "riscv128" RISC-V 32-, 64- or 128-bit variants.

"s390" 31 bit IBM S/390.

"s390x" 64 bit IBM S/390.

"sparc" 32 bit SPARC.

"sparc64" 64 bit SPARC V9 and above.

"x86_64" 64 bit x86-64.

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` - If there is a libguestfs error.
Since:
  1.5.3

### filesize

public long filesize(String file) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.82

### filesystem_available

public boolean filesystem_available(String filesystem) throws LibGuestFSException

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 created or mounted, since filesystems can fail for other reasons such as it being a later version of the filesystem, or having incompatible features, or lacking the right mkfs.<*fs*> tool.

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.5

### filesystem_walk

public TSKDirent[] filesystem_walk(String device) throws LibGuestFSException

walk through the filesystem content

Walk through the internal structures of a disk partition (eg. /dev/sda1) in order to return a list of all the files and directories stored within.

It is not necessary to mount the disk partition to run this command.

All entries in the filesystem are returned. This function can list deleted or unaccessible files. The entries are *not* sorted.

The "tsk_dirent" structure contains the following fields.

"tsk_inode" Filesystem reference number of the node. It might be 0 if the node has been deleted.

"tsk_type" Basic file type information. See below for a detailed list of values.

"tsk_size" File size in bytes. It might be -1 if the node has been deleted.

"tsk_name" The file path relative to its directory.

"tsk_flags" Bitfield containing extra information regarding the entry. It contains the logical OR of the following values:

0x0001 If set to 1, the file is allocated and visible within the filesystem. Otherwise, the file has been deleted. Under certain circumstances, the function "download_inode" can be used to recover deleted files.

0x0002 Filesystem such as NTFS and Ext2 or greater, separate the file name from the metadata structure. The bit is set to 1 when the file name is in an unallocated state and the metadata structure is in an allocated one. This generally implies the metadata has been reallocated to a new file. Therefore, information such as file type, file size, timestamps, number of links and symlink target might not correspond with the ones of the original deleted entry.

0x0004 The bit is set to 1 when the file is compressed using filesystem native compression support (NTFS). The API is not able to detect application level compression.

"tsk_atime_sec" "tsk_atime_nsec" "tsk_mtime_sec" "tsk_mtime_nsec" "tsk_ctime_sec" "tsk_ctime_nsec" "tsk_crtime_sec" "tsk_crtime_nsec" Respectively, access, modification, last status change and creation time in Unix format in seconds and nanoseconds.

"tsk_nlink" Number of file names pointing to this entry.

"tsk_link" If the entry is a symbolic link, this field will contain the path to the target file.

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

'h' Shadow inode (Solaris)

'w' Whiteout inode (BSD)

'u' Unknown file type

This function depends on the feature "libtsk". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.33.39

### fill

public void fill(int c, int len, String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.79

### fill_dir

public void fill_dir(String dir, int nr) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.32

### fill_pattern

public void fill_pattern(String pattern, int len, String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.3.12

### find

public String[] find(String directory) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.27

### find0

public void find0(String directory, String files) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.74

### find_inode

public TSKDirent[] find_inode(String device, long inode) throws LibGuestFSException

search the entries associated to the given inode

Searches all the entries associated with the given inode.

For each entry, a "tsk_dirent" structure is returned. See "filesystem_walk" for more information about "tsk_dirent" structures.

This function depends on the feature "libtsk". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.35.6

### findfs_label

public String findfs_label(String label) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.5.3

### findfs_partlabel

public String findfs_partlabel(String label) throws LibGuestFSException

find a partition by label

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

To find the label of a partition, use "g.blkid" ("PART_ENTRY_NAME").

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.53.5

### findfs_partuuid

public String findfs_partuuid(String uuid) throws LibGuestFSException

find a partition by UUID

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

To find the UUID of a partition, use "g.blkid" ("PART_ENTRY_UUID").

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.53.5

### findfs_uuid

public String findfs_uuid(String uuid) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.5.3

### fsck

public int fsck(String fstype, String device) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.16

### fstrim

public void fstrim(String mountpoint, Map<String,Object> optargs) throws LibGuestFSException

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.

In the case where the kernel vfs driver does not support trimming, this call will fail with errno set to "ENOTSUP". Currently this happens when trying to trim FAT filesystems.

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<String,Object> 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.

This function depends on the feature "fstrim". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.6

### fstrim

public void fstrim(String mountpoint) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### get_append

public String get_append() throws LibGuestFSException

get the additional kernel options

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

If "NULL" then no options are added.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.26

### get_attach_method

@Deprecated public String get_attach_method() throws LibGuestFSException
Deprecated.
In new code, use `get_backend()` instead

get the backend

Return the current backend.

See "g.set_backend" and "BACKEND" in guestfs(3).

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.9.8

### get_autosync

public boolean get_autosync() throws LibGuestFSException

get autosync mode

Get the autosync flag.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.3

### get_backend

public String get_backend() throws LibGuestFSException

get the backend

Return the current backend.

This handle property was previously called the "attach method".

See "g.set_backend" and "BACKEND" in guestfs(3).

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.21.26

### get_backend_setting

public String get_backend_setting(String name) throws LibGuestFSException

get a single per-backend settings string

Find a backend setting string which is either "name" or begins with "name=". If "name", this returns the string "1". If "name=", this returns the part after the equals sign (which may be an empty string).

If no such setting is found, this function throws an error. The errno (see "g.last_errno") will be "ESRCH" in this case.

See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in guestfs(3).

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.27.2

### get_backend_settings

public String[] get_backend_settings() throws LibGuestFSException

get per-backend settings

Return the current backend settings.

This call returns all backend settings strings. If you want to find a single backend setting, see "g.get_backend_setting".

See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in guestfs(3).

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.25.24

### get_cachedir

public String get_cachedir() throws LibGuestFSException

get the appliance cache directory

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.58

### get_direct

@Deprecated public boolean get_direct() throws LibGuestFSException
Deprecated.
This is replaced by method #internal_get_console_socket which is not exported by the Java bindings

get direct appliance mode flag

Return the direct appliance mode flag.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.72

### get_e2attrs

public String get_e2attrs(String file) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.17.31

### get_e2generation

public long get_e2generation(String file) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.17.31

### get_e2label

@Deprecated public String get_e2label(String device) throws LibGuestFSException
Deprecated.
In new code, use `vfs_label(String)` instead

get the ext2/3/4 filesystem label

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.15

### get_e2uuid

@Deprecated public String get_e2uuid(String device) throws LibGuestFSException
Deprecated.
In new code, use `vfs_uuid(String)` instead

get the ext2/3/4 filesystem UUID

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.15

### get_hv

public String get_hv() throws LibGuestFSException

get the hypervisor binary

Return the current hypervisor binary.

This is always non-NULL. If it wasn't set already, then this will return the default qemu binary name.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.23.17

### get_identifier

public String get_identifier() throws LibGuestFSException

get the handle identifier

Get the handle identifier. See "g.set_identifier".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.31.14

### get_libvirt_requested_credential_challenge

public String get_libvirt_requested_credential_challenge(int index) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.52

### get_libvirt_requested_credential_defresult

public String get_libvirt_requested_credential_defresult(int index) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.52

### get_libvirt_requested_credential_prompt

public String get_libvirt_requested_credential_prompt(int index) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.52

### get_libvirt_requested_credentials

public String[] get_libvirt_requested_credentials() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.52

### get_memsize

public int get_memsize() throws LibGuestFSException

get memory allocated to the hypervisor

This gets the memory size in megabytes allocated to the hypervisor.

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` - If there is a libguestfs error.
Since:
  1.0.55

### get_network

public boolean get_network() throws LibGuestFSException

get enable network flag

This returns the enable network flag.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.5.4

### get_path

public String get_path() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.3

### get_pgroup

public boolean get_pgroup() throws LibGuestFSException

get process group flag

This returns the process group flag.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.11.18

### get_pid

public int get_pid() throws LibGuestFSException

get PID of hypervisor

Return the process ID of the hypervisor. If there is no hypervisor running, then this will return an error.

This is an internal call used for debugging and testing.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.56

### get_program

public String get_program() throws LibGuestFSException

get the program name

Get the program name. See "g.set_program".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.21.29

### get_qemu

@Deprecated public String get_qemu() throws LibGuestFSException
Deprecated.
In new code, use `get_hv()` instead

get the hypervisor binary (usually qemu)

Return the current hypervisor binary (usually qemu).

This is always non-NULL. If it wasn't set already, then this will return the default qemu binary name.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.6

### get_recovery_proc

public boolean get_recovery_proc() throws LibGuestFSException

get recovery process enabled flag

Return the recovery process enabled flag.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.77

### get_selinux

@Deprecated public boolean get_selinux() throws LibGuestFSException
Deprecated.
In new code, use `selinux_relabel(String, String, Map)` instead

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` - If there is a libguestfs error.
Since:
  1.0.67

### get_smp

public int get_smp() throws LibGuestFSException

get number of virtual CPUs in appliance

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.13.15

### get_sockdir

public String get_sockdir() throws LibGuestFSException

get the temporary directory for sockets and PID files

Get the directory used by the handle to store temporary socket and PID files.

This is different from "g.get_tmpdir", as we need shorter paths for sockets (due to the limited buffers of filenames for UNIX sockets), and "g.get_tmpdir" may be too long for them. Furthermore, sockets and PID files must be accessible to such background services started by libguestfs that may not have permission to access the temporary directory returned by "g.get_tmpdir".

The environment variable "XDG_RUNTIME_DIR" controls the default value: If "XDG_RUNTIME_DIR" is set, then that is the default. Else /tmp is the default.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.33.8

### get_state

public int get_state() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.2

### get_tmpdir

public String get_tmpdir() throws LibGuestFSException

get the temporary directory

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.58

### get_trace

public boolean get_trace() throws LibGuestFSException

get command trace enabled flag

Return the command trace flag.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.69

### get_umask

public int get_umask() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.3.4

### get_verbose

public boolean get_verbose() throws LibGuestFSException

get verbose mode

This returns the verbose messages flag.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.3

### getcon

@Deprecated public String getcon() throws LibGuestFSException
Deprecated.
In new code, use `selinux_relabel(String, String, Map)` instead

get SELinux security context

This gets the SELinux security context of the daemon.

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

This function depends on the feature "selinux". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.67

### getxattr

public String getxattr(String path, String name) throws LibGuestFSException

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

This function depends on the feature "linuxxattrs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.7.24

### getxattrs

public XAttr[] getxattrs(String path) throws LibGuestFSException

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

This function depends on the feature "linuxxattrs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.59

### glob_expand

public String[] glob_expand(String pattern, Map<String,Object> optargs) throws LibGuestFSException

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.

"directoryslash" controls whether use the "GLOB_MARK" flag for glob(3), and it defaults to true. It can be explicitly set as off to return no trailing slashes in filenames of directories.

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.

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.0.50

### glob_expand

public String[] glob_expand(String pattern) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### glob_expand_opts

public String[] glob_expand_opts(String pattern, Map<String,Object> optargs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### glob_expand_opts

public String[] glob_expand_opts(String pattern) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### grep

public String[] grep(String regex, String path, Map<String,Object> optargs) throws LibGuestFSException

return lines matching a pattern

This calls the external grep(1) 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(1) instead of grep(1). This allows the input to be compress- or gzip-compressed.

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.0.66

### grep

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

Throws:
  `LibGuestFSException`

### grep_opts

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

Throws:
  `LibGuestFSException`

### grep_opts

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

Throws:
  `LibGuestFSException`

### grepi

@Deprecated public String[] grepi(String regex, String path) throws LibGuestFSException
Deprecated.
In new code, use `grep(String, String, Map)` instead

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### grub_install

public void grub_install(String root, String device) throws LibGuestFSException

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

This function depends on the feature "grub". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.17

### head

public String[] head(String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.54

### head_n

public String[] head_n(int nrlines, String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.54

### hexdump

public String hexdump(String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.22

### hivex_close

public void hivex_close() throws LibGuestFSException

close the current hivex handle

Close the current hivex handle.

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

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.35

### hivex_commit

public void hivex_commit(String filename) throws LibGuestFSException

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.

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.35

### hivex_node_add_child

public long hivex_node_add_child(long parent, String name) throws LibGuestFSException

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.

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.35

### hivex_node_children

public HivexNode[] hivex_node_children(long nodeh) throws LibGuestFSException

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.

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.35

### hivex_node_delete_child

public void hivex_node_delete_child(long nodeh) throws LibGuestFSException

delete a node (recursively)

Delete "nodeh", recursively if necessary.

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

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.35

### hivex_node_get_child

public long hivex_node_get_child(long nodeh, String name) throws LibGuestFSException

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.

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.35

### hivex_node_get_value

public long hivex_node_get_value(long nodeh, String key) throws LibGuestFSException

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.

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.35

### hivex_node_name

public String hivex_node_name(long nodeh) throws LibGuestFSException

return the name of the node

Return the name of "nodeh".

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

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.35

### hivex_node_parent

public long hivex_node_parent(long nodeh) throws LibGuestFSException

return the parent of node

Return the parent node of "nodeh".

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

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.35

### hivex_node_set_value

public void hivex_node_set_value(long nodeh, String key, long t, byte[] val) throws LibGuestFSException

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.

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.35

### hivex_node_values

public HivexValue[] hivex_node_values(long nodeh) throws LibGuestFSException

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.

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.35

### hivex_open

public void hivex_open(String filename, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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.

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.35

### hivex_open

public void hivex_open(String filename) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### hivex_root

public long hivex_root() throws LibGuestFSException

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.

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.35

### hivex_value_key

public String hivex_value_key(long valueh) throws LibGuestFSException

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.

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.35

### hivex_value_string

public String hivex_value_string(long valueh) throws LibGuestFSException

return the data field as a UTF-8 string

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.

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.37.22

### hivex_value_type

public long hivex_value_type(long valueh) throws LibGuestFSException

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.

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.35

### hivex_value_utf8

@Deprecated public String hivex_value_utf8(long valueh) throws LibGuestFSException
Deprecated.
In new code, use `hivex_value_string(long)` instead

return the data field as a UTF-8 string

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.

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.35

### hivex_value_value

public String hivex_value_value(long valueh) throws LibGuestFSException

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

This function depends on the feature "hivex". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.35

### initrd_cat

public String initrd_cat(String initrdpath, String filename) throws LibGuestFSException

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-<version>.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` - If there is a libguestfs error.
Since:
  1.0.84

### initrd_list

public String[] initrd_list(String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.54

### inotify_add_watch

public long inotify_add_watch(String path, int mask) throws LibGuestFSException

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.

This function depends on the feature "inotify". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### inotify_close

public void inotify_close() throws LibGuestFSException

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.

This function depends on the feature "inotify". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### inotify_files

public String[] inotify_files() throws LibGuestFSException

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.

This function depends on the feature "inotify". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### inotify_init

public void inotify_init(int maxevents) throws LibGuestFSException

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.

This function depends on the feature "inotify". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### inotify_read

public INotifyEvent[] inotify_read() throws LibGuestFSException

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.

This function depends on the feature "inotify". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### inotify_rm_watch

public void inotify_rm_watch(int wd) throws LibGuestFSException

remove an inotify watch

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

This function depends on the feature "inotify". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### inspect_get_arch

public String inspect_get_arch(String root) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.5.3

### inspect_get_build_id

public String inspect_get_build_id(String root) throws LibGuestFSException

get the system build ID

This returns the build ID of the system, or the string "unknown" if the system does not have a build ID.

For Windows, this gets the build number. Although it is returned as a string, it is (so far) always a number. See <https://en.wikipedia.org/wiki/List_of_Microsoft_Windows _versions> for some possible values.

For Linux, this returns the "BUILD_ID" string from /etc/os-release, although this is not often used.

Please read "INSPECTION" in guestfs(3) for more details.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.49.8

### inspect_get_distro

public String inspect_get_distro(String root) throws LibGuestFSException

get distro of inspected operating system

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

Currently defined distros are:

"alpinelinux" Alpine Linux.

"altlinux" ALT Linux.

"archlinux" Arch Linux.

"buildroot" Buildroot-derived distro, but not one we specifically recognize.

"centos" CentOS.

"circle" Circle Linux.

"cirros" Cirros.

"coreos" CoreOS.

"debian" Debian.

"fedora" Fedora.

"freebsd" FreeBSD.

"freedos" FreeDOS.

"frugalware" Frugalware.

"gentoo" Gentoo.

"kalilinux" Kali Linux.

"kylin" Kylin.

"linuxmint" Linux Mint.

"mageia" Mageia.

"mandriva" Mandriva.

"meego" MeeGo.

"msdos" Microsoft DOS.

"neokylin" NeoKylin.

"netbsd" NetBSD.

"openbsd" OpenBSD.

"openeuler" openEuler.

"openmandriva" OpenMandriva Lx.

"opensuse" OpenSUSE.

"oraclelinux" Oracle Linux.

"pardus" Pardus.

"pldlinux" PLD Linux.

"redhat-based" Some Red Hat-derived distro.

"rhel" Red Hat Enterprise Linux.

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

"voidlinux" Void Linux.

"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` - If there is a libguestfs error.
Since:
  1.5.3

### inspect_get_drive_mappings

public Map<String,String> inspect_get_drive_mappings(String root) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.9.17

### inspect_get_filesystems

public String[] inspect_get_filesystems(String root) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.5.3

### inspect_get_format

@Deprecated public String inspect_get_format(String root) throws LibGuestFSException
Deprecated.
There is no documented replacement

get format of inspected operating system

Before libguestfs 1.38, there was some unreliable support for detecting installer CDs. This API would return:

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

In libguestfs ≥ 1.38, this only returns "installed". Use libosinfo directly to detect installer CDs.

Please read "INSPECTION" in guestfs(3) for more details.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.9.4

### inspect_get_hostname

public String inspect_get_hostname(String root) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.7.9

### inspect_get_icon

public String inspect_get_icon(String root, Map<String,Object> optargs) throws LibGuestFSException

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(1) program from the "icoutils" package, and several programs (bmptopnm(1), pnmtopng(1), pamcut(1)) 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<String,Object> 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` - If there is a libguestfs error.
Since:
  1.11.12

### inspect_get_icon

public String inspect_get_icon(String root) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### inspect_get_major_version

public int inspect_get_major_version(String root) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.5.3

### inspect_get_minor_version

public int inspect_get_minor_version(String root) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.5.3

### inspect_get_mountpoints

public Map<String,String> inspect_get_mountpoints(String root) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.5.3

### inspect_get_osinfo

public String inspect_get_osinfo(String root) throws LibGuestFSException

get a possible osinfo short ID corresponding to this operating system

This function returns a possible short ID for libosinfo corresponding to the guest.

*Note:* The returned ID is only a guess by libguestfs, and nothing ensures that it actually exists in osinfo-db.

If no ID could not be determined, then the string "unknown" is returned.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.39.1

### inspect_get_package_format

public String inspect_get_package_format(String root) throws LibGuestFSException

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" or "dnf" (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", "apk", "xbps". Future versions of libguestfs may return other strings.

Please read "INSPECTION" in guestfs(3) for more details.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.7.5

### inspect_get_package_management

public String inspect_get_package_management(String root) throws LibGuestFSException

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" or "dnf" (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", "dnf", "up2date", "apt" (for all Debian derivatives), "portage", "pisi", "pacman", "urpmi", "zypper", "apk", "xbps". Future versions of libguestfs may return other strings.

Please read "INSPECTION" in guestfs(3) for more details.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.7.5

### inspect_get_product_name

public String inspect_get_product_name(String root) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.5.3

### inspect_get_product_variant

public String inspect_get_product_variant(String root) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.9.13

### inspect_get_roots

public String[] inspect_get_roots() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.7.3

### inspect_get_type

public String inspect_get_type(String root) throws LibGuestFSException

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.

"minix" MINIX.

"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` - If there is a libguestfs error.
Since:
  1.5.3

### inspect_get_windows_current_control_set

public String inspect_get_windows_current_control_set(String root) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.9.17

### inspect_get_windows_group_policy

public boolean inspect_get_windows_group_policy(String root) throws LibGuestFSException

return if Windows guest has group policy

This returns true if the Windows guest has group policy. Group policy can interfere with device driver installation, preventing libguestfs features like driver injection from working.

Note that the presence of group policy is only an indication that there may be a problem with driver installation. As group policy is extremely complex and covers many different aspects of Windows configuration, and we make no attempt to parse it, presence of group policy should only raise a warning.

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` - If there is a libguestfs error.
Since:
  1.57.6

### inspect_get_windows_software_hive

public String inspect_get_windows_software_hive(String root) throws LibGuestFSException

get the path of the Windows software hive

This returns the path to the hive (binary Windows Registry file) corresponding to HKLM\SOFTWARE.

This call assumes that the guest is Windows and that the guest has a software hive file with the right name. If this is not the case then an error is returned. This call does not check that the hive is a valid Windows Registry hive.

You can use "g.hivex_open" to read or write to the hive.

Please read "INSPECTION" in guestfs(3) for more details.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.35.26

### inspect_get_windows_system_hive

public String inspect_get_windows_system_hive(String root) throws LibGuestFSException

get the path of the Windows system hive

This returns the path to the hive (binary Windows Registry file) corresponding to HKLM\SYSTEM.

This call assumes that the guest is Windows and that the guest has a system hive file with the right name. If this is not the case then an error is returned. This call does not check that the hive is a valid Windows Registry hive.

You can use "g.hivex_open" to read or write to the hive.

Please read "INSPECTION" in guestfs(3) for more details.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.35.26

### inspect_get_windows_systemroot

public String inspect_get_windows_systemroot(String root) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.5.25

### inspect_is_live

@Deprecated public boolean inspect_is_live(String root) throws LibGuestFSException
Deprecated.
There is no documented replacement

get live flag for install disk

This is deprecated and always returns "false".

Please read "INSPECTION" in guestfs(3) for more details.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.9.4

### inspect_is_multipart

@Deprecated public boolean inspect_is_multipart(String root) throws LibGuestFSException
Deprecated.
There is no documented replacement

get multipart flag for install disk

This is deprecated and always returns "false".

Please read "INSPECTION" in guestfs(3) for more details.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.9.4

### inspect_is_netinst

@Deprecated public boolean inspect_is_netinst(String root) throws LibGuestFSException
Deprecated.
There is no documented replacement

get netinst (network installer) flag for install disk

This is deprecated and always returns "false".

Please read "INSPECTION" in guestfs(3) for more details.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.9.4

### inspect_list_applications

@Deprecated public Application[] inspect_list_applications(String root) throws LibGuestFSException
Deprecated.
In new code, use `inspect_list_applications2(String)` instead

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.7.8

### inspect_list_applications2

public Application2[] inspect_list_applications2(String root) throws LibGuestFSException

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

"app2_class" Classification or primary use of this application. Currently the only defined classification is "antivirus" for Windows antivirus software. If unknown this is returned as an empty string "".

Please read "INSPECTION" in guestfs(3) for more details.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.56

### inspect_os

public String[] inspect_os() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.5.3

### internal_exit

public void internal_exit() throws LibGuestFSException

Throws:
  `LibGuestFSException`

### 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) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test

public void internal_test(String str, String optstr, String[] strlist, boolean b, int integer, long integer64, String filein, String fileout, byte[] bufferin) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_63_optargs

public void internal_test_63_optargs(Map<String,Object> optargs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_63_optargs

public void internal_test_63_optargs() throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_close_output

public void internal_test_close_output() throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_only_optargs

public void internal_test_only_optargs(Map<String,Object> optargs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_only_optargs

public void internal_test_only_optargs() throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rbool

public boolean internal_test_rbool(String val) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rboolerr

public boolean internal_test_rboolerr() throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rbufferout

public String internal_test_rbufferout(String val) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rbufferouterr

public String internal_test_rbufferouterr() throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rconstoptstring

public String internal_test_rconstoptstring(String val) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rconstoptstringerr

public String internal_test_rconstoptstringerr() throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rconststring

public String internal_test_rconststring(String val) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rconststringerr

public String internal_test_rconststringerr() throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rhashtable

public Map<String,String> internal_test_rhashtable(String val) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rhashtableerr

public Map<String,String> internal_test_rhashtableerr() throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rint

public int internal_test_rint(String val) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rint64

public long internal_test_rint64(String val) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rint64err

public long internal_test_rint64err() throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rinterr

public int internal_test_rinterr() throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rstring

public String internal_test_rstring(String val) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rstringerr

public String internal_test_rstringerr() throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rstringlist

public String[] internal_test_rstringlist(String val) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rstringlisterr

public String[] internal_test_rstringlisterr() throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rstruct

public PV internal_test_rstruct(String val) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rstructerr

public PV internal_test_rstructerr() throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rstructlist

public PV[] internal_test_rstructlist(String val) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_rstructlisterr

public PV[] internal_test_rstructlisterr() throws LibGuestFSException

Throws:
  `LibGuestFSException`

### internal_test_set_output

public void internal_test_set_output(String filename) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_blockdev

public boolean is_blockdev(String path, Map<String,Object> optargs) throws LibGuestFSException

test if block device

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

If the optional flag "followsymlinks" is true, then a symlink (or chain of symlinks) that ends with a block device also causes the function to return true.

This call only looks at files within the guest filesystem. Libguestfs partitions and block devices (eg. /dev/sda) cannot be used as the "path" parameter of this call.

See also "g.stat".

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.5.10

### is_blockdev

public boolean is_blockdev(String path) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_blockdev_opts

public boolean is_blockdev_opts(String path, Map<String,Object> optargs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_blockdev_opts

public boolean is_blockdev_opts(String path) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_busy

public boolean is_busy() throws LibGuestFSException

is busy processing a command

This always returns false. This function is deprecated with no replacement. Do not use this function.

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.2

### is_chardev

public boolean is_chardev(String path, Map<String,Object> optargs) throws LibGuestFSException

test if character device

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

If the optional flag "followsymlinks" is true, then a symlink (or chain of symlinks) that ends with a chardev also causes the function to return true.

See also "g.stat".

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.5.10

### is_chardev

public boolean is_chardev(String path) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_chardev_opts

public boolean is_chardev_opts(String path, Map<String,Object> optargs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_chardev_opts

public boolean is_chardev_opts(String path) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_config

public boolean is_config() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.2

### is_dir

public boolean is_dir(String path, Map<String,Object> optargs) throws LibGuestFSException

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.

If the optional flag "followsymlinks" is true, then a symlink (or chain of symlinks) that ends with a directory also causes the function to return true.

See also "g.stat".

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  0.8

### is_dir

public boolean is_dir(String path) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_dir_opts

public boolean is_dir_opts(String path, Map<String,Object> optargs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_dir_opts

public boolean is_dir_opts(String path) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_fifo

public boolean is_fifo(String path, Map<String,Object> optargs) throws LibGuestFSException

test if FIFO (named pipe)

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

If the optional flag "followsymlinks" is true, then a symlink (or chain of symlinks) that ends with a FIFO also causes the function to return true.

See also "g.stat".

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.5.10

### is_fifo

public boolean is_fifo(String path) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_fifo_opts

public boolean is_fifo_opts(String path, Map<String,Object> optargs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_fifo_opts

public boolean is_fifo_opts(String path) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_file

public boolean is_file(String path, Map<String,Object> optargs) throws LibGuestFSException

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.

If the optional flag "followsymlinks" is true, then a symlink (or chain of symlinks) that ends with a file also causes the function to return true.

See also "g.stat".

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  0.8

### is_file

public boolean is_file(String path) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_file_opts

public boolean is_file_opts(String path, Map<String,Object> optargs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_file_opts

public boolean is_file_opts(String path) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_launching

public boolean is_launching() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.2

### is_lv

public boolean is_lv(String mountable) throws LibGuestFSException

test if mountable is a logical volume

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.5.3

### is_ready

public boolean is_ready() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.2

### is_socket

public boolean is_socket(String path, Map<String,Object> optargs) throws LibGuestFSException

test if socket

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

If the optional flag "followsymlinks" is true, then a symlink (or chain of symlinks) that ends with a socket also causes the function to return true.

See also "g.stat".

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.5.10

### is_socket

public boolean is_socket(String path) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_socket_opts

public boolean is_socket_opts(String path, Map<String,Object> optargs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_socket_opts

public boolean is_socket_opts(String path) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### is_symlink

public boolean is_symlink(String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.5.10

### is_whole_device

public boolean is_whole_device(String device) throws LibGuestFSException

test if a device is a whole device

This returns "true" if and only if "device" refers to a whole block device. That is, not a partition or a logical device.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.21.9

### is_zero

public boolean is_zero(String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.11.8

### is_zero_device

public boolean is_zero_device(String device) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.11.8

### isoinfo

public ISOInfo isoinfo(String isofile) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.17.19

### isoinfo_device

public ISOInfo isoinfo_device(String device) throws LibGuestFSException

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 <https://wiki.osdev.org/ISO_9660#The_Primary_Volume_Desc riptor>

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.19

### journal_close

public void journal_close() throws LibGuestFSException

close the systemd journal

Close the journal handle.

This function depends on the feature "journal". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.23.11

### journal_get

public XAttr[] journal_get() throws LibGuestFSException

read the current journal entry

Read the current journal entry. This returns all the fields in the journal as a set of "(attrname, attrval)" pairs. The "attrname" is the field name (a string).

The "attrval" is the field value (a binary blob, often but not always a string). Please note that "attrval" is a byte array, *not* a \0-terminated C string.

The length of data may be truncated to the data threshold (see: "g.journal_set_data_threshold", "g.journal_get_data_threshold").

If you set the data threshold to unlimited (0) then this call can read a journal entry of any size, ie. it is not limited by the libguestfs protocol.

This function depends on the feature "journal". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.23.11

### journal_get_data_threshold

public long journal_get_data_threshold() throws LibGuestFSException

get the data threshold for reading journal entries

Get the current data threshold for reading journal entries. This is a hint to the journal that it may truncate data fields to this size when reading them (note also that it may not truncate them). If this returns 0, then the threshold is unlimited.

See also "g.journal_set_data_threshold".

This function depends on the feature "journal". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.23.11

### journal_get_realtime_usec

public long journal_get_realtime_usec() throws LibGuestFSException

get the timestamp of the current journal entry

Get the realtime (wallclock) timestamp of the current journal entry.

This function depends on the feature "journal". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.27.18

### journal_next

public boolean journal_next() throws LibGuestFSException

move to the next journal entry

Move to the next journal entry. You have to call this at least once after opening the handle before you are able to read data.

The returned boolean tells you if there are any more journal records to read. "true" means you can read the next record (eg. using "g.journal_get"), and "false" means you have reached the end of the journal.

This function depends on the feature "journal". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.23.11

### journal_open

public void journal_open(String directory) throws LibGuestFSException

open the systemd journal

Open the systemd journal located in directory. Any previously opened journal handle is closed.

The contents of the journal can be read using "g.journal_next" and "g.journal_get".

After you have finished using the journal, you should close the handle by calling "g.journal_close".

This function depends on the feature "journal". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.23.11

### journal_set_data_threshold

public void journal_set_data_threshold(long threshold) throws LibGuestFSException

set the data threshold for reading journal entries

Set the data threshold for reading journal entries. This is a hint to the journal that it may truncate data fields to this size when reading them (note also that it may not truncate them). If you set this to 0, then the threshold is unlimited.

See also "g.journal_get_data_threshold".

This function depends on the feature "journal". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.23.11

### journal_skip

public long journal_skip(long skip) throws LibGuestFSException

skip forwards or backwards in the journal

Skip forwards ("skip ≥ 0") or backwards ("skip < 0") in the journal.

The number of entries actually skipped is returned (note "rskip ≥ 0"). If this is not the same as the absolute value of the skip parameter ("|skip|") you passed in then it means you have reached the end or the start of the journal.

This function depends on the feature "journal". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.23.11

### kill_subprocess

@Deprecated public void kill_subprocess() throws LibGuestFSException
Deprecated.
In new code, use `shutdown()` instead

kill the hypervisor

This kills the hypervisor.

Do not call this. See: "g.shutdown" instead.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.3

### launch

public void launch() throws LibGuestFSException

launch the backend

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` - If there is a libguestfs error.
Since:
  0.3

### lchown

public void lchown(int owner, int group, String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.77

### ldmtool_create_all

public void ldmtool_create_all() throws LibGuestFSException

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.

This function depends on the feature "ldm". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.20.0

### ldmtool_diskgroup_disks

public String[] ldmtool_diskgroup_disks(String diskgroup) throws LibGuestFSException

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

This function depends on the feature "ldm". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.20.0

### ldmtool_diskgroup_name

public String ldmtool_diskgroup_name(String diskgroup) throws LibGuestFSException

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

This function depends on the feature "ldm". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.20.0

### ldmtool_diskgroup_volumes

public String[] ldmtool_diskgroup_volumes(String diskgroup) throws LibGuestFSException

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

This function depends on the feature "ldm". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.20.0

### ldmtool_remove_all

public void ldmtool_remove_all() throws LibGuestFSException

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

This function depends on the feature "ldm". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.20.0

### ldmtool_scan

public String[] ldmtool_scan() throws LibGuestFSException

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.

This function depends on the feature "ldm". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.20.0

### ldmtool_scan_devices

public String[] ldmtool_scan_devices(String[] devices) throws LibGuestFSException

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.

This function depends on the feature "ldm". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.20.0

### ldmtool_volume_hint

public String ldmtool_volume_hint(String diskgroup, String volume) throws LibGuestFSException

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

This function depends on the feature "ldm". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.20.0

### ldmtool_volume_partitions

public String[] ldmtool_volume_partitions(String diskgroup, String volume) throws LibGuestFSException

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

This function depends on the feature "ldm". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.20.0

### ldmtool_volume_type

public String ldmtool_volume_type(String diskgroup, String volume) throws LibGuestFSException

return the type of a Windows dynamic disk volume

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

Possible volume types that can be returned here include: "simple", "spanned", "striped", "mirrored", "raid5". Other types may also be returned.

This function depends on the feature "ldm". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.20.0

### lgetxattr

public String lgetxattr(String path, String name) throws LibGuestFSException

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

This function depends on the feature "linuxxattrs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.7.24

### lgetxattrs

public XAttr[] lgetxattrs(String path) throws LibGuestFSException

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.

This function depends on the feature "linuxxattrs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.59

### list_9p

@Deprecated public String[] list_9p() throws LibGuestFSException
Deprecated.
There is no documented replacement

list 9p filesystems

This call does nothing and returns an error.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.11.12

### list_devices

public String[] list_devices() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.4

### list_disk_labels

public Map<String,String> list_disk_labels() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.49

### list_dm_devices

public String[] list_dm_devices() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.11.15

### list_filesystems

public Map<String,String> list_filesystems() throws LibGuestFSException

list filesystems

This inspection command looks for filesystems on partitions, block devices and logical volumes, returning a list of "mountables" 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 key is not necessarily a block device. It may also be an opaque ‘mountable’ string which can be passed to "g.mount".

The value can have the special value "unknown", meaning the content of the device is undetermined or empty. "swap" means a Linux swap partition.

In libguestfs ≤ 1.36 this command ran other libguestfs commands, which might have included "g.mount" and "g.umount", and therefore you had to use this soon after launch and only when nothing else was mounted. This restriction is removed in libguestfs ≥ 1.38.

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` - If there is a libguestfs error.
Since:
  1.5.15

### list_ldm_partitions

public String[] list_ldm_partitions() throws LibGuestFSException

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.

This function depends on the feature "ldm". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.20.0

### list_ldm_volumes

public String[] list_ldm_volumes() throws LibGuestFSException

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.

This function depends on the feature "ldm". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.20.0

### list_md_devices

public String[] list_md_devices() throws LibGuestFSException

list Linux md (RAID) devices

List all Linux md devices.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.15.4

### list_partitions

public String[] list_partitions() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.4

### ll

public String ll(String directory) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.4

### llz

@Deprecated public String llz(String directory) throws LibGuestFSException
Deprecated.
In new code, use `lgetxattrs(String)` instead

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` - If there is a libguestfs error.
Since:
  1.17.6

### ln

public void ln(String target, String linkname) throws LibGuestFSException

create a hard link

This command creates a hard link.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### ln_f

public void ln_f(String target, String linkname) throws LibGuestFSException

create a hard link

This command creates a hard link, removing the link "linkname" if it exists already.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### ln_s

public void ln_s(String target, String linkname) throws LibGuestFSException

create a symbolic link

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### ln_sf

public void ln_sf(String target, String linkname) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.66

### lremovexattr

public void lremovexattr(String xattr, String path) throws LibGuestFSException

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.

This function depends on the feature "linuxxattrs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.59

### ls

public String[] ls(String directory) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.4

### ls0

public void ls0(String dir, String filenames) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.32

### lsetxattr

public void lsetxattr(String xattr, String val, int vallen, String path) throws LibGuestFSException

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.

This function depends on the feature "linuxxattrs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.59

### lstat

@Deprecated public Stat lstat(String path) throws LibGuestFSException
Deprecated.
In new code, use `lstatns(String)` instead

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` - If there is a libguestfs error.
Since:
  1.9.2

### lstatlist

@Deprecated public Stat[] lstatlist(String path, String[] names) throws LibGuestFSException
Deprecated.
In new code, use `lstatnslist(String, String[])` instead

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 "st_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` - If there is a libguestfs error.
Since:
  1.0.77

### lstatns

public StatNS lstatns(String path) throws LibGuestFSException

get file information for a symbolic link

Returns file information for the given "path".

This is the same as "g.statns" 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` - If there is a libguestfs error.
Since:
  1.27.53

### lstatnslist

public StatNS[] lstatnslist(String path, String[] names) throws LibGuestFSException

lstat on multiple files

This call allows you to perform the "g.lstatns" 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 "st_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` - If there is a libguestfs error.
Since:
  1.27.53

### luks_add_key

public void luks_add_key(String device, String key, String newkey, int keyslot) throws LibGuestFSException

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.

This function depends on the feature "luks". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.5.2

### luks_close

@Deprecated public void luks_close(String device) throws LibGuestFSException
Deprecated.
In new code, use `cryptsetup_close(String)` instead

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.

This function depends on the feature "luks". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.5.1

### luks_format

public void luks_format(String device, String key, int keyslot) throws LibGuestFSException

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 "keyslot". (LUKS supports 8 key slots, numbered 0-7).

This function depends on the feature "luks". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.5.2

### luks_format_cipher

public void luks_format_cipher(String device, String key, int keyslot, String cipher) throws LibGuestFSException

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.

This function depends on the feature "luks". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.5.2

### luks_kill_slot

public void luks_kill_slot(String device, String key, int keyslot) throws LibGuestFSException

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.

This function depends on the feature "luks". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.5.2

### luks_open

@Deprecated public void luks_open(String device, String key, String mapname) throws LibGuestFSException
Deprecated.
In new code, use `cryptsetup_open(String, String, String, Map)` instead

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.lvm_scan" with the "activate" parameter "true" will make them visible.

Use "g.list_dm_devices" to list all device mapper devices.

This function depends on the feature "luks". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.5.1

### luks_open_ro

@Deprecated public void luks_open_ro(String device, String key, String mapname) throws LibGuestFSException
Deprecated.
In new code, use `cryptsetup_open(String, String, String, Map)` instead

open a LUKS-encrypted block device read-only

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

This function depends on the feature "luks". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.5.1

### luks_uuid

public String luks_uuid(String device) throws LibGuestFSException

get the UUID of a LUKS device

This returns the UUID of the LUKS device "device".

This function depends on the feature "luks". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.41.9

### lvcreate

public void lvcreate(String logvol, String volgroup, int mbytes) throws LibGuestFSException

create an LVM logical volume

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

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.8

### lvcreate_free

public void lvcreate_free(String logvol, String volgroup, int percent) throws LibGuestFSException

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.

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.18

### lvm_canonical_lv_name

public String lvm_canonical_lv_name(String lvname) throws LibGuestFSException

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. In this case errno will be set to "EINVAL".

See also "g.is_lv", "g.canonical_device_name".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.5.24

### lvm_clear_filter

public void lvm_clear_filter() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.5.1

### lvm_remove_all

public void lvm_remove_all() throws LibGuestFSException

remove all LVM LVs, VGs and PVs

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

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.8

### lvm_scan

public void lvm_scan(boolean activate) throws LibGuestFSException

scan for LVM physical volumes, volume groups and logical volumes

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

If the "activate" parameter is "true" then newly found volume groups and logical volumes are activated, meaning the LV /dev/VG/LV devices become visible.

When a libguestfs handle is launched it scans for existing devices, so you do not normally need to use this API. However it is useful when you have added a new device or deleted an existing device (such as when the "g.luks_open" API is used).

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.39.8

### lvm_set_filter

public void lvm_set_filter(String[] devices) throws LibGuestFSException

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.

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.5.1

### lvremove

public void lvremove(String device) throws LibGuestFSException

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.

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.13

### lvrename

public void lvrename(String logvol, String newlogvol) throws LibGuestFSException

rename an LVM logical volume

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.83

### lvresize

public void lvresize(String device, int mbytes) throws LibGuestFSException

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.

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.27

### lvresize_free

public void lvresize_free(String lv, int percent) throws LibGuestFSException

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.

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.3.3

### lvs

public String[] lvs() throws LibGuestFSException

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

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.4

### lvs_full

public LV[] lvs_full() throws LibGuestFSException

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.

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.4

### lvuuid

public String lvuuid(String device) throws LibGuestFSException

get the UUID of a logical volume

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.87

### lxattrlist

public XAttr[] lxattrlist(String path, String[] names) throws LibGuestFSException

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

This function depends on the feature "linuxxattrs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.77

### max_disks

public int max_disks() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.7

### md_create

public void md_create(String name, String[] devices, Map<String,Object> optargs) throws LibGuestFSException

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 "[<missing>, "/dev/sda"]".

If "devices = ["/dev/sda"]" and "missingbitmap = 0x2" then the resulting array would be "["/dev/sda", <missing>]".

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.

The "chunk" parameter does not make sense, and should not be specified, when "level" is "raid1" (which is the default; see below).

"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<String,Object> 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.

This function depends on the feature "mdadm". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.15.6

### md_create

public void md_create(String name, String[] devices) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### md_detail

public Map<String,String> md_detail(String md) throws LibGuestFSException

obtain metadata for an MD device

This command exposes the output of "mdadm -DY <md>". 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.

This function depends on the feature "mdadm". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.15.6

### md_stat

public MDStat[] md_stat(String md) throws LibGuestFSException

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

This function depends on the feature "mdadm". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.21

### md_stop

public void md_stop(String md) throws LibGuestFSException

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.

This function depends on the feature "mdadm". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.15.6

### mkdir

public void mkdir(String path) throws LibGuestFSException

create a directory

Create a directory named "path".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.8

### mkdir_mode

public void mkdir_mode(String path, int mode) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.77

### mkdir_p

public void mkdir_p(String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.8

### mkdtemp

public String mkdtemp(String tmpl) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.54

### mke2fs

public void mke2fs(String device, Map<String,Object> optargs) throws LibGuestFSException

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". Note if the filesystem is too small to contain a journal, "mke2fs" will silently create an ext2 filesystem instead.

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.19.44

### mke2fs

public void mke2fs(String device) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### mke2fs_J

@Deprecated public void mke2fs_J(String fstype, int blocksize, String device, String journal) throws LibGuestFSException
Deprecated.
In new code, use `mke2fs(String, Map)` instead

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=<journal> <device>

See also "g.mke2journal".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.68

### mke2fs_JL

@Deprecated public void mke2fs_JL(String fstype, int blocksize, String device, String label) throws LibGuestFSException
Deprecated.
In new code, use `mke2fs(String, Map)` instead

make ext2/3/4 filesystem with external journal

This creates an ext2/3/4 filesystem on "device" with an external journal on the journal labeled "label".

See also "g.mke2journal_L".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.68

### mke2fs_JU

@Deprecated public void mke2fs_JU(String fstype, int blocksize, String device, String uuid) throws LibGuestFSException
Deprecated.
In new code, use `mke2fs(String, Map)` instead

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 depends on the feature "linuxfsuuid". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.68

### mke2journal

@Deprecated public void mke2journal(int blocksize, String device) throws LibGuestFSException
Deprecated.
In new code, use `mke2fs(String, Map)` instead

make ext2/3/4 external journal

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

mke2fs -O journal_dev -b blocksize device

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.68

### mke2journal_L

@Deprecated public void mke2journal_L(int blocksize, String label, String device) throws LibGuestFSException
Deprecated.
In new code, use `mke2fs(String, Map)` instead

make ext2/3/4 external journal with label

This creates an ext2 external journal on "device" with label "label".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.68

### mke2journal_U

@Deprecated public void mke2journal_U(int blocksize, String uuid, String device) throws LibGuestFSException
Deprecated.
In new code, use `mke2fs(String, Map)` instead

make ext2/3/4 external journal with UUID

This creates an ext2 external journal on "device" with UUID "uuid".

This function depends on the feature "linuxfsuuid". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.68

### mkfifo

public void mkfifo(int mode, String path) throws LibGuestFSException

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

Unlike with "g.mknod", "mode" must contain only permissions bits.

The mode actually set is affected by the umask.

This function depends on the feature "mknod". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.55

### mkfs

public void mkfs(String fstype, String device, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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` - If there is a libguestfs error.
Since:
  0.8

### mkfs

public void mkfs(String fstype, String device) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### mkfs_opts

public void mkfs_opts(String fstype, String device, Map<String,Object> optargs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### mkfs_opts

public void mkfs_opts(String fstype, String device) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### mkfs_b

@Deprecated public void mkfs_b(String fstype, int blocksize, String device) throws LibGuestFSException
Deprecated.
In new code, use `mkfs(String, String, Map)` instead

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.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.68

### mkfs_btrfs

public void mkfs_btrfs(String[] devices, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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.

This function depends on the feature "btrfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.25

### mkfs_btrfs

public void mkfs_btrfs(String[] devices) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### mklost_and_found

public void mklost_and_found(String mountpoint) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.56

### mkmountpoint

public void mkmountpoint(String exemptpath) throws LibGuestFSException

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 <https://bugzilla.redhat.com/show_bug.cgi?id=599503>

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` - If there is a libguestfs error.
Since:
  1.0.62

### mknod

public void mknod(int mode, int devmajor, int devminor, String path) throws LibGuestFSException

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.

This function depends on the feature "mknod". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.55

### mknod_b

public void mknod_b(int mode, int devmajor, int devminor, String path) throws LibGuestFSException

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

Unlike with "g.mknod", "mode" must contain only permissions bits.

The mode actually set is affected by the umask.

This function depends on the feature "mknod". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.55

### mknod_c

public void mknod_c(int mode, int devmajor, int devminor, String path) throws LibGuestFSException

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

Unlike with "g.mknod", "mode" must contain only permissions bits.

The mode actually set is affected by the umask.

This function depends on the feature "mknod". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.55

### mksquashfs

public void mksquashfs(String path, String filename, Map<String,Object> optargs) throws LibGuestFSException

create a squashfs filesystem

Create a squashfs filesystem for the specified "path".

The optional "compress" flag controls compression. If not given, then the output compressed using "gzip". Otherwise one of the following strings may be given to select the compression type of the squashfs: "gzip", "lzma", "lzo", "lz4", "xz".

The other optional arguments are:

"excludes" A list of wildcards. Files are excluded if they match any of the wildcards.

Please note that this API may fail when used to compress directories with large files, such as the resulting squashfs will be over 3GB big.

Optional arguments are supplied in the final Map<String,Object> 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.

This function depends on the feature "squashfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.35.25

### mksquashfs

public void mksquashfs(String path, String filename) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### mkswap

public void mkswap(String device, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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` - If there is a libguestfs error.
Since:
  1.0.55

### mkswap

public void mkswap(String device) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### mkswap_opts

public void mkswap_opts(String device, Map<String,Object> optargs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### mkswap_opts

public void mkswap_opts(String device) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### mkswap_L

@Deprecated public void mkswap_L(String label, String device) throws LibGuestFSException
Deprecated.
In new code, use `mkswap(String, Map)` instead

create a swap partition with a label

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

Note that you cannot attach a swap label to a block device (eg. /dev/sda), just to a partition. This appears to be a limitation of the kernel or swap tools.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.55

### mkswap_U

@Deprecated public void mkswap_U(String uuid, String device) throws LibGuestFSException
Deprecated.
In new code, use `mkswap(String, Map)` instead

create a swap partition with an explicit UUID

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

This function depends on the feature "linuxfsuuid". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.55

### mkswap_file

public void mkswap_file(String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.66

### mktemp

public String mktemp(String tmpl, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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` - If there is a libguestfs error.
Since:
  1.19.53

### mktemp

public String mktemp(String tmpl) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### modprobe

public void modprobe(String modulename) throws LibGuestFSException

load a kernel module

This loads a kernel module in the appliance.

This function depends on the feature "linuxmodules". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.68

### mount

public void mount(String mountable, String mountpoint) throws LibGuestFSException

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, or ‘mountable’ strings returned by "g.list_filesystems" or "g.inspect_get_mountpoints".

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` - If there is a libguestfs error.
Since:
  0.3

### mount_9p

@Deprecated public void mount_9p(String mounttag, String mountpoint, Map<String,Object> optargs) throws LibGuestFSException
Deprecated.
There is no documented replacement

mount 9p filesystem

This call does nothing and returns an error.

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.11.12

### mount_9p

public void mount_9p(String mounttag, String mountpoint) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### mount_local

public void mount_local(String localmountpoint, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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` - If there is a libguestfs error.
Since:
  1.17.22

### mount_local

public void mount_local(String localmountpoint) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### mount_local_run

public void mount_local_run() throws LibGuestFSException

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.

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` - If there is a libguestfs error.
Since:
  1.17.22

### mount_loop

public void mount_loop(String file, String mountpoint) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.54

### mount_options

public void mount_options(String options, String mountable, String mountpoint) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.10

### mount_ro

public void mount_ro(String mountable, String mountpoint) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.10

### mount_vfs

public void mount_vfs(String options, String vfstype, String mountable, String mountpoint) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.10

### mountable_device

public String mountable_device(String mountable) throws LibGuestFSException

extract the device part of a mountable

Returns the device name of a mountable. In quite a lot of cases, the mountable is the device name.

However this doesn't apply for btrfs subvolumes, where the mountable is a combination of both the device name and the subvolume path (see also "g.mountable_subvolume" to extract the subvolume path of the mountable if any).

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.33.15

### mountable_subvolume

public String mountable_subvolume(String mountable) throws LibGuestFSException

extract the subvolume part of a mountable

Returns the subvolume path of a mountable. Btrfs subvolumes mountables are a combination of both the device name and the subvolume path (see also "g.mountable_device" to extract the device of the mountable).

If the mountable does not represent a btrfs subvolume, then this function fails and the "errno" is set to "EINVAL".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.33.15

### mountpoints

public Map<String,String> mountpoints() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.62

### mounts

public String[] mounts() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.8

### mv

public void mv(String src, String dest) throws LibGuestFSException

move a file

This moves a file from "src" to "dest" where "dest" is either a destination filename or destination directory.

See also: "g.rename".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.18

### nr_devices

public int nr_devices() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.15

### ntfs_3g_probe

public int ntfs_3g_probe(boolean rw, String device) throws LibGuestFSException

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.

This function depends on the feature "ntfs3g". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.43

### ntfs_chmod

public void ntfs_chmod(String device, int mode, String path, Map<String,Object> optargs) throws LibGuestFSException

change file permissions on NTFS filesystem

Change file permissions on an NTFS filesystem with a chmod-style permission mask, using ntfssecaudit(8). 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 "device" parameter is the NTFS partition device (eg. "/dev/sda5"). This must be unmounted. The "mode" parameter is the permission mode (eg. 0744). The "path" parameter is the file or directory path within the filesystem. If the optional "recursive" flag is set, directory permissions are set recursively.

Optional arguments are supplied in the final Map<String,Object> 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.

This function depends on the feature "ntfs3g". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.55.13

### ntfs_chmod

public void ntfs_chmod(String device, int mode, String path) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### ntfscat_i

public void ntfscat_i(String device, long inode, String filename) throws LibGuestFSException

download a file to the local machine given its inode

Download a file given its inode from a NTFS filesystem and save it as filename on the local machine.

This allows to download some otherwise inaccessible files such as the ones within the $Extend folder.

The filesystem from which to extract the file must be unmounted, otherwise the call will fail.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.33.14

### ntfsclone_in

public void ntfsclone_in(String backupfile, String device) throws LibGuestFSException

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.

This function depends on the feature "ntfs3g". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.9

### ntfsclone_out

public void ntfsclone_out(String device, String backupfile, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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.

This function depends on the feature "ntfs3g". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.9

### ntfsclone_out

public void ntfsclone_out(String device, String backupfile) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### ntfsfix

public void ntfsfix(String device, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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.

This function depends on the feature "ntfs3g". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.9

### ntfsfix

public void ntfsfix(String device) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### ntfsresize

public void ntfsresize(String device, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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.

This function depends on the feature "ntfsprogs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.3.2

### ntfsresize

public void ntfsresize(String device) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### ntfsresize_opts

public void ntfsresize_opts(String device, Map<String,Object> optargs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### ntfsresize_opts

public void ntfsresize_opts(String device) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### ntfsresize_size

@Deprecated public void ntfsresize_size(String device, long size) throws LibGuestFSException
Deprecated.
In new code, use `ntfsresize(String, Map)` instead

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 depends on the feature "ntfsprogs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.3.14

### parse_environment

public void parse_environment() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.53

### parse_environment_list

public void parse_environment_list(String[] environment) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.53

### part_add

public void part_add(String device, String prlogex, long startsect, long endsect) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.78

### part_del

public void part_del(String device, int partnum) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.3.2

### part_disk

public void part_disk(String device, String parttype) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.78

### part_expand_gpt

public void part_expand_gpt(String device) throws LibGuestFSException

move backup GPT header to the end of the disk

Move backup GPT data structures to the end of the disk. This is useful in case of in-place image expand since disk space after backup GPT header is not usable. This is equivalent to "sgdisk -e".

See also sgdisk(8).

This function depends on the feature "gdisk". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.33.2

### part_get_bootable

public boolean part_get_bootable(String device, int partnum) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.3.2

### part_get_disk_guid

public String part_get_disk_guid(String device) throws LibGuestFSException

get the GUID of a GPT-partitioned disk

Return the disk identifier (GUID) of a GPT-partitioned "device". Behaviour is undefined for other partition types.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.33.2

### part_get_gpt_attributes

public long part_get_gpt_attributes(String device, int partnum) throws LibGuestFSException

get the attribute flags of a GPT partition

Return the attribute flags of numbered GPT partition "partnum". An error is returned for MBR partitions.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.21.1

### part_get_gpt_guid

public String part_get_gpt_guid(String device, int partnum) throws LibGuestFSException

get the GUID of a GPT partition

Return the GUID of numbered GPT partition "partnum".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.25

### part_get_gpt_type

public String part_get_gpt_type(String device, int partnum) throws LibGuestFSException

get the type GUID of a GPT partition

Return the type GUID of numbered GPT partition "partnum".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.21.1

### part_get_mbr_id

public int part_get_mbr_id(String device, int partnum) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.3.2

### part_get_mbr_part_type

public String part_get_mbr_part_type(String device, int partnum) throws LibGuestFSException

get the MBR partition type

This returns the partition type of an MBR partition numbered "partnum" on device "device".

It returns "primary", "logical", or "extended".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.32

### part_get_name

public String part_get_name(String device, int partnum) throws LibGuestFSException

get partition name

This gets the partition name on partition numbered "partnum" on device "device". Note that partitions are numbered from 1.

The partition name can only be read on certain types of partition table. This works on "gpt" but not on "mbr" partitions.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.25.33

### part_get_parttype

public String part_get_parttype(String device) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.78

### part_init

public void part_init(String device, String parttype) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.78

### part_list

public Partition[] part_list(String device) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.78

### part_resize

public void part_resize(String device, int partnum, long endsect) throws LibGuestFSException

resize a partition

This command resizes the partition numbered "partnum" on "device" by moving the end position.

Note that this does not modify any filesystem present in the partition. If you wish to do this, you will need to use filesystem resizing commands like "g.resize2fs".

When growing a partition you will want to grow the filesystem afterwards, but when shrinking, you need to shrink the filesystem before the partition.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.37.20

### part_set_bootable

public void part_set_bootable(String device, int partnum, boolean bootable) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.78

### part_set_disk_guid

public void part_set_disk_guid(String device, String guid) throws LibGuestFSException

set the GUID of a GPT-partitioned disk

Set the disk identifier (GUID) of a GPT-partitioned "device" to "guid". Return an error if the partition table of "device" isn't GPT, or if "guid" is not a valid GUID.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.33.2

### part_set_disk_guid_random

public void part_set_disk_guid_random(String device) throws LibGuestFSException

set the GUID of a GPT-partitioned disk to random value

Set the disk identifier (GUID) of a GPT-partitioned "device" to a randomly generated value. Return an error if the partition table of "device" isn't GPT.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.33.2

### part_set_gpt_attributes

public void part_set_gpt_attributes(String device, int partnum, long attributes) throws LibGuestFSException

set the attribute flags of a GPT partition

Set the attribute flags of numbered GPT partition "partnum" to "attributes". Return an error if the partition table of "device" isn't GPT.

See <https://en.wikipedia.org/wiki/GUID_Partition_Table#Part ition_entries> for a useful list of partition attributes.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.21.1

### part_set_gpt_guid

public void part_set_gpt_guid(String device, int partnum, String guid) throws LibGuestFSException

set the GUID of a GPT partition

Set the GUID of numbered GPT partition "partnum" to "guid". Return an error if the partition table of "device" isn't GPT, or if "guid" is not a valid GUID.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.25

### part_set_gpt_type

public void part_set_gpt_type(String device, int partnum, String guid) throws LibGuestFSException

set the type GUID of a GPT partition

Set the type GUID of numbered GPT partition "partnum" to "guid". Return an error if the partition table of "device" isn't GPT, or if "guid" is not a valid GUID.

See <https://en.wikipedia.org/wiki/GUID_Partition_Table#Part ition_type_GUIDs> for a useful list of type GUIDs.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.21.1

### part_set_mbr_id

public void part_set_mbr_id(String device, int partnum, int idbyte) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.3.2

### part_set_name

public void part_set_name(String device, int partnum, String name) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.78

### part_to_dev

public String part_to_dev(String partition) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.5.15

### part_to_partnum

public int part_to_partnum(String partition) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.13.25

### ping_daemon

public void ping_daemon() throws LibGuestFSException

ping the guest daemon

This is a test probe into the guestfs daemon running inside the libguestfs appliance. 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` - If there is a libguestfs error.
Since:
  1.0.18

### pread

public String pread(String path, int count, long offset) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.77

### pread_device

public String pread_device(String device, int count, long offset) throws LibGuestFSException

read part of a device

This command lets you read part of a block device. 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` - If there is a libguestfs error.
Since:
  1.5.21

### pvchange_uuid

public void pvchange_uuid(String device) throws LibGuestFSException

generate a new random UUID for a physical volume

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

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.26

### pvchange_uuid_all

public void pvchange_uuid_all() throws LibGuestFSException

generate new random UUIDs for all physical volumes

Generate new random UUIDs for all physical volumes.

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.26

### pvcreate

public void pvcreate(String device) throws LibGuestFSException

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.

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.8

### pvremove

public void pvremove(String device) throws LibGuestFSException

remove an LVM physical volume

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

The implementation uses the pvremove(8) command which refuses to wipe physical volumes that contain any volume groups, so you have to remove those first.

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.13

### pvresize

public void pvresize(String device) throws LibGuestFSException

resize an LVM physical volume

This resizes (expands or shrinks) an existing LVM physical volume to match the new size of the underlying device.

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.26

### pvresize_size

public void pvresize_size(String device, long size) throws LibGuestFSException

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.

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.3.14

### pvs

public String[] pvs() throws LibGuestFSException

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

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.4

### pvs_full

public PV[] pvs_full() throws LibGuestFSException

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.

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.4

### pvuuid

public String pvuuid(String device) throws LibGuestFSException

get the UUID of a physical volume

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.87

### pwrite

public int pwrite(String path, byte[] content, long offset) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.3.14

### pwrite_device

public int pwrite_device(String device, byte[] content, long offset) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.5.20

### read_file

public String read_file(String path) throws LibGuestFSException

read a file

This call 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` - If there is a libguestfs error.
Since:
  1.0.63

### read_lines

public String[] read_lines(String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.7

### readdir

public Dirent[] readdir(String dir) throws LibGuestFSException

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.55

### readlink

public String readlink(String path) throws LibGuestFSException

read the target of a symbolic link

This command reads the target of a symbolic link.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### readlinklist

public String[] readlinklist(String path, String[] names) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.77

### realpath

public String realpath(String path) throws LibGuestFSException

canonicalized absolute pathname

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### remount

public void remount(String mountpoint, Map<String,Object> optargs) throws LibGuestFSException

remount a filesystem with different options

This call allows you to change the "rw" (readonly/read-write) flag on an already mounted filesystem at "mountpoint", converting a readonly filesystem to be read-write, or vice-versa.

Note that at the moment you must supply the "optional" "rw" parameter. In future we may allow other flags to be adjusted.

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.23.2

### remount

public void remount(String mountpoint) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### remove_drive

@Deprecated public void remove_drive(String label) throws LibGuestFSException
Deprecated.
There is no documented replacement

remove a disk image

This call does nothing and returns an error.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.49

### removexattr

public void removexattr(String xattr, String path) throws LibGuestFSException

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

This function depends on the feature "linuxxattrs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.59

### rename

public void rename(String oldpath, String newpath) throws LibGuestFSException

rename a file on the same filesystem

Rename a file to a new place on the same filesystem. This is the same as the Linux rename(2) system call. In most cases you are better to use "g.mv" instead.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.21.5

### resize2fs

public void resize2fs(String device) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.27

### resize2fs_M

public void resize2fs_M(String device) throws LibGuestFSException

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(8) 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` - If there is a libguestfs error.
Since:
  1.9.4

### resize2fs_size

public void resize2fs_size(String device, long size) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.3.14

### rm

public void rm(String path) throws LibGuestFSException

remove a file

Remove the single file "path".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.8

### rm_f

public void rm_f(String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.42

### rm_rf

public void rm_rf(String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.8

### rmdir

public void rmdir(String path) throws LibGuestFSException

remove a directory

Remove the single directory "path".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.8

### rmmountpoint

public void rmmountpoint(String exemptpath) throws LibGuestFSException

remove a mountpoint

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.62

### rsync

public void rsync(String src, String dest, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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.

This function depends on the feature "rsync". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.29

### rsync

public void rsync(String src, String dest) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### rsync_in

public void rsync_in(String remote, String dest, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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.

This function depends on the feature "rsync". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.29

### rsync_in

public void rsync_in(String remote, String dest) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### rsync_out

public void rsync_out(String src, String remote, Map<String,Object> optargs) throws LibGuestFSException

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

Globbing does not happen on the "src" parameter. In programs which use the API directly you have to expand wildcards yourself (see "g.glob_expand"). In guestfish you can use the "glob" command (see "glob" in guestfish(1)), for example:

><fs> glob rsync-out /* rsync://remote/

Optional arguments are supplied in the final Map<String,Object> 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.

This function depends on the feature "rsync". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.29

### rsync_out

public void rsync_out(String src, String remote) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### scrub_device

public void scrub_device(String device) throws LibGuestFSException

scrub (securely wipe) a device

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

It is an interface to the scrub(1) program. See that manual page for more details.

This function depends on the feature "scrub". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.52

### scrub_file

public void scrub_file(String file) throws LibGuestFSException

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.

This function depends on the feature "scrub". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.52

### scrub_freespace

public void scrub_freespace(String dir) throws LibGuestFSException

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.

This function depends on the feature "scrub". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.52

### selinux_relabel

@Deprecated public void selinux_relabel(String specfile, String path, Map<String,Object> optargs) throws LibGuestFSException
Deprecated.
In new code, use `setfiles(String, String[], Map)` instead

relabel parts of the filesystem

SELinux relabel parts of the filesystem.

The "specfile" parameter controls the policy spec file used. You have to parse "/etc/selinux/config" to find the correct SELinux policy and then pass the spec file, usually: "/etc/selinux/" + *selinuxtype* + "/contexts/files/file_contexts".

The required "path" parameter is the top level directory where relabelling starts. Normally you should pass "path" as "/" to relabel the whole guest filesystem.

The optional "force" boolean controls whether the context is reset for customizable files, and also whether the user, role and range parts of the file context is changed.

Optional arguments are supplied in the final Map<String,Object> 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.

This function depends on the feature "selinuxrelabel". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.33.43

### selinux_relabel

public void selinux_relabel(String specfile, String path) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### set_append

public void set_append(String append) throws LibGuestFSException

add options to kernel command line

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

The default is "NULL" unless overridden by setting "LIBGUESTFS_APPEND" environment variable.

Setting "append" to "NULL" means *no* additional options are passed (libguestfs always adds a few of its own).

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.26

### set_attach_method

@Deprecated public void set_attach_method(String backend) throws LibGuestFSException
Deprecated.
In new code, use `set_backend(String)` instead

set the backend

Set the method that libguestfs uses to connect to the backend guestfsd daemon.

See "BACKEND" in guestfs(3).

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.9.8

### set_autosync

public void set_autosync(boolean autosync) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.3

### set_backend

public void set_backend(String backend) throws LibGuestFSException

set the backend

Set the method that libguestfs uses to connect to the backend guestfsd daemon.

This handle property was previously called the "attach method".

See "BACKEND" in guestfs(3).

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.21.26

### set_backend_setting

public void set_backend_setting(String name, String val) throws LibGuestFSException

set a single per-backend settings string

Append "name=value" to the backend settings string list. However if a string already exists matching "name" or beginning with "name=", then that setting is replaced.

See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in guestfs(3).

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.27.2

### set_backend_settings

public void set_backend_settings(String[] settings) throws LibGuestFSException

replace per-backend settings strings

Set a list of zero or more settings which are passed through to the current backend. Each setting is a string which is interpreted in a backend-specific way, or ignored if not understood by the backend.

The default value is an empty list, unless the environment variable "LIBGUESTFS_BACKEND_SETTINGS" was set when the handle was created. This environment variable contains a colon-separated list of settings.

This call replaces all backend settings. If you want to replace a single backend setting, see "g.set_backend_setting". If you want to clear a single backend setting, see "g.clear_backend_setting".

See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in guestfs(3).

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.25.24

### set_cachedir

public void set_cachedir(String cachedir) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.58

### set_direct

@Deprecated public void set_direct(boolean direct) throws LibGuestFSException
Deprecated.
This is replaced by method #internal_get_console_socket which is not exported by the Java bindings

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` - If there is a libguestfs error.
Since:
  1.0.72

### set_e2attrs

public void set_e2attrs(String file, String attrs, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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` - If there is a libguestfs error.
Since:
  1.17.31

### set_e2attrs

public void set_e2attrs(String file, String attrs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### set_e2generation

public void set_e2generation(String file, long generation) throws LibGuestFSException

set ext2 file generation of a file

This sets the ext2 file generation of a file.

See "g.get_e2generation".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.31

### set_e2label

@Deprecated public void set_e2label(String device, String label) throws LibGuestFSException
Deprecated.
In new code, use `set_label(String, String)` instead

set the ext2/3/4 filesystem label

This sets the ext2/3/4 filesystem label of the filesystem on "device" to "label". Filesystem labels are limited to 16 characters.

You can use either "g.tune2fs_l" or "g.get_e2label" to return the existing label on a filesystem.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.15

### set_e2uuid

@Deprecated public void set_e2uuid(String device, String uuid) throws LibGuestFSException
Deprecated.
In new code, use `set_uuid(String, String)` instead

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 "g.vfs_uuid" to return the existing UUID of a filesystem.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.15

### set_hv

public void set_hv(String hv) throws LibGuestFSException

set the hypervisor binary

Set the hypervisor binary that we will use. The hypervisor depends on the backend, but is usually the location of the qemu/KVM hypervisor.

The default is chosen when the library was compiled by the configure script.

You can also override this by setting the "LIBGUESTFS_HV" environment variable.

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_HV" is safest of all since that picks the qemu binary at the same time as the handle is created.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.23.17

### set_identifier

public void set_identifier(String identifier) throws LibGuestFSException

set the handle identifier

This is an informative string which the caller may optionally set in the handle. It is printed in various places, allowing the current handle to be identified in debugging output.

One important place is when tracing is enabled. If the identifier string is not an empty string, then trace messages change from this:

libguestfs: trace: get_tmpdir libguestfs: trace: get_tmpdir = "/tmp"

to this:

libguestfs: trace: ID: get_tmpdir libguestfs: trace: ID: get_tmpdir = "/tmp"

where "ID" is the identifier string set by this call.

The identifier must only contain alphanumeric ASCII characters, underscore and minus sign. The default is the empty string.

See also "g.set_program", "g.set_trace", "g.get_identifier".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.31.14

### set_label

public void set_label(String mountable, String label) throws LibGuestFSException

set filesystem label

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

Only some filesystem types support labels, and libguestfs supports setting labels on only a subset of these.

ext2, ext3, ext4 Labels are limited to 16 bytes.

NTFS Labels are limited to 128 unicode characters.

XFS The label is limited to 12 bytes. The filesystem must not be mounted when trying to set the label.

btrfs The label is limited to 255 bytes and some characters are not allowed. Setting the label on a btrfs subvolume will set the label on its parent filesystem. The filesystem must not be mounted when trying to set the label.

fat The label is limited to 11 bytes.

swap The label is limited to 16 bytes.

If there is no support for changing the label for the type of the specified filesystem, set_label will fail and set errno as ENOTSUP.

To read the label on a filesystem, call "g.vfs_label".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.9

### set_libvirt_requested_credential

public void set_libvirt_requested_credential(int index, byte[] cred) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.52

### set_libvirt_supported_credentials

public void set_libvirt_supported_credentials(String[] creds) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.52

### set_memsize

public void set_memsize(int memsize) throws LibGuestFSException

set memory allocated to the hypervisor

This sets the memory size in megabytes allocated to the hypervisor. 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` - If there is a libguestfs error.
Since:
  1.0.55

### set_network

public void set_network(boolean network) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.5.4

### set_path

public void set_path(String searchpath) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.3

### set_pgroup

public void set_pgroup(boolean pgroup) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.11.18

### set_program

public void set_program(String program) throws LibGuestFSException

set the program name

Set the program name. This is an informative string which the main program may optionally set in the handle.

When the handle is created, the program name in the handle is set to the basename from "argv[0]". The program name can never be "NULL".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.21.29

### set_qemu

@Deprecated public void set_qemu(String hv) throws LibGuestFSException
Deprecated.
In new code, use `set_hv(String)` instead

set the hypervisor binary (usually qemu)

Set the hypervisor binary (usually qemu) 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_HV" environment variable.

Setting "hv" 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_HV" is safest of all since that picks the qemu binary at the same time as the handle is created.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.6

### set_recovery_proc

public void set_recovery_proc(boolean recoveryproc) throws LibGuestFSException

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 hypervisor 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 the hypervisor, which is not very helpful.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.77

### set_selinux

@Deprecated public void set_selinux(boolean selinux) throws LibGuestFSException
Deprecated.
In new code, use `selinux_relabel(String, String, Map)` instead

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` - If there is a libguestfs error.
Since:
  1.0.67

### set_smp

public void set_smp(int smp) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.13.15

### set_tmpdir

public void set_tmpdir(String tmpdir) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.58

### set_trace

public void set_trace(boolean trace) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.69

### set_uuid

public void set_uuid(String device, String uuid) throws LibGuestFSException

set the filesystem UUID

Set the filesystem UUID on "device" to "uuid". If this fails and the errno is ENOTSUP, means that there is no support for changing the UUID for the type of the specified filesystem.

Only some filesystem types support setting UUIDs.

To read the UUID on a filesystem, call "g.vfs_uuid".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.23.10

### set_uuid_random

public void set_uuid_random(String device) throws LibGuestFSException

set a random UUID for the filesystem

Set the filesystem UUID on "device" to a random UUID. If this fails and the errno is ENOTSUP, means that there is no support for changing the UUID for the type of the specified filesystem.

Only some filesystem types support setting UUIDs.

To read the UUID on a filesystem, call "g.vfs_uuid".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.29.50

### set_verbose

public void set_verbose(boolean verbose) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.3

### setcon

@Deprecated public void setcon(String context) throws LibGuestFSException
Deprecated.
In new code, use `selinux_relabel(String, String, Map)` instead

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

This function depends on the feature "selinux". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.67

### setfiles

public void setfiles(String specfile, String[] paths, Map<String,Object> optargs) throws LibGuestFSException

low level relabel parts of the filesystem

This invokes the SELinux "setfiles" command which is a low level tool used to relabel parts of the filesystem.

The "specfile" parameter controls the policy spec file used. You have to parse "/etc/selinux/config" to find the correct SELinux policy and then pass the spec file, usually: "/etc/selinux/" + *selinuxtype* + "/contexts/files/file_contexts".

The required "paths" parameter is the list of top level directories where relabelling starts. "setfiles" will only relabel up to filesystem boundaries so, for example, passing just "/" will relabel the whole root filesystem, but no other mounted filesystems. If the list is empty, setfiles is not called.

The optional "force" boolean controls whether the context is reset for customizable files, and also whether the user, role and range parts of the file context is changed.

Optional arguments are supplied in the final Map<String,Object> 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.

This function depends on the feature "selinuxrelabel". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.57.1

### setfiles

public void setfiles(String specfile, String[] paths) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### setxattr

public void setxattr(String xattr, String val, int vallen, String path) throws LibGuestFSException

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

This function depends on the feature "linuxxattrs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.59

### sfdisk

@Deprecated public void sfdisk(String device, int cyls, int heads, int sectors, String[] lines) throws LibGuestFSException
Deprecated.
In new code, use `part_add(String, String, long, long)` instead

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.8

### sfdiskM

@Deprecated public void sfdiskM(String device, String[] lines) throws LibGuestFSException
Deprecated.
In new code, use `part_add(String, String, long, long)` instead

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"

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.55

### sfdisk_N

@Deprecated public void sfdisk_N(String device, int partnum, int cyls, int heads, int sectors, String line) throws LibGuestFSException
Deprecated.
In new code, use `part_add(String, String, long, long)` instead

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"

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.26

### sfdisk_disk_geometry

public String sfdisk_disk_geometry(String device) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.26

### sfdisk_kernel_geometry

public String sfdisk_kernel_geometry(String device) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.26

### sfdisk_l

@Deprecated public String sfdisk_l(String device) throws LibGuestFSException
Deprecated.
In new code, use `part_list(String)` instead

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"

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.26

### sh

public String sh(String command) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.50

### sh_lines

public String[] sh_lines(String command) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.50

### sh_out

public void sh_out(String command, String output) throws LibGuestFSException

run a command via the shell

This is the same as "g.sh", but streams the output back, handling the case where the output from the command is larger than the protocol limit.

See also: "g.command_out"

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.55.6

### shutdown

public void shutdown() throws LibGuestFSException

shutdown the hypervisor

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` - If there is a libguestfs error.
Since:
  1.19.16

### sleep

public void sleep(int secs) throws LibGuestFSException

sleep for some seconds

Sleep for "secs" seconds.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.41

### stat

@Deprecated public Stat stat(String path) throws LibGuestFSException
Deprecated.
In new code, use `statns(String)` instead

get file information

Returns file information for the given "path".

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.9.2

### statns

public StatNS statns(String path) throws LibGuestFSException

get file information

Returns file information for the given "path".

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.27.53

### statvfs

public StatVFS statvfs(String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.9.2

### strings

public String[] strings(String path) throws LibGuestFSException

print the printable strings in a file

This runs the strings(1) command on a file and returns the list of printable strings found.

The "strings" command has, in the past, had problems with parsing untrusted files. These are mitigated in the current version of libguestfs, but see "CVE-2014-8484" in guestfs(3).

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.22

### strings_e

public String[] strings_e(String encoding, String path) throws LibGuestFSException

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.

The "strings" command has, in the past, had problems with parsing untrusted files. These are mitigated in the current version of libguestfs, but see "CVE-2014-8484" in guestfs(3).

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.22

### swapoff_device

public void swapoff_device(String device) throws LibGuestFSException

disable swap on device

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### swapoff_file

public void swapoff_file(String file) throws LibGuestFSException

disable swap on file

This command disables the libguestfs appliance swap on file.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### swapoff_label

public void swapoff_label(String label) throws LibGuestFSException

disable swap on labeled swap partition

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### swapoff_uuid

public void swapoff_uuid(String uuid) throws LibGuestFSException

disable swap on swap partition by UUID

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

This function depends on the feature "linuxfsuuid". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### swapon_device

public void swapon_device(String device) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.66

### swapon_file

public void swapon_file(String file) throws LibGuestFSException

enable swap on file

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### swapon_label

public void swapon_label(String label) throws LibGuestFSException

enable swap on labeled swap partition

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### swapon_uuid

public void swapon_uuid(String uuid) throws LibGuestFSException

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.

This function depends on the feature "linuxfsuuid". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### sync

public void sync() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.3

### syslinux

public void syslinux(String device, Map<String,Object> optargs) throws LibGuestFSException

install the SYSLINUX bootloader

Install the SYSLINUX bootloader on "device".

The device parameter must be either a whole disk formatted as a FAT filesystem, or a partition formatted as a FAT filesystem. In the latter case, the partition should be marked as "active" ("g.part_set_bootable") and a Master Boot Record must be installed (eg. using "g.pwrite_device") on the first sector of the whole disk. The SYSLINUX package comes with some suitable Master Boot Records. See the syslinux(1) man page for further information.

The optional arguments are:

directory Install SYSLINUX in the named subdirectory, instead of in the root directory of the FAT filesystem.

Additional configuration can be supplied to SYSLINUX by placing a file called syslinux.cfg on the FAT filesystem, either in the root directory, or under directory if that optional argument is being used. For further information about the contents of this file, see syslinux(1).

See also "g.extlinux".

Optional arguments are supplied in the final Map<String,Object> 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.

This function depends on the feature "syslinux". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.21.27

### syslinux

public void syslinux(String device) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### tail

public String[] tail(String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.54

### tail_n

public String[] tail_n(int nrlines, String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.54

### tar_in

public void tar_in(String tarfile, String directory, Map<String,Object> optargs) throws LibGuestFSException

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", "lzma", "zstd". (Note that not all builds of libguestfs will support all of these compression types).

The other optional arguments are:

"xattrs" If set to true, extended attributes are restored from the tar file.

"selinux" If set to true, SELinux contexts are restored from the tar file.

"acls" If set to true, POSIX ACLs are restored from the tar file.

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.0.3

### tar_in

public void tar_in(String tarfile, String directory) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### tar_in_opts

public void tar_in_opts(String tarfile, String directory, Map<String,Object> optargs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### tar_in_opts

public void tar_in_opts(String tarfile, String directory) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### tar_out

public void tar_out(String directory, String tarfile, Map<String,Object> optargs) throws LibGuestFSException

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", "lzma", "zstd". (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.

"xattrs" If set to true, extended attributes are saved in the output tar.

"selinux" If set to true, SELinux contexts are saved in the output tar.

"acls" If set to true, POSIX ACLs are saved in the output tar.

Optional arguments are supplied in the final Map<String,Object> 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` - If there is a libguestfs error.
Since:
  1.0.3

### tar_out

public void tar_out(String directory, String tarfile) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### tar_out_opts

public void tar_out_opts(String directory, String tarfile, Map<String,Object> optargs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### tar_out_opts

public void tar_out_opts(String directory, String tarfile) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### tgz_in

@Deprecated public void tgz_in(String tarball, String directory) throws LibGuestFSException
Deprecated.
In new code, use `tar_in(String, String, Map)` instead

unpack compressed tarball to directory

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.3

### tgz_out

@Deprecated public void tgz_out(String directory, String tarball) throws LibGuestFSException
Deprecated.
In new code, use `tar_out(String, String, Map)` instead

pack directory into compressed tarball

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.3

### touch

public void touch(String path) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  0.3

### truncate

public void truncate(String path) throws LibGuestFSException

truncate a file to zero size

This command truncates "path" to a zero-length file. The file must exist already.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.77

### truncate_size

public void truncate_size(String path, long size) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.77

### tune2fs

public void tune2fs(String device, Map<String,Object> optargs) throws LibGuestFSException

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(8) "-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(8) "-c" option.

"mountcount" Set the number of times the filesystem has been mounted. This is the same as the tune2fs(8) "-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(8) "-e" option.

"group" Set the group which can use reserved filesystem blocks. This is the same as the tune2fs(8) "-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(8) "-i" option.

"reservedblockspercentage" Set the percentage of the filesystem which may only be allocated by privileged processes. This is the same as the tune2fs(8) "-m" option.

"lastmounteddirectory" Set the last mounted directory. This is the same as the tune2fs(8) "-M" option.

"reservedblockscount" Set the number of reserved filesystem blocks. This is the same as the tune2fs(8) "-r" option. "user" Set the user who can use the reserved filesystem blocks. This is the same as the tune2fs(8) "-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<String,Object> 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` - If there is a libguestfs error.
Since:
  1.15.4

### tune2fs

public void tune2fs(String device) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### tune2fs_l

public Map<String,String> tune2fs_l(String device) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.9.2

### txz_in

@Deprecated public void txz_in(String tarball, String directory) throws LibGuestFSException
Deprecated.
In new code, use `tar_in(String, String, Map)` instead

unpack compressed tarball to directory

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

This function depends on the feature "xz". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.3.2

### txz_out

@Deprecated public void txz_out(String directory, String tarball) throws LibGuestFSException
Deprecated.
In new code, use `tar_out(String, String, Map)` instead

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 depends on the feature "xz". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.3.2

### umask

public int umask(int mask) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.55

### umount

public void umount(String pathordevice, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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` - If there is a libguestfs error.
Since:
  0.8

### umount

public void umount(String pathordevice) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### umount_opts

public void umount_opts(String pathordevice, Map<String,Object> optargs) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### umount_opts

public void umount_opts(String pathordevice) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### umount_all

public void umount_all() throws LibGuestFSException

unmount all filesystems

This unmounts all mounted filesystems.

Some internal mounts are not unmounted by this call.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.8

### umount_local

public void umount_local(Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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` - If there is a libguestfs error.
Since:
  1.17.22

### umount_local

public void umount_local() throws LibGuestFSException

Throws:
  `LibGuestFSException`

### upload

public void upload(String filename, String remotefilename) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.2

### upload_offset

public void upload_offset(String filename, String remotefilename, long offset) throws LibGuestFSException

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-existent 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` - If there is a libguestfs error.
Since:
  1.5.17

### user_cancel

public void user_cancel() throws LibGuestFSException

cancel the current upload or download operation

This function cancels the current upload or download operation.

Unlike most other libguestfs calls, this function is signal safe and thread safe. You can call it from a signal handler or from another thread, without needing to do any locking.

The transfer that was in progress (if there is one) will stop shortly afterwards, and will return an error. The errno (see "guestfs_last_errno") is set to "EINTR", so you can test for this to find out if the operation was cancelled or failed because of another error.

No cleanup is performed: for example, if a file was being uploaded then after cancellation there may be a partially uploaded file. It is the caller’s responsibility to clean up if necessary.

There are two common places that you might call "g.user_cancel":

In an interactive text-based program, you might call it from a "SIGINT" signal handler so that pressing "^C" cancels the current operation. (You also need to call "g.set_pgroup" so that child processes don't receive the "^C" signal).

In a graphical program, when the main thread is displaying a progress bar with a cancel button, wire up the cancel button to call this function.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.11.18

### utimens

public void utimens(String path, long atsecs, long atnsecs, long mtsecs, long mtnsecs) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.77

### utsname

public UTSName utsname() throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.19.27

### version

public Version version() throws LibGuestFSException

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" or "g.feature_available" instead.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.58

### vfs_label

public String vfs_label(String mountable) throws LibGuestFSException

get the filesystem label

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

If the filesystem is unlabeled, this returns the empty string.

To find a filesystem from the label, use "g.findfs_label".

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.3.18

### vfs_minimum_size

public long vfs_minimum_size(String mountable) throws LibGuestFSException

get minimum filesystem size

Get the minimum size of filesystem in bytes. This is the minimum possible size for filesystem shrinking.

If getting minimum size of specified filesystem is not supported, this will fail and set errno as ENOTSUP.

See also ntfsresize(8), resize2fs(8), btrfs(8), xfs_info(8).

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.31.18

### vfs_type

public String vfs_type(String mountable) throws LibGuestFSException

get the Linux VFS type corresponding to a mounted device

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

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` - If there is a libguestfs error.
Since:
  1.0.75

### vfs_uuid

public String vfs_uuid(String mountable) throws LibGuestFSException

get the filesystem UUID

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

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` - If there is a libguestfs error.
Since:
  1.3.18

### vg_activate

public void vg_activate(boolean activate, String[] volgroups) throws LibGuestFSException

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.

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.26

### vg_activate_all

public void vg_activate_all(boolean activate) throws LibGuestFSException

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"

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.26

### vgchange_uuid

public void vgchange_uuid(String vg) throws LibGuestFSException

generate a new random UUID for a volume group

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

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.26

### vgchange_uuid_all

public void vgchange_uuid_all() throws LibGuestFSException

generate new random UUIDs for all volume groups

Generate new random UUIDs for all volume groups.

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.26

### vgcreate

public void vgcreate(String volgroup, String[] physvols) throws LibGuestFSException

create an LVM volume group

This creates an LVM volume group called "volgroup" from the non-empty list of physical volumes "physvols".

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.8

### vglvuuids

public String[] vglvuuids(String vgname) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.87

### vgmeta

public String vgmeta(String vgname) throws LibGuestFSException

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.

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.20

### vgpvuuids

public String[] vgpvuuids(String vgname) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.87

### vgremove

public void vgremove(String vgname) throws LibGuestFSException

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

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.13

### vgrename

public void vgrename(String volgroup, String newvolgroup) throws LibGuestFSException

rename an LVM volume group

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.83

### vgs

public String[] vgs() throws LibGuestFSException

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

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.4

### vgs_full

public VG[] vgs_full() throws LibGuestFSException

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.

This function depends on the feature "lvm2". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.4

### vgscan

@Deprecated public void vgscan() throws LibGuestFSException
Deprecated.
In new code, use `lvm_scan(boolean)` instead

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` - If there is a libguestfs error.
Since:
  1.3.2

### vguuid

public String vguuid(String vgname) throws LibGuestFSException

get the UUID of a volume group

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.87

### wait_ready

@Deprecated public void wait_ready() throws LibGuestFSException
Deprecated.
There is no documented replacement

wait until the hypervisor launches (no op)

This function is a no op.

In versions of the API < 1.0.71 you had to call this function just after calling "g.launch" to wait for the launch to complete. However this is no longer necessary because "g.launch" now does the waiting.

If you see any calls to this function in code then you can just remove them, unless you want to retain compatibility with older versions of the API.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.3

### wc_c

public int wc_c(String path) throws LibGuestFSException

count characters in a file

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.54

### wc_l

public int wc_l(String path) throws LibGuestFSException

count lines in a file

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.54

### wc_w

public int wc_w(String path) throws LibGuestFSException

count words in a file

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.54

### wipefs

public void wipefs(String device) throws LibGuestFSException

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.

This function depends on the feature "wipefs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.17.6

### write

public void write(String path, byte[] content) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.3.14

### write_append

public void write_append(String path, byte[] content) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.11.18

### write_file

@Deprecated public void write_file(String path, String content, int size) throws LibGuestFSException
Deprecated.
In new code, use `write(String, byte[])` instead

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  0.8

### xfs_admin

public void xfs_admin(String device, Map<String,Object> optargs) throws LibGuestFSException

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.

Beginning with XFS version 5, it is no longer possible to modify the lazy-counters setting (ie. "lazycounter" parameter has no effect).

Optional arguments are supplied in the final Map<String,Object> 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.

This function depends on the feature "xfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.33

### xfs_admin

public void xfs_admin(String device) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### xfs_growfs

public void xfs_growfs(String path, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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.

This function depends on the feature "xfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.28

### xfs_growfs

public void xfs_growfs(String path) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### xfs_info

public XFSInfo xfs_info(String pathordevice) throws LibGuestFSException

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.

This function depends on the feature "xfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.21

### xfs_repair

public int xfs_repair(String device, Map<String,Object> optargs) throws LibGuestFSException

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<String,Object> 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.

This function depends on the feature "xfs". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.19.36

### xfs_repair

public int xfs_repair(String device) throws LibGuestFSException

Throws:
  `LibGuestFSException`

### yara_destroy

public void yara_destroy() throws LibGuestFSException

destroy previously loaded yara rules

Destroy previously loaded Yara rules in order to free libguestfs resources.

This function depends on the feature "libyara". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.37.13

### yara_load

public void yara_load(String filename) throws LibGuestFSException

load yara rules within libguestfs

Upload a set of Yara rules from local file filename.

Yara rules allow to categorize files based on textual or binary patterns within their content. See "g.yara_scan" to see how to scan files with the loaded rules.

Rules can be in binary format, as when compiled with yarac command, or in source code format. In the latter case, the rules will be first compiled and then loaded.

Rules in source code format cannot include external files. In such cases, it is recommended to compile them first.

Previously loaded rules will be destroyed.

This function depends on the feature "libyara". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.37.13

### yara_scan

public YaraDetection[] yara_scan(String path) throws LibGuestFSException

scan a file with the loaded yara rules

Scan a file with the previously loaded Yara rules.

For each matching rule, a "yara_detection" structure is returned.

The "yara_detection" structure contains the following fields.

"yara_name" Path of the file matching a Yara rule.

"yara_rule" Identifier of the Yara rule which matched against the given file.

This function depends on the feature "libyara". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.37.13

### zegrep

@Deprecated public String[] zegrep(String regex, String path) throws LibGuestFSException
Deprecated.
In new code, use `grep(String, String, Map)` instead

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### zegrepi

@Deprecated public String[] zegrepi(String regex, String path) throws LibGuestFSException
Deprecated.
In new code, use `grep(String, String, Map)` instead

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### zero

public void zero(String device) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.0.16

### zero_device

public void zero_device(String device) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.3.1

### zero_free_space

public void zero_free_space(String directory) throws LibGuestFSException

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` - If there is a libguestfs error.
Since:
  1.17.18

### zerofree

public void zerofree(String device) throws LibGuestFSException

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.

This function depends on the feature "zerofree". See also `feature_available(String[])`.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.26

### zfgrep

@Deprecated public String[] zfgrep(String pattern, String path) throws LibGuestFSException
Deprecated.
In new code, use `grep(String, String, Map)` instead

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### zfgrepi

@Deprecated public String[] zfgrepi(String pattern, String path) throws LibGuestFSException
Deprecated.
In new code, use `grep(String, String, Map)` instead

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### zfile

@Deprecated public String zfile(String meth, String path) throws LibGuestFSException
Deprecated.
In new code, use `file(String)` instead

determine file type inside a compressed file

This command runs file(1) after first decompressing "path" using "meth".

"meth" must be one of "gzip", "compress" or "bzip2".

Since 1.0.63, use "g.file" instead which can now process compressed files.

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.59

### zgrep

@Deprecated public String[] zgrep(String regex, String path) throws LibGuestFSException
Deprecated.
In new code, use `grep(String, String, Map)` instead

return lines matching a pattern

This calls the external zgrep(1) program and returns the matching lines.

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66

### zgrepi

@Deprecated public String[] zgrepi(String regex, String path) throws LibGuestFSException
Deprecated.
In new code, use `grep(String, String, Map)` instead

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

Throws:
  `LibGuestFSException` - If there is a libguestfs error.
Since:
  1.0.66