Index of class methods

A
acl_delete_def_file [Guestfs.guestfs]

delete the default POSIX ACL of a directory

acl_get_file [Guestfs.guestfs]

get the POSIX ACL attached to a file

acl_set_file [Guestfs.guestfs]

set the POSIX ACL attached to a file

add_cdrom [Guestfs.guestfs]

add a CD-ROM disk image to examine

add_domain [Guestfs.guestfs]

add the disk(s) from a named libvirt domain

add_drive [Guestfs.guestfs]

add an image to examine or modify

add_drive_opts [Guestfs.guestfs]
add_drive_ro [Guestfs.guestfs]

add a drive in snapshot mode (read-only)

add_drive_ro_with_if [Guestfs.guestfs]

add a drive read-only specifying the QEMU block emulation to use

add_drive_scratch [Guestfs.guestfs]

add a temporary scratch drive

add_drive_with_if [Guestfs.guestfs]

add a drive specifying the QEMU block emulation to use

add_libvirt_dom [Guestfs.guestfs]

add the disk(s) from a libvirt domain

aug_clear [Guestfs.guestfs]

clear Augeas path

aug_close [Guestfs.guestfs]

close the current Augeas handle

aug_defnode [Guestfs.guestfs]

define an Augeas node

aug_defvar [Guestfs.guestfs]

define an Augeas variable

aug_get [Guestfs.guestfs]

look up the value of an Augeas path

aug_init [Guestfs.guestfs]

create a new Augeas handle

aug_insert [Guestfs.guestfs]

insert a sibling Augeas node

aug_label [Guestfs.guestfs]

return the label from an Augeas path expression

aug_load [Guestfs.guestfs]

load files into the tree

aug_ls [Guestfs.guestfs]

list Augeas nodes under augpath

aug_match [Guestfs.guestfs]

return Augeas nodes which match augpath

aug_mv [Guestfs.guestfs]

move Augeas node

aug_rm [Guestfs.guestfs]

remove an Augeas path

aug_save [Guestfs.guestfs]

write all pending Augeas changes to disk

aug_set [Guestfs.guestfs]

set Augeas path to value

aug_setm [Guestfs.guestfs]

set multiple Augeas nodes

aug_transform [Guestfs.guestfs]

add/remove an Augeas lens transformation

available [Guestfs.guestfs]

test availability of some parts of the API

available_all_groups [Guestfs.guestfs]

return a list of all optional groups

B
base64_in [Guestfs.guestfs]

upload base64-encoded data to file

base64_out [Guestfs.guestfs]

download file and encode as base64

blkdiscard [Guestfs.guestfs]

discard all blocks on a device

blkdiscardzeroes [Guestfs.guestfs]

return true if discarded blocks are read as zeroes

blkid [Guestfs.guestfs]

print block device attributes

blockdev_flushbufs [Guestfs.guestfs]

flush device buffers

blockdev_getbsz [Guestfs.guestfs]

get blocksize of block device

blockdev_getro [Guestfs.guestfs]

is block device set to read-only

blockdev_getsize64 [Guestfs.guestfs]

get total size of device in bytes

blockdev_getss [Guestfs.guestfs]

get sectorsize of block device

blockdev_getsz [Guestfs.guestfs]

get total size of device in 512-byte sectors

blockdev_rereadpt [Guestfs.guestfs]

reread partition table

blockdev_setbsz [Guestfs.guestfs]

set blocksize of block device

blockdev_setra [Guestfs.guestfs]

set readahead

blockdev_setro [Guestfs.guestfs]

set block device to read-only

blockdev_setrw [Guestfs.guestfs]

set block device to read-write

btrfs_balance_cancel [Guestfs.guestfs]

cancel a running or paused balance

btrfs_balance_pause [Guestfs.guestfs]

pause a running balance

btrfs_balance_resume [Guestfs.guestfs]

resume a paused balance

btrfs_balance_status [Guestfs.guestfs]

show the status of a running or paused balance

btrfs_device_add [Guestfs.guestfs]

add devices to a btrfs filesystem

btrfs_device_delete [Guestfs.guestfs]

remove devices from a btrfs filesystem

btrfs_filesystem_balance [Guestfs.guestfs]

balance a btrfs filesystem

btrfs_filesystem_defragment [Guestfs.guestfs]

defragment a file or directory

btrfs_filesystem_resize [Guestfs.guestfs]

resize a btrfs filesystem

btrfs_filesystem_show [Guestfs.guestfs]

list devices for btrfs filesystem

btrfs_filesystem_sync [Guestfs.guestfs]

sync a btrfs filesystem

btrfs_fsck [Guestfs.guestfs]

check a btrfs filesystem

btrfs_image [Guestfs.guestfs]

create an image of a btrfs filesystem

btrfs_qgroup_assign [Guestfs.guestfs]

add a qgroup to a parent qgroup

btrfs_qgroup_create [Guestfs.guestfs]

create a subvolume quota group

btrfs_qgroup_destroy [Guestfs.guestfs]

destroy a subvolume quota group

btrfs_qgroup_limit [Guestfs.guestfs]

limit the size of a subvolume

btrfs_qgroup_remove [Guestfs.guestfs]

remove a qgroup from its parent qgroup

btrfs_qgroup_show [Guestfs.guestfs]

show subvolume quota groups

btrfs_quota_enable [Guestfs.guestfs]

enable or disable subvolume quota support

btrfs_quota_rescan [Guestfs.guestfs]

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

btrfs_replace [Guestfs.guestfs]

replace a btrfs managed device with another device

btrfs_rescue_chunk_recover [Guestfs.guestfs]

recover the chunk tree of btrfs filesystem

btrfs_rescue_super_recover [Guestfs.guestfs]

recover bad superblocks from good copies

btrfs_scrub_cancel [Guestfs.guestfs]

cancel a running scrub

btrfs_scrub_resume [Guestfs.guestfs]

resume a previously canceled or interrupted scrub

btrfs_scrub_start [Guestfs.guestfs]

read all data from all disks and verify checksums

btrfs_scrub_status [Guestfs.guestfs]

show status of running or finished scrub

btrfs_set_seeding [Guestfs.guestfs]

enable or disable the seeding feature of device

btrfs_subvolume_create [Guestfs.guestfs]

create a btrfs subvolume

btrfs_subvolume_create_opts [Guestfs.guestfs]
btrfs_subvolume_delete [Guestfs.guestfs]

delete a btrfs subvolume or snapshot

btrfs_subvolume_get_default [Guestfs.guestfs]

get the default subvolume or snapshot of a filesystem

btrfs_subvolume_list [Guestfs.guestfs]

list btrfs snapshots and subvolumes

btrfs_subvolume_set_default [Guestfs.guestfs]

set default btrfs subvolume

btrfs_subvolume_show [Guestfs.guestfs]

return detailed information of the subvolume

btrfs_subvolume_snapshot [Guestfs.guestfs]

create a btrfs snapshot

btrfs_subvolume_snapshot_opts [Guestfs.guestfs]
btrfstune_enable_extended_inode_refs [Guestfs.guestfs]

enable extended inode refs

btrfstune_enable_skinny_metadata_extent_refs [Guestfs.guestfs]

enable skinny metadata extent refs

btrfstune_seeding [Guestfs.guestfs]

enable or disable seeding of a btrfs device

C
c_pointer [Guestfs.guestfs]

return the C pointer to the guestfs_h handle

canonical_device_name [Guestfs.guestfs]

return canonical device name

cap_get_file [Guestfs.guestfs]

get the Linux capabilities attached to a file

cap_set_file [Guestfs.guestfs]

set the Linux capabilities attached to a file

case_sensitive_path [Guestfs.guestfs]

return true path on case-insensitive filesystem

cat [Guestfs.guestfs]

list the contents of a file

checksum [Guestfs.guestfs]

compute MD5, SHAx or CRC checksum of file

checksum_device [Guestfs.guestfs]

compute MD5, SHAx or CRC checksum of the contents of a device

checksums_out [Guestfs.guestfs]

compute MD5, SHAx or CRC checksum of files in a directory

chmod [Guestfs.guestfs]

change file mode

chown [Guestfs.guestfs]

change file owner and group

clear_backend_setting [Guestfs.guestfs]

remove a single per-backend settings string

close [Guestfs.guestfs]
command [Guestfs.guestfs]

run a command from the guest filesystem

command_lines [Guestfs.guestfs]

run a command, returning lines

compress_device_out [Guestfs.guestfs]

output compressed device

compress_out [Guestfs.guestfs]

output compressed file

config [Guestfs.guestfs]

add hypervisor parameters

copy_attributes [Guestfs.guestfs]

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

copy_device_to_device [Guestfs.guestfs]

copy from source device to destination device

copy_device_to_file [Guestfs.guestfs]

copy from source device to destination file

copy_file_to_device [Guestfs.guestfs]

copy from source file to destination device

copy_file_to_file [Guestfs.guestfs]

copy from source file to destination file

copy_in [Guestfs.guestfs]

copy local files or directories into an image

copy_out [Guestfs.guestfs]

copy remote files or directories out of an image

copy_size [Guestfs.guestfs]

copy size bytes from source to destination using dd

cp [Guestfs.guestfs]

copy a file

cp_a [Guestfs.guestfs]

copy a file or directory recursively

cp_r [Guestfs.guestfs]

copy a file or directory recursively

cpio_out [Guestfs.guestfs]

pack directory into cpio file

D
dd [Guestfs.guestfs]

copy from source to destination using dd

delete_event_callback [Guestfs.guestfs]
device_index [Guestfs.guestfs]

convert device to index

df [Guestfs.guestfs]

report file system disk space usage

df_h [Guestfs.guestfs]

report file system disk space usage (human readable)

disk_create [Guestfs.guestfs]

create a blank disk image

disk_format [Guestfs.guestfs]

detect the disk format of a disk image

disk_has_backing_file [Guestfs.guestfs]

return whether disk has a backing file

disk_virtual_size [Guestfs.guestfs]

return virtual size of a disk

dmesg [Guestfs.guestfs]

return kernel messages

download [Guestfs.guestfs]

download a file to the local machine

download_blocks [Guestfs.guestfs]

download the given data units from the disk

download_inode [Guestfs.guestfs]

download a file to the local machine given its inode

download_offset [Guestfs.guestfs]

download a file to the local machine with offset and size

drop_caches [Guestfs.guestfs]

drop kernel page cache, dentries and inodes

du [Guestfs.guestfs]

estimate file space usage

E
e2fsck [Guestfs.guestfs]

check an ext2/ext3 filesystem

e2fsck_f [Guestfs.guestfs]

check an ext2/ext3 filesystem

echo_daemon [Guestfs.guestfs]

echo arguments back to the client

egrep [Guestfs.guestfs]

return lines matching a pattern

egrepi [Guestfs.guestfs]

return lines matching a pattern

equal [Guestfs.guestfs]

test if two files have equal contents

exists [Guestfs.guestfs]

test if file or directory exists

extlinux [Guestfs.guestfs]

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

F
f2fs_expand [Guestfs.guestfs]

expand a f2fs filesystem

fallocate [Guestfs.guestfs]

preallocate a file in the guest filesystem

fallocate64 [Guestfs.guestfs]

preallocate a file in the guest filesystem

feature_available [Guestfs.guestfs]

test availability of some parts of the API

fgrep [Guestfs.guestfs]

return lines matching a pattern

fgrepi [Guestfs.guestfs]

return lines matching a pattern

file [Guestfs.guestfs]

determine file type

file_architecture [Guestfs.guestfs]

detect the architecture of a binary file

filesize [Guestfs.guestfs]

return the size of the file in bytes

filesystem_available [Guestfs.guestfs]

check if filesystem is available

filesystem_walk [Guestfs.guestfs]

walk through the filesystem content

fill [Guestfs.guestfs]

fill a file with octets

fill_dir [Guestfs.guestfs]

fill a directory with empty files

fill_pattern [Guestfs.guestfs]

fill a file with a repeating pattern of bytes

find [Guestfs.guestfs]

find all files and directories

find0 [Guestfs.guestfs]

find all files and directories, returning NUL-separated list

find_inode [Guestfs.guestfs]

search the entries associated to the given inode

findfs_label [Guestfs.guestfs]

find a filesystem by label

findfs_uuid [Guestfs.guestfs]

find a filesystem by UUID

fsck [Guestfs.guestfs]

run the filesystem checker

fstrim [Guestfs.guestfs]

trim free space in a filesystem

G
get_append [Guestfs.guestfs]

get the additional kernel options

get_attach_method [Guestfs.guestfs]

get the backend

get_autosync [Guestfs.guestfs]

get autosync mode

get_backend [Guestfs.guestfs]

get the backend

get_backend_setting [Guestfs.guestfs]

get a single per-backend settings string

get_backend_settings [Guestfs.guestfs]

get per-backend settings

get_cachedir [Guestfs.guestfs]

get the appliance cache directory

get_direct [Guestfs.guestfs]

get direct appliance mode flag

get_e2attrs [Guestfs.guestfs]

get ext2 file attributes of a file

get_e2generation [Guestfs.guestfs]

get ext2 file generation of a file

get_e2label [Guestfs.guestfs]

get the ext2/3/4 filesystem label

get_e2uuid [Guestfs.guestfs]

get the ext2/3/4 filesystem UUID

get_hv [Guestfs.guestfs]

get the hypervisor binary

get_identifier [Guestfs.guestfs]

get the handle identifier

get_libvirt_requested_credential_challenge [Guestfs.guestfs]

challenge of i'th requested credential

get_libvirt_requested_credential_defresult [Guestfs.guestfs]

default result of i'th requested credential

get_libvirt_requested_credential_prompt [Guestfs.guestfs]

prompt of i'th requested credential

get_libvirt_requested_credentials [Guestfs.guestfs]

get list of credentials requested by libvirt

get_memsize [Guestfs.guestfs]

get memory allocated to the hypervisor

get_network [Guestfs.guestfs]

get enable network flag

get_path [Guestfs.guestfs]

get the search path

get_pgroup [Guestfs.guestfs]

get process group flag

get_pid [Guestfs.guestfs]

get PID of hypervisor

get_program [Guestfs.guestfs]

get the program name

get_qemu [Guestfs.guestfs]

get the hypervisor binary (usually qemu)

get_recovery_proc [Guestfs.guestfs]

get recovery process enabled flag

get_selinux [Guestfs.guestfs]

get SELinux enabled flag

get_smp [Guestfs.guestfs]

get number of virtual CPUs in appliance

get_sockdir [Guestfs.guestfs]

get the temporary directory for sockets

get_state [Guestfs.guestfs]

get the current state

get_tmpdir [Guestfs.guestfs]

get the temporary directory

get_trace [Guestfs.guestfs]

get command trace enabled flag

get_umask [Guestfs.guestfs]

get the current umask

get_verbose [Guestfs.guestfs]

get verbose mode

getcon [Guestfs.guestfs]

get SELinux security context

getxattr [Guestfs.guestfs]

get a single extended attribute

getxattrs [Guestfs.guestfs]

list extended attributes of a file or directory

glob_expand [Guestfs.guestfs]

expand a wildcard path

glob_expand_opts [Guestfs.guestfs]
grep [Guestfs.guestfs]

return lines matching a pattern

grep_opts [Guestfs.guestfs]
grepi [Guestfs.guestfs]

return lines matching a pattern

grub_install [Guestfs.guestfs]

install GRUB 1

H
head [Guestfs.guestfs]

return first 10 lines of a file

head_n [Guestfs.guestfs]

return first N lines of a file

hexdump [Guestfs.guestfs]

dump a file in hexadecimal

hivex_close [Guestfs.guestfs]

close the current hivex handle

hivex_commit [Guestfs.guestfs]

commit (write) changes back to the hive

hivex_node_add_child [Guestfs.guestfs]

add a child node

hivex_node_children [Guestfs.guestfs]

return list of nodes which are subkeys of node

hivex_node_delete_child [Guestfs.guestfs]

delete a node (recursively)

hivex_node_get_child [Guestfs.guestfs]

return the named child of node

hivex_node_get_value [Guestfs.guestfs]

return the named value

hivex_node_name [Guestfs.guestfs]

return the name of the node

hivex_node_parent [Guestfs.guestfs]

return the parent of node

hivex_node_set_value [Guestfs.guestfs]

set or replace a single value in a node

hivex_node_values [Guestfs.guestfs]

return list of values attached to node

hivex_open [Guestfs.guestfs]

open a Windows Registry hive file

hivex_root [Guestfs.guestfs]

return the root node of the hive

hivex_value_key [Guestfs.guestfs]

return the key field from the (key, datatype, data) tuple

hivex_value_string [Guestfs.guestfs]

return the data field as a UTF-8 string

hivex_value_type [Guestfs.guestfs]

return the data type from the (key, datatype, data) tuple

hivex_value_utf8 [Guestfs.guestfs]

return the data field as a UTF-8 string

hivex_value_value [Guestfs.guestfs]

return the data field from the (key, datatype, data) tuple

I
initrd_cat [Guestfs.guestfs]

list the contents of a single file in an initrd

initrd_list [Guestfs.guestfs]

list files in an initrd

inotify_add_watch [Guestfs.guestfs]

add an inotify watch

inotify_close [Guestfs.guestfs]

close the inotify handle

inotify_files [Guestfs.guestfs]

return list of watched files that had events

inotify_init [Guestfs.guestfs]

create an inotify handle

inotify_read [Guestfs.guestfs]

return list of inotify events

inotify_rm_watch [Guestfs.guestfs]

remove an inotify watch

inspect_get_arch [Guestfs.guestfs]

get architecture of inspected operating system

inspect_get_distro [Guestfs.guestfs]

get distro of inspected operating system

inspect_get_drive_mappings [Guestfs.guestfs]

get drive letter mappings

inspect_get_filesystems [Guestfs.guestfs]

get filesystems associated with inspected operating system

inspect_get_format [Guestfs.guestfs]

get format of inspected operating system

inspect_get_hostname [Guestfs.guestfs]

get hostname of the operating system

inspect_get_icon [Guestfs.guestfs]

get the icon corresponding to this operating system

inspect_get_major_version [Guestfs.guestfs]

get major version of inspected operating system

inspect_get_minor_version [Guestfs.guestfs]

get minor version of inspected operating system

inspect_get_mountpoints [Guestfs.guestfs]

get mountpoints of inspected operating system

inspect_get_osinfo [Guestfs.guestfs]

get a possible osinfo short ID corresponding to this operating system

inspect_get_package_format [Guestfs.guestfs]

get package format used by the operating system

inspect_get_package_management [Guestfs.guestfs]

get package management tool used by the operating system

inspect_get_product_name [Guestfs.guestfs]

get product name of inspected operating system

inspect_get_product_variant [Guestfs.guestfs]

get product variant of inspected operating system

inspect_get_roots [Guestfs.guestfs]

return list of operating systems found by last inspection

inspect_get_type [Guestfs.guestfs]

get type of inspected operating system

inspect_get_windows_current_control_set [Guestfs.guestfs]

get Windows CurrentControlSet of inspected operating system

inspect_get_windows_software_hive [Guestfs.guestfs]

get the path of the Windows software hive

inspect_get_windows_system_hive [Guestfs.guestfs]

get the path of the Windows system hive

inspect_get_windows_systemroot [Guestfs.guestfs]

get Windows systemroot of inspected operating system

inspect_is_live [Guestfs.guestfs]

get live flag for install disk

inspect_is_multipart [Guestfs.guestfs]

get multipart flag for install disk

inspect_is_netinst [Guestfs.guestfs]

get netinst (network installer) flag for install disk

inspect_list_applications [Guestfs.guestfs]

get list of applications installed in the operating system

inspect_list_applications2 [Guestfs.guestfs]

get list of applications installed in the operating system

inspect_os [Guestfs.guestfs]

inspect disk and return list of operating systems found

is_blockdev [Guestfs.guestfs]

test if block device

is_blockdev_opts [Guestfs.guestfs]
is_busy [Guestfs.guestfs]

is busy processing a command

is_chardev [Guestfs.guestfs]

test if character device

is_chardev_opts [Guestfs.guestfs]
is_config [Guestfs.guestfs]

is in configuration state

is_dir [Guestfs.guestfs]

test if a directory

is_dir_opts [Guestfs.guestfs]
is_fifo [Guestfs.guestfs]

test if FIFO (named pipe)

is_fifo_opts [Guestfs.guestfs]
is_file [Guestfs.guestfs]

test if a regular file

is_file_opts [Guestfs.guestfs]
is_launching [Guestfs.guestfs]

is launching subprocess

is_lv [Guestfs.guestfs]

test if mountable is a logical volume

is_ready [Guestfs.guestfs]

is ready to accept commands

is_socket [Guestfs.guestfs]

test if socket

is_socket_opts [Guestfs.guestfs]
is_symlink [Guestfs.guestfs]

test if symbolic link

is_whole_device [Guestfs.guestfs]

test if a device is a whole device

is_zero [Guestfs.guestfs]

test if a file contains all zero bytes

is_zero_device [Guestfs.guestfs]

test if a device contains all zero bytes

isoinfo [Guestfs.guestfs]

get ISO information from primary volume descriptor of ISO file

isoinfo_device [Guestfs.guestfs]

get ISO information from primary volume descriptor of device

J
journal_close [Guestfs.guestfs]

close the systemd journal

journal_get [Guestfs.guestfs]

read the current journal entry

journal_get_data_threshold [Guestfs.guestfs]

get the data threshold for reading journal entries

journal_get_realtime_usec [Guestfs.guestfs]

get the timestamp of the current journal entry

journal_next [Guestfs.guestfs]

move to the next journal entry

journal_open [Guestfs.guestfs]

open the systemd journal

journal_set_data_threshold [Guestfs.guestfs]

set the data threshold for reading journal entries

journal_skip [Guestfs.guestfs]

skip forwards or backwards in the journal

K
kill_subprocess [Guestfs.guestfs]

kill the hypervisor

L
last_errno [Guestfs.guestfs]
launch [Guestfs.guestfs]

launch the backend

lchown [Guestfs.guestfs]

change file owner and group

ldmtool_create_all [Guestfs.guestfs]

scan and create Windows dynamic disk volumes

ldmtool_diskgroup_disks [Guestfs.guestfs]

return the disks in a Windows dynamic disk group

ldmtool_diskgroup_name [Guestfs.guestfs]

return the name of a Windows dynamic disk group

ldmtool_diskgroup_volumes [Guestfs.guestfs]

return the volumes in a Windows dynamic disk group

ldmtool_remove_all [Guestfs.guestfs]

remove all Windows dynamic disk volumes

ldmtool_scan [Guestfs.guestfs]

scan for Windows dynamic disks

ldmtool_scan_devices [Guestfs.guestfs]

scan for Windows dynamic disks

ldmtool_volume_hint [Guestfs.guestfs]

return the hint field of a Windows dynamic disk volume

ldmtool_volume_partitions [Guestfs.guestfs]

return the partitions in a Windows dynamic disk volume

ldmtool_volume_type [Guestfs.guestfs]

return the type of a Windows dynamic disk volume

lgetxattr [Guestfs.guestfs]

get a single extended attribute

lgetxattrs [Guestfs.guestfs]

list extended attributes of a file or directory

list_9p [Guestfs.guestfs]

list 9p filesystems

list_devices [Guestfs.guestfs]

list the block devices

list_disk_labels [Guestfs.guestfs]

mapping of disk labels to devices

list_dm_devices [Guestfs.guestfs]

list device mapper devices

list_filesystems [Guestfs.guestfs]

list filesystems

list_ldm_partitions [Guestfs.guestfs]

list all Windows dynamic disk partitions

list_ldm_volumes [Guestfs.guestfs]

list all Windows dynamic disk volumes

list_md_devices [Guestfs.guestfs]

list Linux md (RAID) devices

list_partitions [Guestfs.guestfs]

list the partitions

ll [Guestfs.guestfs]

list the files in a directory (long format)

llz [Guestfs.guestfs]

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

ln [Guestfs.guestfs]

create a hard link

ln_f [Guestfs.guestfs]

create a hard link

ln_s [Guestfs.guestfs]

create a symbolic link

ln_sf [Guestfs.guestfs]

create a symbolic link

lremovexattr [Guestfs.guestfs]

remove extended attribute of a file or directory

ls [Guestfs.guestfs]

list the files in a directory

ls0 [Guestfs.guestfs]

get list of files in a directory

lsetxattr [Guestfs.guestfs]

set extended attribute of a file or directory

lstat [Guestfs.guestfs]

get file information for a symbolic link

lstatlist [Guestfs.guestfs]

lstat on multiple files

lstatns [Guestfs.guestfs]

get file information for a symbolic link

lstatnslist [Guestfs.guestfs]

lstat on multiple files

luks_add_key [Guestfs.guestfs]

add a key on a LUKS encrypted device

luks_close [Guestfs.guestfs]

close a LUKS device

luks_format [Guestfs.guestfs]

format a block device as a LUKS encrypted device

luks_format_cipher [Guestfs.guestfs]

format a block device as a LUKS encrypted device

luks_kill_slot [Guestfs.guestfs]

remove a key from a LUKS encrypted device

luks_open [Guestfs.guestfs]

open a LUKS-encrypted block device

luks_open_ro [Guestfs.guestfs]

open a LUKS-encrypted block device read-only

luks_uuid [Guestfs.guestfs]

get the UUID of a LUKS device

lvcreate [Guestfs.guestfs]

create an LVM logical volume

lvcreate_free [Guestfs.guestfs]

create an LVM logical volume in % remaining free space

lvm_canonical_lv_name [Guestfs.guestfs]

get canonical name of an LV

lvm_clear_filter [Guestfs.guestfs]

clear LVM device filter

lvm_remove_all [Guestfs.guestfs]

remove all LVM LVs, VGs and PVs

lvm_scan [Guestfs.guestfs]

scan for LVM physical volumes, volume groups and logical volumes

lvm_set_filter [Guestfs.guestfs]

set LVM device filter

lvremove [Guestfs.guestfs]

remove an LVM logical volume

lvrename [Guestfs.guestfs]

rename an LVM logical volume

lvresize [Guestfs.guestfs]

resize an LVM logical volume

lvresize_free [Guestfs.guestfs]

expand an LV to fill free space

lvs [Guestfs.guestfs]

list the LVM logical volumes (LVs)

lvs_full [Guestfs.guestfs]

list the LVM logical volumes (LVs)

lvuuid [Guestfs.guestfs]

get the UUID of a logical volume

lxattrlist [Guestfs.guestfs]

lgetxattr on multiple files

M
max_disks [Guestfs.guestfs]

maximum number of disks that may be added

md_create [Guestfs.guestfs]

create a Linux md (RAID) device

md_detail [Guestfs.guestfs]

obtain metadata for an MD device

md_stat [Guestfs.guestfs]

get underlying devices from an MD device

md_stop [Guestfs.guestfs]

stop a Linux md (RAID) device

mkdir [Guestfs.guestfs]

create a directory

mkdir_mode [Guestfs.guestfs]

create a directory with a particular mode

mkdir_p [Guestfs.guestfs]

create a directory and parents

mkdtemp [Guestfs.guestfs]

create a temporary directory

mke2fs [Guestfs.guestfs]

create an ext2/ext3/ext4 filesystem on device

mke2fs_J [Guestfs.guestfs]

make ext2/3/4 filesystem with external journal

mke2fs_JL [Guestfs.guestfs]

make ext2/3/4 filesystem with external journal

mke2fs_JU [Guestfs.guestfs]

make ext2/3/4 filesystem with external journal

mke2journal [Guestfs.guestfs]

make ext2/3/4 external journal

mke2journal_L [Guestfs.guestfs]

make ext2/3/4 external journal with label

mke2journal_U [Guestfs.guestfs]

make ext2/3/4 external journal with UUID

mkfifo [Guestfs.guestfs]

make FIFO (named pipe)

mkfs [Guestfs.guestfs]

make a filesystem

mkfs_b [Guestfs.guestfs]

make a filesystem with block size

mkfs_btrfs [Guestfs.guestfs]

create a btrfs filesystem

mkfs_opts [Guestfs.guestfs]
mklost_and_found [Guestfs.guestfs]

make lost+found directory on an ext2/3/4 filesystem

mkmountpoint [Guestfs.guestfs]

create a mountpoint

mknod [Guestfs.guestfs]

make block, character or FIFO devices

mknod_b [Guestfs.guestfs]

make block device node

mknod_c [Guestfs.guestfs]

make char device node

mksquashfs [Guestfs.guestfs]

create a squashfs filesystem

mkswap [Guestfs.guestfs]

create a swap partition

mkswap_L [Guestfs.guestfs]

create a swap partition with a label

mkswap_U [Guestfs.guestfs]

create a swap partition with an explicit UUID

mkswap_file [Guestfs.guestfs]

create a swap file

mkswap_opts [Guestfs.guestfs]
mktemp [Guestfs.guestfs]

create a temporary file

modprobe [Guestfs.guestfs]

load a kernel module

mount [Guestfs.guestfs]

mount a guest disk at a position in the filesystem

mount_9p [Guestfs.guestfs]

mount 9p filesystem

mount_local [Guestfs.guestfs]

mount on the local filesystem

mount_local_run [Guestfs.guestfs]

run main loop of mount on the local filesystem

mount_loop [Guestfs.guestfs]

mount a file using the loop device

mount_options [Guestfs.guestfs]

mount a guest disk with mount options

mount_ro [Guestfs.guestfs]

mount a guest disk, read-only

mount_vfs [Guestfs.guestfs]

mount a guest disk with mount options and vfstype

mountable_device [Guestfs.guestfs]

extract the device part of a mountable

mountable_subvolume [Guestfs.guestfs]

extract the subvolume part of a mountable

mountpoints [Guestfs.guestfs]

show mountpoints

mounts [Guestfs.guestfs]

show mounted filesystems

mv [Guestfs.guestfs]

move a file

N
nr_devices [Guestfs.guestfs]

return number of whole block devices (disks) added

ntfs_3g_probe [Guestfs.guestfs]

probe NTFS volume

ntfscat_i [Guestfs.guestfs]

download a file to the local machine given its inode

ntfsclone_in [Guestfs.guestfs]

restore NTFS from backup file

ntfsclone_out [Guestfs.guestfs]

save NTFS to backup file

ntfsfix [Guestfs.guestfs]

fix common errors and force Windows to check NTFS

ntfsresize [Guestfs.guestfs]

resize an NTFS filesystem

ntfsresize_opts [Guestfs.guestfs]
ntfsresize_size [Guestfs.guestfs]

resize an NTFS filesystem (with size)

O
ocaml_handle [Guestfs.guestfs]

Return the Guestfs.t handle

P
parse_environment [Guestfs.guestfs]

parse the environment and set handle flags accordingly

parse_environment_list [Guestfs.guestfs]

parse the environment and set handle flags accordingly

part_add [Guestfs.guestfs]

add a partition to the device

part_del [Guestfs.guestfs]

delete a partition

part_disk [Guestfs.guestfs]

partition whole disk with a single primary partition

part_expand_gpt [Guestfs.guestfs]

move backup GPT header to the end of the disk

part_get_bootable [Guestfs.guestfs]

return true if a partition is bootable

part_get_disk_guid [Guestfs.guestfs]

get the GUID of a GPT-partitioned disk

part_get_gpt_attributes [Guestfs.guestfs]

get the attribute flags of a GPT partition

part_get_gpt_guid [Guestfs.guestfs]

get the GUID of a GPT partition

part_get_gpt_type [Guestfs.guestfs]

get the type GUID of a GPT partition

part_get_mbr_id [Guestfs.guestfs]

get the MBR type byte (ID byte) from a partition

part_get_mbr_part_type [Guestfs.guestfs]

get the MBR partition type

part_get_name [Guestfs.guestfs]

get partition name

part_get_parttype [Guestfs.guestfs]

get the partition table type

part_init [Guestfs.guestfs]

create an empty partition table

part_list [Guestfs.guestfs]

list partitions on a device

part_resize [Guestfs.guestfs]

resize a partition

part_set_bootable [Guestfs.guestfs]

make a partition bootable

part_set_disk_guid [Guestfs.guestfs]

set the GUID of a GPT-partitioned disk

part_set_disk_guid_random [Guestfs.guestfs]

set the GUID of a GPT-partitioned disk to random value

part_set_gpt_attributes [Guestfs.guestfs]

set the attribute flags of a GPT partition

part_set_gpt_guid [Guestfs.guestfs]

set the GUID of a GPT partition

part_set_gpt_type [Guestfs.guestfs]

set the type GUID of a GPT partition

part_set_mbr_id [Guestfs.guestfs]

set the MBR type byte (ID byte) of a partition

part_set_name [Guestfs.guestfs]

set partition name

part_to_dev [Guestfs.guestfs]

convert partition name to device name

part_to_partnum [Guestfs.guestfs]

convert partition name to partition number

ping_daemon [Guestfs.guestfs]

ping the guest daemon

pread [Guestfs.guestfs]

read part of a file

pread_device [Guestfs.guestfs]

read part of a device

pvchange_uuid [Guestfs.guestfs]

generate a new random UUID for a physical volume

pvchange_uuid_all [Guestfs.guestfs]

generate new random UUIDs for all physical volumes

pvcreate [Guestfs.guestfs]

create an LVM physical volume

pvremove [Guestfs.guestfs]

remove an LVM physical volume

pvresize [Guestfs.guestfs]

resize an LVM physical volume

pvresize_size [Guestfs.guestfs]

resize an LVM physical volume (with size)

pvs [Guestfs.guestfs]

list the LVM physical volumes (PVs)

pvs_full [Guestfs.guestfs]

list the LVM physical volumes (PVs)

pvuuid [Guestfs.guestfs]

get the UUID of a physical volume

pwrite [Guestfs.guestfs]

write to part of a file

pwrite_device [Guestfs.guestfs]

write to part of a device

R
read_file [Guestfs.guestfs]

read a file

read_lines [Guestfs.guestfs]

read file as lines

readdir [Guestfs.guestfs]

read directories entries

readlink [Guestfs.guestfs]

read the target of a symbolic link

readlinklist [Guestfs.guestfs]

readlink on multiple files

realpath [Guestfs.guestfs]

canonicalized absolute pathname

remount [Guestfs.guestfs]

remount a filesystem with different options

remove_drive [Guestfs.guestfs]

remove a disk image

removexattr [Guestfs.guestfs]

remove extended attribute of a file or directory

rename [Guestfs.guestfs]

rename a file on the same filesystem

resize2fs [Guestfs.guestfs]

resize an ext2, ext3 or ext4 filesystem

resize2fs_M [Guestfs.guestfs]

resize an ext2, ext3 or ext4 filesystem to the minimum size

resize2fs_size [Guestfs.guestfs]

resize an ext2, ext3 or ext4 filesystem (with size)

rm [Guestfs.guestfs]

remove a file

rm_f [Guestfs.guestfs]

remove a file ignoring errors

rm_rf [Guestfs.guestfs]

remove a file or directory recursively

rmdir [Guestfs.guestfs]

remove a directory

rmmountpoint [Guestfs.guestfs]

remove a mountpoint

rsync [Guestfs.guestfs]

synchronize the contents of two directories

rsync_in [Guestfs.guestfs]

synchronize host or remote filesystem with filesystem

rsync_out [Guestfs.guestfs]

synchronize filesystem with host or remote filesystem

S
scrub_device [Guestfs.guestfs]

scrub (securely wipe) a device

scrub_file [Guestfs.guestfs]

scrub (securely wipe) a file

scrub_freespace [Guestfs.guestfs]

scrub (securely wipe) free space

selinux_relabel [Guestfs.guestfs]

relabel parts of the filesystem

set_append [Guestfs.guestfs]

add options to kernel command line

set_attach_method [Guestfs.guestfs]

set the backend

set_autosync [Guestfs.guestfs]

set autosync mode

set_backend [Guestfs.guestfs]

set the backend

set_backend_setting [Guestfs.guestfs]

set a single per-backend settings string

set_backend_settings [Guestfs.guestfs]

replace per-backend settings strings

set_cachedir [Guestfs.guestfs]

set the appliance cache directory

set_direct [Guestfs.guestfs]

enable or disable direct appliance mode

set_e2attrs [Guestfs.guestfs]

set ext2 file attributes of a file

set_e2generation [Guestfs.guestfs]

set ext2 file generation of a file

set_e2label [Guestfs.guestfs]

set the ext2/3/4 filesystem label

set_e2uuid [Guestfs.guestfs]

set the ext2/3/4 filesystem UUID

set_event_callback [Guestfs.guestfs]
set_hv [Guestfs.guestfs]

set the hypervisor binary

set_identifier [Guestfs.guestfs]

set the handle identifier

set_label [Guestfs.guestfs]

set filesystem label

set_libvirt_requested_credential [Guestfs.guestfs]

pass requested credential back to libvirt

set_libvirt_supported_credentials [Guestfs.guestfs]

set libvirt credentials supported by calling program

set_memsize [Guestfs.guestfs]

set memory allocated to the hypervisor

set_network [Guestfs.guestfs]

set enable network flag

set_path [Guestfs.guestfs]

set the search path

set_pgroup [Guestfs.guestfs]

set process group flag

set_program [Guestfs.guestfs]

set the program name

set_qemu [Guestfs.guestfs]

set the hypervisor binary (usually qemu)

set_recovery_proc [Guestfs.guestfs]

enable or disable the recovery process

set_selinux [Guestfs.guestfs]

set SELinux enabled or disabled at appliance boot

set_smp [Guestfs.guestfs]

set number of virtual CPUs in appliance

set_tmpdir [Guestfs.guestfs]

set the temporary directory

set_trace [Guestfs.guestfs]

enable or disable command traces

set_uuid [Guestfs.guestfs]

set the filesystem UUID

set_uuid_random [Guestfs.guestfs]

set a random UUID for the filesystem

set_verbose [Guestfs.guestfs]

set verbose mode

setcon [Guestfs.guestfs]

set SELinux security context

setxattr [Guestfs.guestfs]

set extended attribute of a file or directory

sfdisk [Guestfs.guestfs]

create partitions on a block device

sfdiskM [Guestfs.guestfs]

create partitions on a block device

sfdisk_N [Guestfs.guestfs]

modify a single partition on a block device

sfdisk_disk_geometry [Guestfs.guestfs]

display the disk geometry from the partition table

sfdisk_kernel_geometry [Guestfs.guestfs]

display the kernel geometry

sfdisk_l [Guestfs.guestfs]

display the partition table

sh [Guestfs.guestfs]

run a command via the shell

sh_lines [Guestfs.guestfs]

run a command via the shell returning lines

shutdown [Guestfs.guestfs]

shutdown the hypervisor

sleep [Guestfs.guestfs]

sleep for some seconds

stat [Guestfs.guestfs]

get file information

statns [Guestfs.guestfs]

get file information

statvfs [Guestfs.guestfs]

get file system statistics

strings [Guestfs.guestfs]

print the printable strings in a file

strings_e [Guestfs.guestfs]

print the printable strings in a file

swapoff_device [Guestfs.guestfs]

disable swap on device

swapoff_file [Guestfs.guestfs]

disable swap on file

swapoff_label [Guestfs.guestfs]

disable swap on labeled swap partition

swapoff_uuid [Guestfs.guestfs]

disable swap on swap partition by UUID

swapon_device [Guestfs.guestfs]

enable swap on device

swapon_file [Guestfs.guestfs]

enable swap on file

swapon_label [Guestfs.guestfs]

enable swap on labeled swap partition

swapon_uuid [Guestfs.guestfs]

enable swap on swap partition by UUID

sync [Guestfs.guestfs]

sync disks, writes are flushed through to the disk image

syslinux [Guestfs.guestfs]

install the SYSLINUX bootloader

T
tail [Guestfs.guestfs]

return last 10 lines of a file

tail_n [Guestfs.guestfs]

return last N lines of a file

tar_in [Guestfs.guestfs]

unpack tarfile to directory

tar_in_opts [Guestfs.guestfs]
tar_out [Guestfs.guestfs]

pack directory into tarfile

tar_out_opts [Guestfs.guestfs]
tgz_in [Guestfs.guestfs]

unpack compressed tarball to directory

tgz_out [Guestfs.guestfs]

pack directory into compressed tarball

touch [Guestfs.guestfs]

update file timestamps or create a new file

truncate [Guestfs.guestfs]

truncate a file to zero size

truncate_size [Guestfs.guestfs]

truncate a file to a particular size

tune2fs [Guestfs.guestfs]

adjust ext2/ext3/ext4 filesystem parameters

tune2fs_l [Guestfs.guestfs]

get ext2/ext3/ext4 superblock details

txz_in [Guestfs.guestfs]

unpack compressed tarball to directory

txz_out [Guestfs.guestfs]

pack directory into compressed tarball

U
umask [Guestfs.guestfs]

set file mode creation mask (umask)

umount [Guestfs.guestfs]

unmount a filesystem

umount_all [Guestfs.guestfs]

unmount all filesystems

umount_local [Guestfs.guestfs]

unmount a locally mounted filesystem

umount_opts [Guestfs.guestfs]
upload [Guestfs.guestfs]

upload a file from the local machine

upload_offset [Guestfs.guestfs]

upload a file from the local machine with offset

user_cancel [Guestfs.guestfs]

cancel the current upload or download operation

utimens [Guestfs.guestfs]

set timestamp of a file with nanosecond precision

utsname [Guestfs.guestfs]

appliance kernel version

V
version [Guestfs.guestfs]

get the library version number

vfs_label [Guestfs.guestfs]

get the filesystem label

vfs_minimum_size [Guestfs.guestfs]

get minimum filesystem size

vfs_type [Guestfs.guestfs]

get the Linux VFS type corresponding to a mounted device

vfs_uuid [Guestfs.guestfs]

get the filesystem UUID

vg_activate [Guestfs.guestfs]

activate or deactivate some volume groups

vg_activate_all [Guestfs.guestfs]

activate or deactivate all volume groups

vgchange_uuid [Guestfs.guestfs]

generate a new random UUID for a volume group

vgchange_uuid_all [Guestfs.guestfs]

generate new random UUIDs for all volume groups

vgcreate [Guestfs.guestfs]

create an LVM volume group

vglvuuids [Guestfs.guestfs]

get the LV UUIDs of all LVs in the volume group

vgmeta [Guestfs.guestfs]

get volume group metadata

vgpvuuids [Guestfs.guestfs]

get the PV UUIDs containing the volume group

vgremove [Guestfs.guestfs]

remove an LVM volume group

vgrename [Guestfs.guestfs]

rename an LVM volume group

vgs [Guestfs.guestfs]

list the LVM volume groups (VGs)

vgs_full [Guestfs.guestfs]

list the LVM volume groups (VGs)

vgscan [Guestfs.guestfs]

rescan for LVM physical volumes, volume groups and logical volumes

vguuid [Guestfs.guestfs]

get the UUID of a volume group

W
wait_ready [Guestfs.guestfs]

wait until the hypervisor launches (no op)

wc_c [Guestfs.guestfs]

count characters in a file

wc_l [Guestfs.guestfs]

count lines in a file

wc_w [Guestfs.guestfs]

count words in a file

wipefs [Guestfs.guestfs]

wipe a filesystem signature from a device

write [Guestfs.guestfs]

create a new file

write_append [Guestfs.guestfs]

append content to end of file

write_file [Guestfs.guestfs]

create a file

X
xfs_admin [Guestfs.guestfs]

change parameters of an XFS filesystem

xfs_growfs [Guestfs.guestfs]

expand an existing XFS filesystem

xfs_info [Guestfs.guestfs]

get geometry of XFS filesystem

xfs_repair [Guestfs.guestfs]

repair an XFS filesystem

Y
yara_destroy [Guestfs.guestfs]

destroy previously loaded yara rules

yara_load [Guestfs.guestfs]

load yara rules within libguestfs

yara_scan [Guestfs.guestfs]

scan a file with the loaded yara rules

Z
zegrep [Guestfs.guestfs]

return lines matching a pattern

zegrepi [Guestfs.guestfs]

return lines matching a pattern

zero [Guestfs.guestfs]

write zeroes to the device

zero_device [Guestfs.guestfs]

write zeroes to an entire device

zero_free_space [Guestfs.guestfs]

zero free space in a filesystem

zerofree [Guestfs.guestfs]

zero unused inodes and disk blocks on ext2/3 filesystem

zfgrep [Guestfs.guestfs]

return lines matching a pattern

zfgrepi [Guestfs.guestfs]

return lines matching a pattern

zfile [Guestfs.guestfs]

determine file type inside a compressed file

zgrep [Guestfs.guestfs]

return lines matching a pattern

zgrepi [Guestfs.guestfs]

return lines matching a pattern