A | |
acl_delete_def_file [Guestfs] |
delete the default POSIX ACL of a directory
|
acl_get_file [Guestfs] |
get the POSIX ACL attached to a file
|
acl_set_file [Guestfs] |
set the POSIX ACL attached to a file
|
add_cdrom [Guestfs] |
add a CD-ROM disk image to examine
|
add_domain [Guestfs] |
add the disk(s) from a named libvirt domain
|
add_drive [Guestfs] |
add an image to examine or modify
|
add_drive_opts [Guestfs] |
alias for
Guestfs.add_drive
|
add_drive_ro [Guestfs] |
add a drive in snapshot mode (read-only)
|
add_drive_ro_with_if [Guestfs] |
add a drive read-only specifying the QEMU block emulation to use
|
add_drive_scratch [Guestfs] |
add a temporary scratch drive
|
add_drive_with_if [Guestfs] |
add a drive specifying the QEMU block emulation to use
|
add_libvirt_dom [Guestfs] |
add the disk(s) from a libvirt domain
|
aug_clear [Guestfs] |
clear Augeas path
|
aug_close [Guestfs] |
close the current Augeas handle
|
aug_defnode [Guestfs] |
define an Augeas node
|
aug_defvar [Guestfs] |
define an Augeas variable
|
aug_get [Guestfs] |
look up the value of an Augeas path
|
aug_init [Guestfs] |
create a new Augeas handle
|
aug_insert [Guestfs] |
insert a sibling Augeas node
|
aug_label [Guestfs] |
return the label from an Augeas path expression
|
aug_load [Guestfs] |
load files into the tree
|
aug_ls [Guestfs] |
list Augeas nodes under augpath
|
aug_match [Guestfs] |
return Augeas nodes which match augpath
|
aug_mv [Guestfs] |
move Augeas node
|
aug_rm [Guestfs] |
remove an Augeas path
|
aug_save [Guestfs] |
write all pending Augeas changes to disk
|
aug_set [Guestfs] |
set Augeas path to value
|
aug_setm [Guestfs] |
set multiple Augeas nodes
|
aug_transform [Guestfs] |
add/remove an Augeas lens transformation
|
available [Guestfs] |
test availability of some parts of the API
|
available_all_groups [Guestfs] |
return a list of all optional groups
|
B | |
base64_in [Guestfs] |
upload base64-encoded data to file
|
base64_out [Guestfs] |
download file and encode as base64
|
blkdiscard [Guestfs] |
discard all blocks on a device
|
blkdiscardzeroes [Guestfs] |
return true if discarded blocks are read as zeroes
|
blkid [Guestfs] |
print block device attributes
|
blockdev_flushbufs [Guestfs] |
flush device buffers
|
blockdev_getbsz [Guestfs] |
get blocksize of block device
|
blockdev_getro [Guestfs] |
is block device set to read-only
|
blockdev_getsize64 [Guestfs] |
get total size of device in bytes
|
blockdev_getss [Guestfs] |
get sectorsize of block device
|
blockdev_getsz [Guestfs] |
get total size of device in 512-byte sectors
|
blockdev_rereadpt [Guestfs] |
reread partition table
|
blockdev_setbsz [Guestfs] |
set blocksize of block device
|
blockdev_setra [Guestfs] |
set readahead
|
blockdev_setro [Guestfs] |
set block device to read-only
|
blockdev_setrw [Guestfs] |
set block device to read-write
|
btrfs_balance_cancel [Guestfs] |
cancel a running or paused balance
|
btrfs_balance_pause [Guestfs] |
pause a running balance
|
btrfs_balance_resume [Guestfs] |
resume a paused balance
|
btrfs_balance_status [Guestfs] |
show the status of a running or paused balance
|
btrfs_device_add [Guestfs] |
add devices to a btrfs filesystem
|
btrfs_device_delete [Guestfs] |
remove devices from a btrfs filesystem
|
btrfs_filesystem_balance [Guestfs] |
balance a btrfs filesystem
|
btrfs_filesystem_defragment [Guestfs] |
defragment a file or directory
|
btrfs_filesystem_resize [Guestfs] |
resize a btrfs filesystem
|
btrfs_filesystem_show [Guestfs] |
list devices for btrfs filesystem
|
btrfs_filesystem_sync [Guestfs] |
sync a btrfs filesystem
|
btrfs_fsck [Guestfs] |
check a btrfs filesystem
|
btrfs_image [Guestfs] |
create an image of a btrfs filesystem
|
btrfs_qgroup_assign [Guestfs] |
add a qgroup to a parent qgroup
|
btrfs_qgroup_create [Guestfs] |
create a subvolume quota group
|
btrfs_qgroup_destroy [Guestfs] |
destroy a subvolume quota group
|
btrfs_qgroup_limit [Guestfs] |
limit the size of a subvolume
|
btrfs_qgroup_remove [Guestfs] |
remove a qgroup from its parent qgroup
|
btrfs_qgroup_show [Guestfs] |
show subvolume quota groups
|
btrfs_quota_enable [Guestfs] |
enable or disable subvolume quota support
|
btrfs_quota_rescan [Guestfs] |
trash all qgroup numbers and scan the metadata again with the current config
|
btrfs_replace [Guestfs] |
replace a btrfs managed device with another device
|
btrfs_rescue_chunk_recover [Guestfs] |
recover the chunk tree of btrfs filesystem
|
btrfs_rescue_super_recover [Guestfs] |
recover bad superblocks from good copies
|
btrfs_scrub_cancel [Guestfs] |
cancel a running scrub
|
btrfs_scrub_resume [Guestfs] |
resume a previously canceled or interrupted scrub
|
btrfs_scrub_start [Guestfs] |
read all data from all disks and verify checksums
|
btrfs_scrub_status [Guestfs] |
show status of running or finished scrub
|
btrfs_set_seeding [Guestfs] |
enable or disable the seeding feature of device
|
btrfs_subvolume_create [Guestfs] |
create a btrfs subvolume
|
btrfs_subvolume_create_opts [Guestfs] |
alias for
Guestfs.btrfs_subvolume_create
|
btrfs_subvolume_delete [Guestfs] |
delete a btrfs subvolume or snapshot
|
btrfs_subvolume_get_default [Guestfs] |
get the default subvolume or snapshot of a filesystem
|
btrfs_subvolume_list [Guestfs] |
list btrfs snapshots and subvolumes
|
btrfs_subvolume_set_default [Guestfs] |
set default btrfs subvolume
|
btrfs_subvolume_show [Guestfs] |
return detailed information of the subvolume
|
btrfs_subvolume_snapshot [Guestfs] |
create a btrfs snapshot
|
btrfs_subvolume_snapshot_opts [Guestfs] |
alias for
Guestfs.btrfs_subvolume_snapshot
|
btrfstune_enable_extended_inode_refs [Guestfs] |
enable extended inode refs
|
btrfstune_enable_skinny_metadata_extent_refs [Guestfs] |
enable skinny metadata extent refs
|
btrfstune_seeding [Guestfs] |
enable or disable seeding of a btrfs device
|
C | |
c_pointer [Guestfs] |
return the C pointer to the guestfs_h handle
|
canonical_device_name [Guestfs] |
return canonical device name
|
cap_get_file [Guestfs] |
get the Linux capabilities attached to a file
|
cap_set_file [Guestfs] |
set the Linux capabilities attached to a file
|
case_sensitive_path [Guestfs] |
return true path on case-insensitive filesystem
|
cat [Guestfs] |
list the contents of a file
|
checksum [Guestfs] |
compute MD5, SHAx or CRC checksum of file
|
checksum_device [Guestfs] |
compute MD5, SHAx or CRC checksum of the contents of a device
|
checksums_out [Guestfs] |
compute MD5, SHAx or CRC checksum of files in a directory
|
chmod [Guestfs] |
change file mode
|
chown [Guestfs] |
change file owner and group
|
clear_backend_setting [Guestfs] |
remove a single per-backend settings string
|
close [Guestfs] |
Close the
Guestfs.t handle and free up all resources used
by it immediately.
|
command [Guestfs] |
run a command from the guest filesystem
|
command_lines [Guestfs] |
run a command, returning lines
|
compress_device_out [Guestfs] |
output compressed device
|
compress_out [Guestfs] |
output compressed file
|
config [Guestfs] |
add hypervisor parameters
|
copy_attributes [Guestfs] |
copy the attributes of a path (file/directory) to another
|
copy_device_to_device [Guestfs] |
copy from source device to destination device
|
copy_device_to_file [Guestfs] |
copy from source device to destination file
|
copy_file_to_device [Guestfs] |
copy from source file to destination device
|
copy_file_to_file [Guestfs] |
copy from source file to destination file
|
copy_in [Guestfs] |
copy local files or directories into an image
|
copy_out [Guestfs] |
copy remote files or directories out of an image
|
copy_size [Guestfs] |
copy size bytes from source to destination using dd
|
cp [Guestfs] |
copy a file
|
cp_a [Guestfs] |
copy a file or directory recursively
|
cp_r [Guestfs] |
copy a file or directory recursively
|
cpio_out [Guestfs] |
pack directory into cpio file
|
create [Guestfs] |
Create a
Guestfs.t handle.
|
D | |
dd [Guestfs] |
copy from source to destination using dd
|
delete_event_callback [Guestfs] | delete_event_callback g eh removes a previously registered
event callback.
|
device_index [Guestfs] |
convert device to index
|
df [Guestfs] |
report file system disk space usage
|
df_h [Guestfs] |
report file system disk space usage (human readable)
|
disk_create [Guestfs] |
create a blank disk image
|
disk_format [Guestfs] |
detect the disk format of a disk image
|
disk_has_backing_file [Guestfs] |
return whether disk has a backing file
|
disk_virtual_size [Guestfs] |
return virtual size of a disk
|
dmesg [Guestfs] |
return kernel messages
|
download [Guestfs] |
download a file to the local machine
|
download_blocks [Guestfs] |
download the given data units from the disk
|
download_inode [Guestfs] |
download a file to the local machine given its inode
|
download_offset [Guestfs] |
download a file to the local machine with offset and size
|
drop_caches [Guestfs] |
drop kernel page cache, dentries and inodes
|
du [Guestfs] |
estimate file space usage
|
E | |
e2fsck [Guestfs] |
check an ext2/ext3 filesystem
|
e2fsck_f [Guestfs] |
check an ext2/ext3 filesystem
|
echo_daemon [Guestfs] |
echo arguments back to the client
|
egrep [Guestfs] |
return lines matching a pattern
|
egrepi [Guestfs] |
return lines matching a pattern
|
equal [Guestfs] |
test if two files have equal contents
|
errno_EINVAL [Guestfs.Errno] |
Integer value of errno
EINVAL .
|
errno_ENOENT [Guestfs.Errno] |
Integer value of errno
ENOENT .
|
errno_ENOTSUP [Guestfs.Errno] |
Integer value of errno
ENOTSUP .
|
errno_EPERM [Guestfs.Errno] |
Integer value of errno
EPERM .
|
errno_EROFS [Guestfs.Errno] |
Integer value of errno
EROFS .
|
errno_ESRCH [Guestfs.Errno] |
Integer value of errno
ESRCH .
|
event_all [Guestfs] |
A list containing all event types.
|
event_to_string [Guestfs] | event_to_string events returns the event(s) as a printable string
for debugging etc.
|
exists [Guestfs] |
test if file or directory exists
|
extlinux [Guestfs] |
install the SYSLINUX bootloader on an ext2/3/4 or btrfs filesystem
|
F | |
fallocate [Guestfs] |
preallocate a file in the guest filesystem
|
fallocate64 [Guestfs] |
preallocate a file in the guest filesystem
|
feature_available [Guestfs] |
test availability of some parts of the API
|
fgrep [Guestfs] |
return lines matching a pattern
|
fgrepi [Guestfs] |
return lines matching a pattern
|
file [Guestfs] |
determine file type
|
file_architecture [Guestfs] |
detect the architecture of a binary file
|
filesize [Guestfs] |
return the size of the file in bytes
|
filesystem_available [Guestfs] |
check if filesystem is available
|
filesystem_walk [Guestfs] |
walk through the filesystem content
|
fill [Guestfs] |
fill a file with octets
|
fill_dir [Guestfs] |
fill a directory with empty files
|
fill_pattern [Guestfs] |
fill a file with a repeating pattern of bytes
|
find [Guestfs] |
find all files and directories
|
find0 [Guestfs] |
find all files and directories, returning NUL-separated list
|
find_inode [Guestfs] |
search the entries associated to the given inode
|
findfs_label [Guestfs] |
find a filesystem by label
|
findfs_uuid [Guestfs] |
find a filesystem by UUID
|
fsck [Guestfs] |
run the filesystem checker
|
fstrim [Guestfs] |
trim free space in a filesystem
|
G | |
get_append [Guestfs] |
get the additional kernel options
|
get_attach_method [Guestfs] |
get the backend
|
get_autosync [Guestfs] |
get autosync mode
|
get_backend [Guestfs] |
get the backend
|
get_backend_setting [Guestfs] |
get a single per-backend settings string
|
get_backend_settings [Guestfs] |
get per-backend settings
|
get_cachedir [Guestfs] |
get the appliance cache directory
|
get_direct [Guestfs] |
get direct appliance mode flag
|
get_e2attrs [Guestfs] |
get ext2 file attributes of a file
|
get_e2generation [Guestfs] |
get ext2 file generation of a file
|
get_e2label [Guestfs] |
get the ext2/3/4 filesystem label
|
get_e2uuid [Guestfs] |
get the ext2/3/4 filesystem UUID
|
get_hv [Guestfs] |
get the hypervisor binary
|
get_identifier [Guestfs] |
get the handle identifier
|
get_libvirt_requested_credential_challenge [Guestfs] |
challenge of i'th requested credential
|
get_libvirt_requested_credential_defresult [Guestfs] |
default result of i'th requested credential
|
get_libvirt_requested_credential_prompt [Guestfs] |
prompt of i'th requested credential
|
get_libvirt_requested_credentials [Guestfs] |
get list of credentials requested by libvirt
|
get_memsize [Guestfs] |
get memory allocated to the hypervisor
|
get_network [Guestfs] |
get enable network flag
|
get_path [Guestfs] |
get the search path
|
get_pgroup [Guestfs] |
get process group flag
|
get_pid [Guestfs] |
get PID of hypervisor
|
get_program [Guestfs] |
get the program name
|
get_qemu [Guestfs] |
get the hypervisor binary (usually qemu)
|
get_recovery_proc [Guestfs] |
get recovery process enabled flag
|
get_selinux [Guestfs] |
get SELinux enabled flag
|
get_smp [Guestfs] |
get number of virtual CPUs in appliance
|
get_sockdir [Guestfs] |
get the temporary directory for sockets
|
get_state [Guestfs] |
get the current state
|
get_tmpdir [Guestfs] |
get the temporary directory
|
get_trace [Guestfs] |
get command trace enabled flag
|
get_umask [Guestfs] |
get the current umask
|
get_verbose [Guestfs] |
get verbose mode
|
getcon [Guestfs] |
get SELinux security context
|
getxattr [Guestfs] |
get a single extended attribute
|
getxattrs [Guestfs] |
list extended attributes of a file or directory
|
glob_expand [Guestfs] |
expand a wildcard path
|
glob_expand_opts [Guestfs] |
alias for
Guestfs.glob_expand
|
grep [Guestfs] |
return lines matching a pattern
|
grep_opts [Guestfs] |
alias for
Guestfs.grep
|
grepi [Guestfs] |
return lines matching a pattern
|
grub_install [Guestfs] |
install GRUB 1
|
H | |
head [Guestfs] |
return first 10 lines of a file
|
head_n [Guestfs] |
return first N lines of a file
|
hexdump [Guestfs] |
dump a file in hexadecimal
|
hivex_close [Guestfs] |
close the current hivex handle
|
hivex_commit [Guestfs] |
commit (write) changes back to the hive
|
hivex_node_add_child [Guestfs] |
add a child node
|
hivex_node_children [Guestfs] |
return list of nodes which are subkeys of node
|
hivex_node_delete_child [Guestfs] |
delete a node (recursively)
|
hivex_node_get_child [Guestfs] |
return the named child of node
|
hivex_node_get_value [Guestfs] |
return the named value
|
hivex_node_name [Guestfs] |
return the name of the node
|
hivex_node_parent [Guestfs] |
return the parent of node
|
hivex_node_set_value [Guestfs] |
set or replace a single value in a node
|
hivex_node_values [Guestfs] |
return list of values attached to node
|
hivex_open [Guestfs] |
open a Windows Registry hive file
|
hivex_root [Guestfs] |
return the root node of the hive
|
hivex_value_key [Guestfs] |
return the key field from the (key, datatype, data) tuple
|
hivex_value_string [Guestfs] |
return the data field as a UTF-8 string
|
hivex_value_type [Guestfs] |
return the data type from the (key, datatype, data) tuple
|
hivex_value_utf8 [Guestfs] |
return the data field as a UTF-8 string
|
hivex_value_value [Guestfs] |
return the data field from the (key, datatype, data) tuple
|
I | |
initrd_cat [Guestfs] |
list the contents of a single file in an initrd
|
initrd_list [Guestfs] |
list files in an initrd
|
inotify_add_watch [Guestfs] |
add an inotify watch
|
inotify_close [Guestfs] |
close the inotify handle
|
inotify_files [Guestfs] |
return list of watched files that had events
|
inotify_init [Guestfs] |
create an inotify handle
|
inotify_read [Guestfs] |
return list of inotify events
|
inotify_rm_watch [Guestfs] |
remove an inotify watch
|
inspect_get_arch [Guestfs] |
get architecture of inspected operating system
|
inspect_get_distro [Guestfs] |
get distro of inspected operating system
|
inspect_get_drive_mappings [Guestfs] |
get drive letter mappings
|
inspect_get_filesystems [Guestfs] |
get filesystems associated with inspected operating system
|
inspect_get_format [Guestfs] |
get format of inspected operating system
|
inspect_get_hostname [Guestfs] |
get hostname of the operating system
|
inspect_get_icon [Guestfs] |
get the icon corresponding to this operating system
|
inspect_get_major_version [Guestfs] |
get major version of inspected operating system
|
inspect_get_minor_version [Guestfs] |
get minor version of inspected operating system
|
inspect_get_mountpoints [Guestfs] |
get mountpoints of inspected operating system
|
inspect_get_osinfo [Guestfs] |
get a possible osinfo short ID corresponding to this operating system
|
inspect_get_package_format [Guestfs] |
get package format used by the operating system
|
inspect_get_package_management [Guestfs] |
get package management tool used by the operating system
|
inspect_get_product_name [Guestfs] |
get product name of inspected operating system
|
inspect_get_product_variant [Guestfs] |
get product variant of inspected operating system
|
inspect_get_roots [Guestfs] |
return list of operating systems found by last inspection
|
inspect_get_type [Guestfs] |
get type of inspected operating system
|
inspect_get_windows_current_control_set [Guestfs] |
get Windows CurrentControlSet of inspected operating system
|
inspect_get_windows_software_hive [Guestfs] |
get the path of the Windows software hive
|
inspect_get_windows_system_hive [Guestfs] |
get the path of the Windows system hive
|
inspect_get_windows_systemroot [Guestfs] |
get Windows systemroot of inspected operating system
|
inspect_is_live [Guestfs] |
get live flag for install disk
|
inspect_is_multipart [Guestfs] |
get multipart flag for install disk
|
inspect_is_netinst [Guestfs] |
get netinst (network installer) flag for install disk
|
inspect_list_applications [Guestfs] |
get list of applications installed in the operating system
|
inspect_list_applications2 [Guestfs] |
get list of applications installed in the operating system
|
inspect_os [Guestfs] |
inspect disk and return list of operating systems found
|
is_blockdev [Guestfs] |
test if block device
|
is_blockdev_opts [Guestfs] |
alias for
Guestfs.is_blockdev
|
is_busy [Guestfs] |
is busy processing a command
|
is_chardev [Guestfs] |
test if character device
|
is_chardev_opts [Guestfs] |
alias for
Guestfs.is_chardev
|
is_config [Guestfs] |
is in configuration state
|
is_dir [Guestfs] |
test if a directory
|
is_dir_opts [Guestfs] |
alias for
Guestfs.is_dir
|
is_fifo [Guestfs] |
test if FIFO (named pipe)
|
is_fifo_opts [Guestfs] |
alias for
Guestfs.is_fifo
|
is_file [Guestfs] |
test if a regular file
|
is_file_opts [Guestfs] |
alias for
Guestfs.is_file
|
is_launching [Guestfs] |
is launching subprocess
|
is_lv [Guestfs] |
test if mountable is a logical volume
|
is_ready [Guestfs] |
is ready to accept commands
|
is_socket [Guestfs] |
test if socket
|
is_socket_opts [Guestfs] |
alias for
Guestfs.is_socket
|
is_symlink [Guestfs] |
test if symbolic link
|
is_whole_device [Guestfs] |
test if a device is a whole device
|
is_zero [Guestfs] |
test if a file contains all zero bytes
|
is_zero_device [Guestfs] |
test if a device contains all zero bytes
|
isoinfo [Guestfs] |
get ISO information from primary volume descriptor of ISO file
|
isoinfo_device [Guestfs] |
get ISO information from primary volume descriptor of device
|
J | |
journal_close [Guestfs] |
close the systemd journal
|
journal_get [Guestfs] |
read the current journal entry
|
journal_get_data_threshold [Guestfs] |
get the data threshold for reading journal entries
|
journal_get_realtime_usec [Guestfs] |
get the timestamp of the current journal entry
|
journal_next [Guestfs] |
move to the next journal entry
|
journal_open [Guestfs] |
open the systemd journal
|
journal_set_data_threshold [Guestfs] |
set the data threshold for reading journal entries
|
journal_skip [Guestfs] |
skip forwards or backwards in the journal
|
K | |
kill_subprocess [Guestfs] |
kill the hypervisor
|
L | |
last_errno [Guestfs] | last_errno g returns the last errno that happened on the handle g
(or 0 if there was no errno).
|
launch [Guestfs] |
launch the backend
|
lchown [Guestfs] |
change file owner and group
|
ldmtool_create_all [Guestfs] |
scan and create Windows dynamic disk volumes
|
ldmtool_diskgroup_disks [Guestfs] |
return the disks in a Windows dynamic disk group
|
ldmtool_diskgroup_name [Guestfs] |
return the name of a Windows dynamic disk group
|
ldmtool_diskgroup_volumes [Guestfs] |
return the volumes in a Windows dynamic disk group
|
ldmtool_remove_all [Guestfs] |
remove all Windows dynamic disk volumes
|
ldmtool_scan [Guestfs] |
scan for Windows dynamic disks
|
ldmtool_scan_devices [Guestfs] |
scan for Windows dynamic disks
|
ldmtool_volume_hint [Guestfs] |
return the hint field of a Windows dynamic disk volume
|
ldmtool_volume_partitions [Guestfs] |
return the partitions in a Windows dynamic disk volume
|
ldmtool_volume_type [Guestfs] |
return the type of a Windows dynamic disk volume
|
lgetxattr [Guestfs] |
get a single extended attribute
|
lgetxattrs [Guestfs] |
list extended attributes of a file or directory
|
list_devices [Guestfs] |
list the block devices
|
list_disk_labels [Guestfs] |
mapping of disk labels to devices
|
list_dm_devices [Guestfs] |
list device mapper devices
|
list_filesystems [Guestfs] |
list filesystems
|
list_ldm_partitions [Guestfs] |
list all Windows dynamic disk partitions
|
list_ldm_volumes [Guestfs] |
list all Windows dynamic disk volumes
|
list_md_devices [Guestfs] |
list Linux md (RAID) devices
|
list_partitions [Guestfs] |
list the partitions
|
ll [Guestfs] |
list the files in a directory (long format)
|
llz [Guestfs] |
list the files in a directory (long format with SELinux contexts)
|
ln [Guestfs] |
create a hard link
|
ln_f [Guestfs] |
create a hard link
|
ln_s [Guestfs] |
create a symbolic link
|
ln_sf [Guestfs] |
create a symbolic link
|
lremovexattr [Guestfs] |
remove extended attribute of a file or directory
|
ls [Guestfs] |
list the files in a directory
|
ls0 [Guestfs] |
get list of files in a directory
|
lsetxattr [Guestfs] |
set extended attribute of a file or directory
|
lstat [Guestfs] |
get file information for a symbolic link
|
lstatlist [Guestfs] |
lstat on multiple files
|
lstatns [Guestfs] |
get file information for a symbolic link
|
lstatnslist [Guestfs] |
lstat on multiple files
|
luks_add_key [Guestfs] |
add a key on a LUKS encrypted device
|
luks_close [Guestfs] |
close a LUKS device
|
luks_format [Guestfs] |
format a block device as a LUKS encrypted device
|
luks_format_cipher [Guestfs] |
format a block device as a LUKS encrypted device
|
luks_kill_slot [Guestfs] |
remove a key from a LUKS encrypted device
|
luks_open [Guestfs] |
open a LUKS-encrypted block device
|
luks_open_ro [Guestfs] |
open a LUKS-encrypted block device read-only
|
lvcreate [Guestfs] |
create an LVM logical volume
|
lvcreate_free [Guestfs] |
create an LVM logical volume in % remaining free space
|
lvm_canonical_lv_name [Guestfs] |
get canonical name of an LV
|
lvm_clear_filter [Guestfs] |
clear LVM device filter
|
lvm_remove_all [Guestfs] |
remove all LVM LVs, VGs and PVs
|
lvm_set_filter [Guestfs] |
set LVM device filter
|
lvremove [Guestfs] |
remove an LVM logical volume
|
lvrename [Guestfs] |
rename an LVM logical volume
|
lvresize [Guestfs] |
resize an LVM logical volume
|
lvresize_free [Guestfs] |
expand an LV to fill free space
|
lvs [Guestfs] |
list the LVM logical volumes (LVs)
|
lvs_full [Guestfs] |
list the LVM logical volumes (LVs)
|
lvuuid [Guestfs] |
get the UUID of a logical volume
|
lxattrlist [Guestfs] |
lgetxattr on multiple files
|
M | |
max_disks [Guestfs] |
maximum number of disks that may be added
|
md_create [Guestfs] |
create a Linux md (RAID) device
|
md_detail [Guestfs] |
obtain metadata for an MD device
|
md_stat [Guestfs] |
get underlying devices from an MD device
|
md_stop [Guestfs] |
stop a Linux md (RAID) device
|
mkdir [Guestfs] |
create a directory
|
mkdir_mode [Guestfs] |
create a directory with a particular mode
|
mkdir_p [Guestfs] |
create a directory and parents
|
mkdtemp [Guestfs] |
create a temporary directory
|
mke2fs [Guestfs] |
create an ext2/ext3/ext4 filesystem on device
|
mke2fs_J [Guestfs] |
make ext2/3/4 filesystem with external journal
|
mke2fs_JL [Guestfs] |
make ext2/3/4 filesystem with external journal
|
mke2fs_JU [Guestfs] |
make ext2/3/4 filesystem with external journal
|
mke2journal [Guestfs] |
make ext2/3/4 external journal
|
mke2journal_L [Guestfs] |
make ext2/3/4 external journal with label
|
mke2journal_U [Guestfs] |
make ext2/3/4 external journal with UUID
|
mkfifo [Guestfs] |
make FIFO (named pipe)
|
mkfs [Guestfs] |
make a filesystem
|
mkfs_b [Guestfs] |
make a filesystem with block size
|
mkfs_btrfs [Guestfs] |
create a btrfs filesystem
|
mkfs_opts [Guestfs] |
alias for
Guestfs.mkfs
|
mklost_and_found [Guestfs] |
make lost+found directory on an ext2/3/4 filesystem
|
mkmountpoint [Guestfs] |
create a mountpoint
|
mknod [Guestfs] |
make block, character or FIFO devices
|
mknod_b [Guestfs] |
make block device node
|
mknod_c [Guestfs] |
make char device node
|
mksquashfs [Guestfs] |
create a squashfs filesystem
|
mkswap [Guestfs] |
create a swap partition
|
mkswap_L [Guestfs] |
create a swap partition with a label
|
mkswap_U [Guestfs] |
create a swap partition with an explicit UUID
|
mkswap_file [Guestfs] |
create a swap file
|
mkswap_opts [Guestfs] |
alias for
Guestfs.mkswap
|
mktemp [Guestfs] |
create a temporary file
|
modprobe [Guestfs] |
load a kernel module
|
mount [Guestfs] |
mount a guest disk at a position in the filesystem
|
mount_local [Guestfs] |
mount on the local filesystem
|
mount_local_run [Guestfs] |
run main loop of mount on the local filesystem
|
mount_loop [Guestfs] |
mount a file using the loop device
|
mount_options [Guestfs] |
mount a guest disk with mount options
|
mount_ro [Guestfs] |
mount a guest disk, read-only
|
mount_vfs [Guestfs] |
mount a guest disk with mount options and vfstype
|
mountable_device [Guestfs] |
extract the device part of a mountable
|
mountable_subvolume [Guestfs] |
extract the subvolume part of a mountable
|
mountpoints [Guestfs] |
show mountpoints
|
mounts [Guestfs] |
show mounted filesystems
|
mv [Guestfs] |
move a file
|
N | |
nr_devices [Guestfs] |
return number of whole block devices (disks) added
|
ntfs_3g_probe [Guestfs] |
probe NTFS volume
|
ntfscat_i [Guestfs] |
download a file to the local machine given its inode
|
ntfsclone_in [Guestfs] |
restore NTFS from backup file
|
ntfsclone_out [Guestfs] |
save NTFS to backup file
|
ntfsfix [Guestfs] |
fix common errors and force Windows to check NTFS
|
ntfsresize [Guestfs] |
resize an NTFS filesystem
|
ntfsresize_opts [Guestfs] |
alias for
Guestfs.ntfsresize
|
ntfsresize_size [Guestfs] |
resize an NTFS filesystem (with size)
|
P | |
parse_environment [Guestfs] |
parse the environment and set handle flags accordingly
|
parse_environment_list [Guestfs] |
parse the environment and set handle flags accordingly
|
part_add [Guestfs] |
add a partition to the device
|
part_del [Guestfs] |
delete a partition
|
part_disk [Guestfs] |
partition whole disk with a single primary partition
|
part_expand_gpt [Guestfs] |
move backup GPT header to the end of the disk
|
part_get_bootable [Guestfs] |
return true if a partition is bootable
|
part_get_disk_guid [Guestfs] |
get the GUID of a GPT-partitioned disk
|
part_get_gpt_attributes [Guestfs] |
get the attribute flags of a GPT partition
|
part_get_gpt_guid [Guestfs] |
get the GUID of a GPT partition
|
part_get_gpt_type [Guestfs] |
get the type GUID of a GPT partition
|
part_get_mbr_id [Guestfs] |
get the MBR type byte (ID byte) from a partition
|
part_get_mbr_part_type [Guestfs] |
get the MBR partition type
|
part_get_name [Guestfs] |
get partition name
|
part_get_parttype [Guestfs] |
get the partition table type
|
part_init [Guestfs] |
create an empty partition table
|
part_list [Guestfs] |
list partitions on a device
|
part_resize [Guestfs] |
resize a partition
|
part_set_bootable [Guestfs] |
make a partition bootable
|
part_set_disk_guid [Guestfs] |
set the GUID of a GPT-partitioned disk
|
part_set_disk_guid_random [Guestfs] |
set the GUID of a GPT-partitioned disk to random value
|
part_set_gpt_attributes [Guestfs] |
set the attribute flags of a GPT partition
|
part_set_gpt_guid [Guestfs] |
set the GUID of a GPT partition
|
part_set_gpt_type [Guestfs] |
set the type GUID of a GPT partition
|
part_set_mbr_id [Guestfs] |
set the MBR type byte (ID byte) of a partition
|
part_set_name [Guestfs] |
set partition name
|
part_to_dev [Guestfs] |
convert partition name to device name
|
part_to_partnum [Guestfs] |
convert partition name to partition number
|
ping_daemon [Guestfs] |
ping the guest daemon
|
pread [Guestfs] |
read part of a file
|
pread_device [Guestfs] |
read part of a device
|
pvchange_uuid [Guestfs] |
generate a new random UUID for a physical volume
|
pvchange_uuid_all [Guestfs] |
generate new random UUIDs for all physical volumes
|
pvcreate [Guestfs] |
create an LVM physical volume
|
pvremove [Guestfs] |
remove an LVM physical volume
|
pvresize [Guestfs] |
resize an LVM physical volume
|
pvresize_size [Guestfs] |
resize an LVM physical volume (with size)
|
pvs [Guestfs] |
list the LVM physical volumes (PVs)
|
pvs_full [Guestfs] |
list the LVM physical volumes (PVs)
|
pvuuid [Guestfs] |
get the UUID of a physical volume
|
pwrite [Guestfs] |
write to part of a file
|
pwrite_device [Guestfs] |
write to part of a device
|
R | |
read_file [Guestfs] |
read a file
|
read_lines [Guestfs] |
read file as lines
|
readdir [Guestfs] |
read directories entries
|
readlink [Guestfs] |
read the target of a symbolic link
|
readlinklist [Guestfs] |
readlink on multiple files
|
realpath [Guestfs] |
canonicalized absolute pathname
|
remount [Guestfs] |
remount a filesystem with different options
|
remove_drive [Guestfs] |
remove a disk image
|
removexattr [Guestfs] |
remove extended attribute of a file or directory
|
rename [Guestfs] |
rename a file on the same filesystem
|
resize2fs [Guestfs] |
resize an ext2, ext3 or ext4 filesystem
|
resize2fs_M [Guestfs] |
resize an ext2, ext3 or ext4 filesystem to the minimum size
|
resize2fs_size [Guestfs] |
resize an ext2, ext3 or ext4 filesystem (with size)
|
rm [Guestfs] |
remove a file
|
rm_f [Guestfs] |
remove a file ignoring errors
|
rm_rf [Guestfs] |
remove a file or directory recursively
|
rmdir [Guestfs] |
remove a directory
|
rmmountpoint [Guestfs] |
remove a mountpoint
|
rsync [Guestfs] |
synchronize the contents of two directories
|
rsync_in [Guestfs] |
synchronize host or remote filesystem with filesystem
|
rsync_out [Guestfs] |
synchronize filesystem with host or remote filesystem
|
S | |
scrub_device [Guestfs] |
scrub (securely wipe) a device
|
scrub_file [Guestfs] |
scrub (securely wipe) a file
|
scrub_freespace [Guestfs] |
scrub (securely wipe) free space
|
selinux_relabel [Guestfs] |
relabel parts of the filesystem
|
set_append [Guestfs] |
add options to kernel command line
|
set_attach_method [Guestfs] |
set the backend
|
set_autosync [Guestfs] |
set autosync mode
|
set_backend [Guestfs] |
set the backend
|
set_backend_setting [Guestfs] |
set a single per-backend settings string
|
set_backend_settings [Guestfs] |
replace per-backend settings strings
|
set_cachedir [Guestfs] |
set the appliance cache directory
|
set_direct [Guestfs] |
enable or disable direct appliance mode
|
set_e2attrs [Guestfs] |
set ext2 file attributes of a file
|
set_e2generation [Guestfs] |
set ext2 file generation of a file
|
set_e2label [Guestfs] |
set the ext2/3/4 filesystem label
|
set_e2uuid [Guestfs] |
set the ext2/3/4 filesystem UUID
|
set_event_callback [Guestfs] | set_event_callback g f es sets f as the event callback function
for all events in the set es .
|
set_hv [Guestfs] |
set the hypervisor binary
|
set_identifier [Guestfs] |
set the handle identifier
|
set_label [Guestfs] |
set filesystem label
|
set_libvirt_requested_credential [Guestfs] |
pass requested credential back to libvirt
|
set_libvirt_supported_credentials [Guestfs] |
set libvirt credentials supported by calling program
|
set_memsize [Guestfs] |
set memory allocated to the hypervisor
|
set_network [Guestfs] |
set enable network flag
|
set_path [Guestfs] |
set the search path
|
set_pgroup [Guestfs] |
set process group flag
|
set_program [Guestfs] |
set the program name
|
set_qemu [Guestfs] |
set the hypervisor binary (usually qemu)
|
set_recovery_proc [Guestfs] |
enable or disable the recovery process
|
set_selinux [Guestfs] |
set SELinux enabled or disabled at appliance boot
|
set_smp [Guestfs] |
set number of virtual CPUs in appliance
|
set_tmpdir [Guestfs] |
set the temporary directory
|
set_trace [Guestfs] |
enable or disable command traces
|
set_uuid [Guestfs] |
set the filesystem UUID
|
set_uuid_random [Guestfs] |
set a random UUID for the filesystem
|
set_verbose [Guestfs] |
set verbose mode
|
setcon [Guestfs] |
set SELinux security context
|
setxattr [Guestfs] |
set extended attribute of a file or directory
|
sfdisk [Guestfs] |
create partitions on a block device
|
sfdiskM [Guestfs] |
create partitions on a block device
|
sfdisk_N [Guestfs] |
modify a single partition on a block device
|
sfdisk_disk_geometry [Guestfs] |
display the disk geometry from the partition table
|
sfdisk_kernel_geometry [Guestfs] |
display the kernel geometry
|
sfdisk_l [Guestfs] |
display the partition table
|
sh [Guestfs] |
run a command via the shell
|
sh_lines [Guestfs] |
run a command via the shell returning lines
|
shutdown [Guestfs] |
shutdown the hypervisor
|
sleep [Guestfs] |
sleep for some seconds
|
stat [Guestfs] |
get file information
|
statns [Guestfs] |
get file information
|
statvfs [Guestfs] |
get file system statistics
|
strings [Guestfs] |
print the printable strings in a file
|
strings_e [Guestfs] |
print the printable strings in a file
|
swapoff_device [Guestfs] |
disable swap on device
|
swapoff_file [Guestfs] |
disable swap on file
|
swapoff_label [Guestfs] |
disable swap on labeled swap partition
|
swapoff_uuid [Guestfs] |
disable swap on swap partition by UUID
|
swapon_device [Guestfs] |
enable swap on device
|
swapon_file [Guestfs] |
enable swap on file
|
swapon_label [Guestfs] |
enable swap on labeled swap partition
|
swapon_uuid [Guestfs] |
enable swap on swap partition by UUID
|
sync [Guestfs] |
sync disks, writes are flushed through to the disk image
|
syslinux [Guestfs] |
install the SYSLINUX bootloader
|
T | |
tail [Guestfs] |
return last 10 lines of a file
|
tail_n [Guestfs] |
return last N lines of a file
|
tar_in [Guestfs] |
unpack tarfile to directory
|
tar_in_opts [Guestfs] |
alias for
Guestfs.tar_in
|
tar_out [Guestfs] |
pack directory into tarfile
|
tar_out_opts [Guestfs] |
alias for
Guestfs.tar_out
|
tgz_in [Guestfs] |
unpack compressed tarball to directory
|
tgz_out [Guestfs] |
pack directory into compressed tarball
|
touch [Guestfs] |
update file timestamps or create a new file
|
truncate [Guestfs] |
truncate a file to zero size
|
truncate_size [Guestfs] |
truncate a file to a particular size
|
tune2fs [Guestfs] |
adjust ext2/ext3/ext4 filesystem parameters
|
tune2fs_l [Guestfs] |
get ext2/ext3/ext4 superblock details
|
txz_in [Guestfs] |
unpack compressed tarball to directory
|
txz_out [Guestfs] |
pack directory into compressed tarball
|
U | |
umask [Guestfs] |
set file mode creation mask (umask)
|
umount [Guestfs] |
unmount a filesystem
|
umount_all [Guestfs] |
unmount all filesystems
|
umount_local [Guestfs] |
unmount a locally mounted filesystem
|
umount_opts [Guestfs] |
alias for
Guestfs.umount
|
upload [Guestfs] |
upload a file from the local machine
|
upload_offset [Guestfs] |
upload a file from the local machine with offset
|
user_cancel [Guestfs] |
cancel the current upload or download operation
|
utimens [Guestfs] |
set timestamp of a file with nanosecond precision
|
utsname [Guestfs] |
appliance kernel version
|
V | |
version [Guestfs] |
get the library version number
|
vfs_label [Guestfs] |
get the filesystem label
|
vfs_minimum_size [Guestfs] |
get minimum filesystem size
|
vfs_type [Guestfs] |
get the Linux VFS type corresponding to a mounted device
|
vfs_uuid [Guestfs] |
get the filesystem UUID
|
vg_activate [Guestfs] |
activate or deactivate some volume groups
|
vg_activate_all [Guestfs] |
activate or deactivate all volume groups
|
vgchange_uuid [Guestfs] |
generate a new random UUID for a volume group
|
vgchange_uuid_all [Guestfs] |
generate new random UUIDs for all volume groups
|
vgcreate [Guestfs] |
create an LVM volume group
|
vglvuuids [Guestfs] |
get the LV UUIDs of all LVs in the volume group
|
vgmeta [Guestfs] |
get volume group metadata
|
vgpvuuids [Guestfs] |
get the PV UUIDs containing the volume group
|
vgremove [Guestfs] |
remove an LVM volume group
|
vgrename [Guestfs] |
rename an LVM volume group
|
vgs [Guestfs] |
list the LVM volume groups (VGs)
|
vgs_full [Guestfs] |
list the LVM volume groups (VGs)
|
vgscan [Guestfs] |
rescan for LVM physical volumes, volume groups and logical volumes
|
vguuid [Guestfs] |
get the UUID of a volume group
|
W | |
wait_ready [Guestfs] |
wait until the hypervisor launches (no op)
|
wc_c [Guestfs] |
count characters in a file
|
wc_l [Guestfs] |
count lines in a file
|
wc_w [Guestfs] |
count words in a file
|
wipefs [Guestfs] |
wipe a filesystem signature from a device
|
write [Guestfs] |
create a new file
|
write_append [Guestfs] |
append content to end of file
|
write_file [Guestfs] |
create a file
|
X | |
xfs_admin [Guestfs] |
change parameters of an XFS filesystem
|
xfs_growfs [Guestfs] |
expand an existing XFS filesystem
|
xfs_info [Guestfs] |
get geometry of XFS filesystem
|
xfs_repair [Guestfs] |
repair an XFS filesystem
|
Y | |
yara_destroy [Guestfs] |
destroy previously loaded yara rules
|
yara_load [Guestfs] |
load yara rules within libguestfs
|
yara_scan [Guestfs] |
scan a file with the loaded yara rules
|
Z | |
zegrep [Guestfs] |
return lines matching a pattern
|
zegrepi [Guestfs] |
return lines matching a pattern
|
zero [Guestfs] |
write zeroes to the device
|
zero_device [Guestfs] |
write zeroes to an entire device
|
zero_free_space [Guestfs] |
zero free space in a filesystem
|
zerofree [Guestfs] |
zero unused inodes and disk blocks on ext2/3 filesystem
|
zfgrep [Guestfs] |
return lines matching a pattern
|
zfgrepi [Guestfs] |
return lines matching a pattern
|
zfile [Guestfs] |
determine file type inside a compressed file
|
zgrep [Guestfs] |
return lines matching a pattern
|
zgrepi [Guestfs] |
return lines matching a pattern
|