Index of class methods

delete the default POSIX ACL of a directory

get the POSIX ACL attached to a file

set the POSIX ACL attached to a file

add a CD-ROM disk image to examine

add the disk(s) from a named libvirt domain

add an image to examine or modify

alias for Guestfs.guestfs.add_drive

add a drive in snapshot mode (read-only)

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

add a temporary scratch drive

add a drive specifying the QEMU block emulation to use

add the disk(s) from a libvirt domain

clear Augeas path

close the current Augeas handle

define an Augeas node

define an Augeas variable

look up the value of an Augeas path

create a new Augeas handle

insert a sibling Augeas node

return the label from an Augeas path expression

load files into the tree

list Augeas nodes under augpath

return Augeas nodes which match augpath

move Augeas node

remove an Augeas path

write all pending Augeas changes to disk

set Augeas path to value

set multiple Augeas nodes

add/remove an Augeas lens transformation

test availability of some parts of the API

return a list of all optional groups

upload base64-encoded data to file

download file and encode as base64

discard all blocks on a device

return true if discarded blocks are read as zeroes

print block device attributes

flush device buffers

get blocksize of block device

is block device set to read-only

get total size of device in bytes

get sectorsize of block device

get total size of device in 512-byte sectors

reread partition table

set blocksize of block device

set readahead

set block device to read-only

set block device to read-write

cancel a running or paused balance

pause a running balance

resume a paused balance

show the status of a running or paused balance

add devices to a btrfs filesystem

remove devices from a btrfs filesystem

balance a btrfs filesystem

defragment a file or directory

resize a btrfs filesystem

list devices for btrfs filesystem

sync a btrfs filesystem

check a btrfs filesystem

create an image of a btrfs filesystem

add a qgroup to a parent qgroup

create a subvolume quota group

destroy a subvolume quota group

limit the size of a subvolume

remove a qgroup from its parent qgroup

show subvolume quota groups

enable or disable subvolume quota support

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

replace a btrfs managed device with another device

recover the chunk tree of btrfs filesystem

recover bad superblocks from good copies

cancel a running scrub

run a full scrub on a btrfs filesystem

resume a previously canceled or interrupted scrub

read all data from all disks and verify checksums

show status of running or finished scrub

enable or disable the seeding feature of device

create a btrfs subvolume

alias for Guestfs.guestfs.btrfs_subvolume_create

delete a btrfs subvolume or snapshot

get the default subvolume or snapshot of a filesystem

list btrfs snapshots and subvolumes

set default btrfs subvolume

return detailed information of the subvolume

create a btrfs snapshot

alias for Guestfs.guestfs.btrfs_subvolume_snapshot

enable extended inode refs

enable skinny metadata extent refs

enable or disable seeding of a btrfs device

return the C pointer to the guestfs_h handle

return canonical device name

get the Linux capabilities attached to a file

set the Linux capabilities attached to a file

return true path on case-insensitive filesystem

list the contents of a file

compute MD5, SHAx or CRC checksum of file

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

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

change file mode

change file owner and group

remove a single per-backend settings string

open an encrypted LUKS block device with Clevis and Tang

See Guestfs.close

run a command from the guest filesystem

run a command, returning lines

run a command from the guest filesystem

output compressed device

output compressed file

add hypervisor parameters

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

copy from source device to destination device

copy from source device to destination file

copy from source file to destination device

copy from source file to destination file

copy local files or directories into an image

copy remote files or directories out of an image

copy size bytes from source to destination using dd

copy a file

copy a file or directory recursively

copy a file or directory recursively

pack directory into cpio file

close an encrypted device

open an encrypted block device

copy from source to destination using dd

See Guestfs.delete_event_callback

convert device to index

convert device index to name

report file system disk space usage

report file system disk space usage (human readable)

create a blank disk image

detect the disk format of a disk image

return whether disk has a backing file

return virtual size of a disk

return kernel messages

download a file to the local machine

download the given data units from the disk

download a file to the local machine given its inode

download a file to the local machine with offset and size

drop kernel page cache, dentries and inodes

estimate file space usage

check an ext2/ext3 filesystem

check an ext2/ext3 filesystem

echo arguments back to the client

return lines matching a pattern

return lines matching a pattern

test if two files have equal contents

test if file or directory exists

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

expand a f2fs filesystem

preallocate a file in the guest filesystem

preallocate a file in the guest filesystem

test availability of some parts of the API

return lines matching a pattern

return lines matching a pattern

determine file type

detect the architecture of a binary file

return the size of the file in bytes

check if filesystem is available

walk through the filesystem content

fill a file with octets

fill a directory with empty files

fill a file with a repeating pattern of bytes

find all files and directories

find all files and directories, returning NUL-separated list

search the entries associated to the given inode

find a filesystem by label

find a partition by label

find a partition by UUID

find a filesystem by UUID

run the filesystem checker

trim free space in a filesystem

get the additional kernel options

get the backend

get autosync mode

get the backend

get a single per-backend settings string

get per-backend settings

get the appliance cache directory

get direct appliance mode flag

get ext2 file attributes of a file

get ext2 file generation of a file

get the ext2/3/4 filesystem label

get the ext2/3/4 filesystem UUID

get the hypervisor binary

get the handle identifier

challenge of i'th requested credential

default result of i'th requested credential

prompt of i'th requested credential

get list of credentials requested by libvirt

get memory allocated to the hypervisor

get enable network flag

get the search path

get process group flag

get PID of hypervisor

get the program name

get the hypervisor binary (usually qemu)

get recovery process enabled flag

get SELinux enabled flag

get number of virtual CPUs in appliance

get the temporary directory for sockets and PID files

get the current state

get the temporary directory

get command trace enabled flag

get the current umask

get verbose mode

get SELinux security context

get a single extended attribute

list extended attributes of a file or directory

expand a wildcard path

alias for Guestfs.guestfs.glob_expand

return lines matching a pattern

alias for Guestfs.guestfs.grep

return lines matching a pattern

install GRUB 1

return first 10 lines of a file

return first N lines of a file

dump a file in hexadecimal

close the current hivex handle

commit (write) changes back to the hive

add a child node

return list of nodes which are subkeys of node

delete a node (recursively)

return the named child of node

return the named value

return the name of the node

return the parent of node

set or replace a single value in a node

return list of values attached to node

open a Windows Registry hive file

return the root node of the hive

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

return the data field as a UTF-8 string

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

return the data field as a UTF-8 string

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

list the contents of a single file in an initrd

list files in an initrd

add an inotify watch

close the inotify handle

return list of watched files that had events

create an inotify handle

return list of inotify events

remove an inotify watch

get architecture of inspected operating system

get the system build ID

get distro of inspected operating system

get drive letter mappings

get filesystems associated with inspected operating system

get format of inspected operating system

get hostname of the operating system

get the icon corresponding to this operating system

get major version of inspected operating system

get minor version of inspected operating system

get mountpoints of inspected operating system

get a possible osinfo short ID corresponding to this operating system

get package format used by the operating system

get package management tool used by the operating system

get product name of inspected operating system

get product variant of inspected operating system

return list of operating systems found by last inspection

get type of inspected operating system

get Windows CurrentControlSet of inspected operating system

return if Windows guest has group policy

get the path of the Windows software hive

get the path of the Windows system hive

get Windows systemroot of inspected operating system

get live flag for install disk

get multipart flag for install disk

get netinst (network installer) flag for install disk

get list of applications installed in the operating system

get list of applications installed in the operating system

inspect disk and return list of operating systems found

test if block device

alias for Guestfs.guestfs.is_blockdev

is busy processing a command

test if character device

alias for Guestfs.guestfs.is_chardev

is in configuration state

test if a directory

alias for Guestfs.guestfs.is_dir

test if FIFO (named pipe)

alias for Guestfs.guestfs.is_fifo

test if a regular file

alias for Guestfs.guestfs.is_file

is launching subprocess

test if mountable is a logical volume

is ready to accept commands

test if socket

alias for Guestfs.guestfs.is_socket

test if symbolic link

test if a device is a whole device

test if a file contains all zero bytes

test if a device contains all zero bytes

get ISO information from primary volume descriptor of ISO file

get ISO information from primary volume descriptor of device

close the systemd journal

read the current journal entry

get the data threshold for reading journal entries

get the timestamp of the current journal entry

move to the next journal entry

open the systemd journal

set the data threshold for reading journal entries

skip forwards or backwards in the journal

kill the hypervisor

See Guestfs.last_errno

launch the backend

change file owner and group

scan and create Windows dynamic disk volumes

return the disks in a Windows dynamic disk group

return the name of a Windows dynamic disk group

return the volumes in a Windows dynamic disk group

remove all Windows dynamic disk volumes

scan for Windows dynamic disks

scan for Windows dynamic disks

return the hint field of a Windows dynamic disk volume

return the partitions in a Windows dynamic disk volume

return the type of a Windows dynamic disk volume

get a single extended attribute

list extended attributes of a file or directory

list 9p filesystems

list the block devices

mapping of disk labels to devices

list device mapper devices

list filesystems

list all Windows dynamic disk partitions

list all Windows dynamic disk volumes

list Linux md (RAID) devices

list the partitions

list the files in a directory (long format)

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

create a hard link

create a hard link

create a symbolic link

create a symbolic link

remove extended attribute of a file or directory

list the files in a directory

get list of files in a directory

set extended attribute of a file or directory

get file information for a symbolic link

lstat on multiple files

get file information for a symbolic link

lstat on multiple files

add a key on a LUKS encrypted device

close a LUKS device

format a block device as a LUKS encrypted device

format a block device as a LUKS encrypted device

remove a key from a LUKS encrypted device

open a LUKS-encrypted block device

open a LUKS-encrypted block device read-only

get the UUID of a LUKS device

create an LVM logical volume

create an LVM logical volume in % remaining free space

get canonical name of an LV

clear LVM device filter

remove all LVM LVs, VGs and PVs

scan for LVM physical volumes, volume groups and logical volumes

set LVM device filter

remove an LVM logical volume

rename an LVM logical volume

resize an LVM logical volume

expand an LV to fill free space

list the LVM logical volumes (LVs)

list the LVM logical volumes (LVs)

get the UUID of a logical volume

lgetxattr on multiple files

maximum number of disks that may be added

create a Linux md (RAID) device

obtain metadata for an MD device

get underlying devices from an MD device

stop a Linux md (RAID) device

create a directory

create a directory with a particular mode

create a directory and parents

create a temporary directory

create an ext2/ext3/ext4 filesystem on device

make ext2/3/4 filesystem with external journal

make ext2/3/4 filesystem with external journal

make ext2/3/4 filesystem with external journal

make ext2/3/4 external journal

make ext2/3/4 external journal with label

make ext2/3/4 external journal with UUID

make FIFO (named pipe)

make a filesystem

make a filesystem with block size

create a btrfs filesystem

alias for Guestfs.guestfs.mkfs

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

create a mountpoint

make block, character or FIFO devices

make block device node

make char device node

create a squashfs filesystem

create a swap partition

create a swap partition with a label

create a swap partition with an explicit UUID

create a swap file

alias for Guestfs.guestfs.mkswap

create a temporary file

load a kernel module

mount a guest disk at a position in the filesystem

mount 9p filesystem

mount on the local filesystem

run main loop of mount on the local filesystem

mount a file using the loop device

mount a guest disk with mount options

mount a guest disk, read-only

mount a guest disk with mount options and vfstype

extract the device part of a mountable

extract the subvolume part of a mountable

show mountpoints

show mounted filesystems

move a file

return number of whole block devices (disks) added

probe NTFS volume

change file permissions on NTFS filesystem

download a file to the local machine given its inode

restore NTFS from backup file

save NTFS to backup file

fix common errors and force Windows to check NTFS

resize an NTFS filesystem

alias for Guestfs.guestfs.ntfsresize

resize an NTFS filesystem (with size)

Return the Guestfs.t handle

parse the environment and set handle flags accordingly

parse the environment and set handle flags accordingly

add a partition to the device

delete a partition

partition whole disk with a single primary partition

move backup GPT header to the end of the disk

return true if a partition is bootable

get the GUID of a GPT-partitioned disk

get the attribute flags of a GPT partition

get the GUID of a GPT partition

get the type GUID of a GPT partition

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

get the MBR partition type

get partition name

get the partition table type

create an empty partition table

list partitions on a device

resize a partition

make a partition bootable

set the GUID of a GPT-partitioned disk

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

set the attribute flags of a GPT partition

set the GUID of a GPT partition

set the type GUID of a GPT partition

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

set partition name

convert partition name to device name

convert partition name to partition number

ping the guest daemon

read part of a file

read part of a device

generate a new random UUID for a physical volume

generate new random UUIDs for all physical volumes

create an LVM physical volume

remove an LVM physical volume

resize an LVM physical volume

resize an LVM physical volume (with size)

list the LVM physical volumes (PVs)

list the LVM physical volumes (PVs)

get the UUID of a physical volume

write to part of a file

write to part of a device

read a file

read file as lines

read directories entries

read the target of a symbolic link

readlink on multiple files

canonicalized absolute pathname

remount a filesystem with different options

remove a disk image

remove extended attribute of a file or directory

rename a file on the same filesystem

resize an ext2, ext3 or ext4 filesystem

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

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

remove a file

remove a file ignoring errors

remove a file or directory recursively

remove a directory

remove a mountpoint

synchronize the contents of two directories

synchronize host or remote filesystem with filesystem

synchronize filesystem with host or remote filesystem

scrub (securely wipe) a device

scrub (securely wipe) a file

scrub (securely wipe) free space

relabel parts of the filesystem

add options to kernel command line

set the backend

set autosync mode

set the backend

set a single per-backend settings string

replace per-backend settings strings

set the appliance cache directory

enable or disable direct appliance mode

set ext2 file attributes of a file

set ext2 file generation of a file

set the ext2/3/4 filesystem label

set the ext2/3/4 filesystem UUID

See Guestfs.set_event_callback

set the hypervisor binary

set the handle identifier

set filesystem label

pass requested credential back to libvirt

set libvirt credentials supported by calling program

set memory allocated to the hypervisor

set enable network flag

set the search path

set process group flag

set the program name

set the hypervisor binary (usually qemu)

enable or disable the recovery process

set SELinux enabled or disabled at appliance boot

set number of virtual CPUs in appliance

set the temporary directory

enable or disable command traces

set the filesystem UUID

set a random UUID for the filesystem

set verbose mode

set SELinux security context

low level relabel parts of the filesystem

set extended attribute of a file or directory

create partitions on a block device

create partitions on a block device

modify a single partition on a block device

display the disk geometry from the partition table

display the kernel geometry

display the partition table

run a command via the shell

run a command via the shell returning lines

run a command via the shell

shutdown the hypervisor

sleep for some seconds

get file information

get file information

get file system statistics

print the printable strings in a file

print the printable strings in a file

disable swap on device

disable swap on file

disable swap on labeled swap partition

disable swap on swap partition by UUID

enable swap on device

enable swap on file

enable swap on labeled swap partition

enable swap on swap partition by UUID

sync disks, writes are flushed through to the disk image

install the SYSLINUX bootloader

return last 10 lines of a file

return last N lines of a file

unpack tarfile to directory

alias for Guestfs.guestfs.tar_in

pack directory into tarfile

alias for Guestfs.guestfs.tar_out

unpack compressed tarball to directory

pack directory into compressed tarball

update file timestamps or create a new file

truncate a file to zero size

truncate a file to a particular size

adjust ext2/ext3/ext4 filesystem parameters

get ext2/ext3/ext4 superblock details

unpack compressed tarball to directory

pack directory into compressed tarball

set file mode creation mask (umask)

unmount a filesystem

unmount all filesystems

unmount a locally mounted filesystem

alias for Guestfs.guestfs.umount

upload a file from the local machine

upload a file from the local machine with offset

cancel the current upload or download operation

set timestamp of a file with nanosecond precision

appliance kernel version

get the library version number

get the filesystem label

get minimum filesystem size

get the Linux VFS type corresponding to a mounted device

get the filesystem UUID

activate or deactivate some volume groups

activate or deactivate all volume groups

generate a new random UUID for a volume group

generate new random UUIDs for all volume groups

create an LVM volume group

get the LV UUIDs of all LVs in the volume group

get volume group metadata

get the PV UUIDs containing the volume group

remove an LVM volume group

rename an LVM volume group

list the LVM volume groups (VGs)

list the LVM volume groups (VGs)

rescan for LVM physical volumes, volume groups and logical volumes

get the UUID of a volume group

wait until the hypervisor launches (no op)

count characters in a file

count lines in a file

count words in a file

wipe a filesystem signature from a device

create a new file

append content to end of file

create a file

change parameters of an XFS filesystem

expand an existing XFS filesystem

get information about the XFS filesystem

get information about the XFS filesystem

repair an XFS filesystem

destroy previously loaded yara rules

load yara rules within libguestfs

scan a file with the loaded yara rules

return lines matching a pattern

return lines matching a pattern

write zeroes to the device

write zeroes to an entire device

zero free space in a filesystem

zero unused inodes and disk blocks on ext2/3 filesystem

return lines matching a pattern

return lines matching a pattern

determine file type inside a compressed file

return lines matching a pattern

return lines matching a pattern