Up  

Class Guestfs.guestfs

class guestfs : ?environment:bool -> ?close_on_exit:bool -> unit -> object .. end
method close : unit -> unit

See Guestfs.close

method set_event_callback : event_callback -> event list -> event_handle

See Guestfs.set_event_callback

method delete_event_callback : event_handle -> unit

See Guestfs.delete_event_callback

method last_errno : unit -> int

See Guestfs.last_errno

method ocaml_handle : t

Return the Guestfs.t handle

method acl_delete_def_file : string -> unit

delete the default POSIX ACL of a directory

This function depends on the feature "acl". See also Guestfs.guestfs.feature_available.

method acl_get_file : string -> string -> string

get the POSIX ACL attached to a file

This function depends on the feature "acl". See also Guestfs.guestfs.feature_available.

method acl_set_file : string -> string -> string -> unit

set the POSIX ACL attached to a file

This function depends on the feature "acl". See also Guestfs.guestfs.feature_available.

method add_cdrom : string -> unit
Deprecated.Use Guestfs.guestfs.add_drive_ro instead

add a CD-ROM disk image to examine

method add_domain : ?libvirturi:string ->
       ?readonly:bool ->
       ?iface:string ->
       ?live:bool ->
       ?allowuuid:bool ->
       ?readonlydisk:string ->
       ?cachemode:string -> ?discard:string -> ?copyonread:bool -> string -> int

add the disk(s) from a named libvirt domain

method add_drive : ?readonly:bool ->
       ?format:string ->
       ?iface:string ->
       ?name:string ->
       ?label:string ->
       ?protocol:string ->
       ?server:string array ->
       ?username:string ->
       ?secret:string ->
       ?cachemode:string ->
       ?discard:string -> ?copyonread:bool -> ?blocksize:int -> string -> unit

add an image to examine or modify

method add_drive_opts : ?readonly:bool ->
       ?format:string ->
       ?iface:string ->
       ?name:string ->
       ?label:string ->
       ?protocol:string ->
       ?server:string array ->
       ?username:string ->
       ?secret:string ->
       ?cachemode:string ->
       ?discard:string -> ?copyonread:bool -> ?blocksize:int -> string -> unit

alias for Guestfs.guestfs.add_drive

method add_drive_ro : string -> unit

add a drive in snapshot mode (read-only)

method add_drive_ro_with_if : string -> string -> unit
Deprecated.Use Guestfs.guestfs.add_drive instead

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

method add_drive_scratch : ?name:string -> ?label:string -> ?blocksize:int -> int64 -> unit

add a temporary scratch drive

method add_drive_with_if : string -> string -> unit
Deprecated.Use Guestfs.guestfs.add_drive instead

add a drive specifying the QEMU block emulation to use

method add_libvirt_dom : ?readonly:bool ->
       ?iface:string ->
       ?live:bool ->
       ?readonlydisk:string ->
       ?cachemode:string -> ?discard:string -> ?copyonread:bool -> int64 -> int

add the disk(s) from a libvirt domain

method aug_clear : string -> unit

clear Augeas path

method aug_close : unit -> unit

close the current Augeas handle

method aug_defnode : string -> string -> string -> int_bool

define an Augeas node

method aug_defvar : string -> string option -> int

define an Augeas variable

method aug_get : string -> string

look up the value of an Augeas path

method aug_init : string -> int -> unit

create a new Augeas handle

method aug_insert : string -> string -> bool -> unit

insert a sibling Augeas node

method aug_label : string -> string

return the label from an Augeas path expression

method aug_load : unit -> unit

load files into the tree

method aug_ls : string -> string array

list Augeas nodes under augpath

method aug_match : string -> string array

return Augeas nodes which match augpath

method aug_mv : string -> string -> unit

move Augeas node

method aug_rm : string -> int

remove an Augeas path

method aug_save : unit -> unit

write all pending Augeas changes to disk

method aug_set : string -> string -> unit

set Augeas path to value

method aug_setm : string -> string option -> string -> int

set multiple Augeas nodes

method aug_transform : ?remove:bool -> string -> string -> unit

add/remove an Augeas lens transformation

method available : string array -> unit

test availability of some parts of the API

method available_all_groups : unit -> string array

return a list of all optional groups

method base64_in : string -> string -> unit

upload base64-encoded data to file

method base64_out : string -> string -> unit

download file and encode as base64

method blkdiscard : string -> unit

discard all blocks on a device

This function depends on the feature "blkdiscard". See also Guestfs.guestfs.feature_available.

method blkdiscardzeroes : string -> bool

return true if discarded blocks are read as zeroes

This function depends on the feature "blkdiscardzeroes". See also Guestfs.guestfs.feature_available.

method blkid : string -> (string * string) list

print block device attributes

method blockdev_flushbufs : string -> unit

flush device buffers

method blockdev_getbsz : string -> int

get blocksize of block device

method blockdev_getro : string -> bool

is block device set to read-only

method blockdev_getsize64 : string -> int64

get total size of device in bytes

method blockdev_getss : string -> int

get sectorsize of block device

method blockdev_getsz : string -> int64

get total size of device in 512-byte sectors

method blockdev_rereadpt : string -> unit

reread partition table

method blockdev_setbsz : string -> int -> unit
Deprecated.There is no documented replacement

set blocksize of block device

method blockdev_setra : string -> int -> unit

set readahead

method blockdev_setro : string -> unit

set block device to read-only

method blockdev_setrw : string -> unit

set block device to read-write

method btrfs_balance_cancel : string -> unit

cancel a running or paused balance

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_balance_pause : string -> unit

pause a running balance

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_balance_resume : string -> unit

resume a paused balance

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_balance_status : string -> btrfsbalance

show the status of a running or paused balance

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_device_add : string array -> string -> unit

add devices to a btrfs filesystem

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_device_delete : string array -> string -> unit

remove devices from a btrfs filesystem

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_filesystem_balance : string -> unit

balance a btrfs filesystem

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_filesystem_defragment : ?flush:bool -> ?compress:string -> string -> unit

defragment a file or directory

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_filesystem_resize : ?size:int64 -> string -> unit

resize a btrfs filesystem

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_filesystem_show : string -> string array

list devices for btrfs filesystem

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_filesystem_sync : string -> unit

sync a btrfs filesystem

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_fsck : ?superblock:int64 -> ?repair:bool -> string -> unit

check a btrfs filesystem

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_image : ?compresslevel:int -> string array -> string -> unit

create an image of a btrfs filesystem

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_qgroup_assign : string -> string -> string -> unit

add a qgroup to a parent qgroup

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_qgroup_create : string -> string -> unit

create a subvolume quota group

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_qgroup_destroy : string -> string -> unit

destroy a subvolume quota group

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_qgroup_limit : string -> int64 -> unit

limit the size of a subvolume

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_qgroup_remove : string -> string -> string -> unit

remove a qgroup from its parent qgroup

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_qgroup_show : string -> btrfsqgroup array

show subvolume quota groups

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_quota_enable : string -> bool -> unit

enable or disable subvolume quota support

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_quota_rescan : string -> unit

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

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_replace : string -> string -> string -> unit

replace a btrfs managed device with another device

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_rescue_chunk_recover : string -> unit

recover the chunk tree of btrfs filesystem

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_rescue_super_recover : string -> unit

recover bad superblocks from good copies

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_scrub_cancel : string -> unit

cancel a running scrub

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_scrub_resume : string -> unit

resume a previously canceled or interrupted scrub

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_scrub_start : string -> unit

read all data from all disks and verify checksums

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_scrub_status : string -> btrfsscrub

show status of running or finished scrub

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_set_seeding : string -> bool -> unit

enable or disable the seeding feature of device

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_subvolume_create : ?qgroupid:string -> string -> unit

create a btrfs subvolume

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_subvolume_create_opts : ?qgroupid:string -> string -> unit

alias for Guestfs.guestfs.btrfs_subvolume_create

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_subvolume_delete : string -> unit

delete a btrfs subvolume or snapshot

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_subvolume_get_default : string -> int64

get the default subvolume or snapshot of a filesystem

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_subvolume_list : string -> btrfssubvolume array

list btrfs snapshots and subvolumes

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_subvolume_set_default : int64 -> string -> unit

set default btrfs subvolume

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_subvolume_show : string -> (string * string) list

return detailed information of the subvolume

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_subvolume_snapshot : ?ro:bool -> ?qgroupid:string -> string -> string -> unit

create a btrfs snapshot

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfs_subvolume_snapshot_opts : ?ro:bool -> ?qgroupid:string -> string -> string -> unit

alias for Guestfs.guestfs.btrfs_subvolume_snapshot

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfstune_enable_extended_inode_refs : string -> unit

enable extended inode refs

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfstune_enable_skinny_metadata_extent_refs : string -> unit

enable skinny metadata extent refs

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method btrfstune_seeding : string -> bool -> unit

enable or disable seeding of a btrfs device

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method c_pointer : unit -> int64

return the C pointer to the guestfs_h handle

method canonical_device_name : string -> string

return canonical device name

method cap_get_file : string -> string

get the Linux capabilities attached to a file

This function depends on the feature "linuxcaps". See also Guestfs.guestfs.feature_available.

method cap_set_file : string -> string -> unit

set the Linux capabilities attached to a file

This function depends on the feature "linuxcaps". See also Guestfs.guestfs.feature_available.

method case_sensitive_path : string -> string

return true path on case-insensitive filesystem

method cat : string -> string

list the contents of a file

method checksum : string -> string -> string

compute MD5, SHAx or CRC checksum of file

method checksum_device : string -> string -> string

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

method checksums_out : string -> string -> string -> unit

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

method chmod : int -> string -> unit

change file mode

method chown : int -> int -> string -> unit

change file owner and group

method clear_backend_setting : string -> int

remove a single per-backend settings string

method command : string array -> string

run a command from the guest filesystem

method command_lines : string array -> string array

run a command, returning lines

method compress_device_out : ?level:int -> string -> string -> string -> unit

output compressed device

method compress_out : ?level:int -> string -> string -> string -> unit

output compressed file

method config : string -> string option -> unit

add hypervisor parameters

method copy_attributes : ?all:bool ->
       ?mode:bool ->
       ?xattributes:bool -> ?ownership:bool -> string -> string -> unit

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

method copy_device_to_device : ?srcoffset:int64 ->
       ?destoffset:int64 ->
       ?size:int64 -> ?sparse:bool -> ?append:bool -> string -> string -> unit

copy from source device to destination device

method copy_device_to_file : ?srcoffset:int64 ->
       ?destoffset:int64 ->
       ?size:int64 -> ?sparse:bool -> ?append:bool -> string -> string -> unit

copy from source device to destination file

method copy_file_to_device : ?srcoffset:int64 ->
       ?destoffset:int64 ->
       ?size:int64 -> ?sparse:bool -> ?append:bool -> string -> string -> unit

copy from source file to destination device

method copy_file_to_file : ?srcoffset:int64 ->
       ?destoffset:int64 ->
       ?size:int64 -> ?sparse:bool -> ?append:bool -> string -> string -> unit

copy from source file to destination file

method copy_in : string -> string -> unit

copy local files or directories into an image

method copy_out : string -> string -> unit

copy remote files or directories out of an image

method copy_size : string -> string -> int64 -> unit
Deprecated.Use Guestfs.guestfs.copy_device_to_device instead

copy size bytes from source to destination using dd

method cp : string -> string -> unit

copy a file

method cp_a : string -> string -> unit

copy a file or directory recursively

method cp_r : string -> string -> unit

copy a file or directory recursively

method cpio_out : ?format:string -> string -> string -> unit

pack directory into cpio file

method cryptsetup_close : string -> unit

close an encrypted device

This function depends on the feature "luks". See also Guestfs.guestfs.feature_available.

method cryptsetup_open : ?readonly:bool -> ?crypttype:string -> string -> string -> string -> unit

open an encrypted block device

This function depends on the feature "luks". See also Guestfs.guestfs.feature_available.

method dd : string -> string -> unit
Deprecated.Use Guestfs.guestfs.copy_device_to_device instead

copy from source to destination using dd

method device_index : string -> int

convert device to index

method df : unit -> string

report file system disk space usage

method df_h : unit -> string

report file system disk space usage (human readable)

method disk_create : ?backingfile:string ->
       ?backingformat:string ->
       ?preallocation:string ->
       ?compat:string -> ?clustersize:int -> string -> string -> int64 -> unit

create a blank disk image

method disk_format : string -> string

detect the disk format of a disk image

method disk_has_backing_file : string -> bool

return whether disk has a backing file

method disk_virtual_size : string -> int64

return virtual size of a disk

method dmesg : unit -> string

return kernel messages

method download : string -> string -> unit

download a file to the local machine

method download_blocks : ?unallocated:bool -> string -> int64 -> int64 -> string -> unit

download the given data units from the disk

This function depends on the feature "sleuthkit". See also Guestfs.guestfs.feature_available.

method download_inode : string -> int64 -> string -> unit

download a file to the local machine given its inode

This function depends on the feature "sleuthkit". See also Guestfs.guestfs.feature_available.

method download_offset : string -> string -> int64 -> int64 -> unit

download a file to the local machine with offset and size

method drop_caches : int -> unit

drop kernel page cache, dentries and inodes

method du : string -> int64

estimate file space usage

method e2fsck : ?correct:bool -> ?forceall:bool -> string -> unit

check an ext2/ext3 filesystem

method e2fsck_f : string -> unit
Deprecated.Use Guestfs.guestfs.e2fsck instead

check an ext2/ext3 filesystem

method echo_daemon : string array -> string

echo arguments back to the client

method egrep : string -> string -> string array
Deprecated.Use Guestfs.guestfs.grep instead

return lines matching a pattern

method egrepi : string -> string -> string array
Deprecated.Use Guestfs.guestfs.grep instead

return lines matching a pattern

method equal : string -> string -> bool

test if two files have equal contents

method exists : string -> bool

test if file or directory exists

method extlinux : string -> unit

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

This function depends on the feature "extlinux". See also Guestfs.guestfs.feature_available.

method f2fs_expand : string -> unit

expand a f2fs filesystem

This function depends on the feature "f2fs". See also Guestfs.guestfs.feature_available.

method fallocate : string -> int -> unit
Deprecated.Use Guestfs.guestfs.fallocate64 instead

preallocate a file in the guest filesystem

method fallocate64 : string -> int64 -> unit

preallocate a file in the guest filesystem

method feature_available : string array -> bool

test availability of some parts of the API

method fgrep : string -> string -> string array
Deprecated.Use Guestfs.guestfs.grep instead

return lines matching a pattern

method fgrepi : string -> string -> string array
Deprecated.Use Guestfs.guestfs.grep instead

return lines matching a pattern

method file : string -> string

determine file type

method file_architecture : string -> string

detect the architecture of a binary file

method filesize : string -> int64

return the size of the file in bytes

method filesystem_available : string -> bool

check if filesystem is available

method filesystem_walk : string -> tsk_dirent array

walk through the filesystem content

This function depends on the feature "libtsk". See also Guestfs.guestfs.feature_available.

method fill : int -> int -> string -> unit

fill a file with octets

method fill_dir : string -> int -> unit

fill a directory with empty files

method fill_pattern : string -> int -> string -> unit

fill a file with a repeating pattern of bytes

method find : string -> string array

find all files and directories

method find0 : string -> string -> unit

find all files and directories, returning NUL-separated list

method find_inode : string -> int64 -> tsk_dirent array

search the entries associated to the given inode

This function depends on the feature "libtsk". See also Guestfs.guestfs.feature_available.

method findfs_label : string -> string

find a filesystem by label

method findfs_uuid : string -> string

find a filesystem by UUID

method fsck : string -> string -> int

run the filesystem checker

method fstrim : ?offset:int64 -> ?length:int64 -> ?minimumfreeextent:int64 -> string -> unit

trim free space in a filesystem

This function depends on the feature "fstrim". See also Guestfs.guestfs.feature_available.

method get_append : unit -> string option

get the additional kernel options

method get_attach_method : unit -> string
Deprecated.Use Guestfs.guestfs.get_backend instead

get the backend

method get_autosync : unit -> bool

get autosync mode

method get_backend : unit -> string

get the backend

method get_backend_setting : string -> string

get a single per-backend settings string

method get_backend_settings : unit -> string array

get per-backend settings

method get_cachedir : unit -> string

get the appliance cache directory

method get_direct : unit -> bool
Deprecated.This is replaced by method internal_get_console_socket which is not exported by the OCaml bindings

get direct appliance mode flag

method get_e2attrs : string -> string

get ext2 file attributes of a file

method get_e2generation : string -> int64

get ext2 file generation of a file

method get_e2label : string -> string
Deprecated.Use Guestfs.guestfs.vfs_label instead

get the ext2/3/4 filesystem label

method get_e2uuid : string -> string
Deprecated.Use Guestfs.guestfs.vfs_uuid instead

get the ext2/3/4 filesystem UUID

method get_hv : unit -> string

get the hypervisor binary

method get_identifier : unit -> string

get the handle identifier

method get_libvirt_requested_credential_challenge : int -> string

challenge of i'th requested credential

method get_libvirt_requested_credential_defresult : int -> string

default result of i'th requested credential

method get_libvirt_requested_credential_prompt : int -> string

prompt of i'th requested credential

method get_libvirt_requested_credentials : unit -> string array

get list of credentials requested by libvirt

method get_memsize : unit -> int

get memory allocated to the hypervisor

method get_network : unit -> bool

get enable network flag

method get_path : unit -> string

get the search path

method get_pgroup : unit -> bool

get process group flag

method get_pid : unit -> int

get PID of hypervisor

method get_program : unit -> string

get the program name

method get_qemu : unit -> string
Deprecated.Use Guestfs.guestfs.get_hv instead

get the hypervisor binary (usually qemu)

method get_recovery_proc : unit -> bool

get recovery process enabled flag

method get_selinux : unit -> bool
Deprecated.Use Guestfs.guestfs.selinux_relabel instead

get SELinux enabled flag

method get_smp : unit -> int

get number of virtual CPUs in appliance

method get_sockdir : unit -> string

get the temporary directory for sockets

method get_state : unit -> int

get the current state

method get_tmpdir : unit -> string

get the temporary directory

method get_trace : unit -> bool

get command trace enabled flag

method get_umask : unit -> int

get the current umask

method get_verbose : unit -> bool

get verbose mode

method getcon : unit -> string
Deprecated.Use Guestfs.guestfs.selinux_relabel instead

get SELinux security context

This function depends on the feature "selinux". See also Guestfs.guestfs.feature_available.

method getxattr : string -> string -> string

get a single extended attribute

This function depends on the feature "linuxxattrs". See also Guestfs.guestfs.feature_available.

method getxattrs : string -> xattr array

list extended attributes of a file or directory

This function depends on the feature "linuxxattrs". See also Guestfs.guestfs.feature_available.

method glob_expand : ?directoryslash:bool -> string -> string array

expand a wildcard path

method glob_expand_opts : ?directoryslash:bool -> string -> string array

alias for Guestfs.guestfs.glob_expand

method grep : ?extended:bool ->
       ?fixed:bool ->
       ?insensitive:bool -> ?compressed:bool -> string -> string -> string array

return lines matching a pattern

method grep_opts : ?extended:bool ->
       ?fixed:bool ->
       ?insensitive:bool -> ?compressed:bool -> string -> string -> string array

alias for Guestfs.guestfs.grep

method grepi : string -> string -> string array
Deprecated.Use Guestfs.guestfs.grep instead

return lines matching a pattern

method grub_install : string -> string -> unit

install GRUB 1

This function depends on the feature "grub". See also Guestfs.guestfs.feature_available.

method head : string -> string array

return first 10 lines of a file

method head_n : int -> string -> string array

return first N lines of a file

method hexdump : string -> string

dump a file in hexadecimal

method hivex_close : unit -> unit

close the current hivex handle

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method hivex_commit : string option -> unit

commit (write) changes back to the hive

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method hivex_node_add_child : int64 -> string -> int64

add a child node

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method hivex_node_children : int64 -> hivex_node array

return list of nodes which are subkeys of node

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method hivex_node_delete_child : int64 -> unit

delete a node (recursively)

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method hivex_node_get_child : int64 -> string -> int64

return the named child of node

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method hivex_node_get_value : int64 -> string -> int64

return the named value

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method hivex_node_name : int64 -> string

return the name of the node

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method hivex_node_parent : int64 -> int64

return the parent of node

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method hivex_node_set_value : int64 -> string -> int64 -> string -> unit

set or replace a single value in a node

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method hivex_node_values : int64 -> hivex_value array

return list of values attached to node

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method hivex_open : ?verbose:bool -> ?debug:bool -> ?write:bool -> ?unsafe:bool -> string -> unit

open a Windows Registry hive file

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method hivex_root : unit -> int64

return the root node of the hive

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method hivex_value_key : int64 -> string

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

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method hivex_value_string : int64 -> string

return the data field as a UTF-8 string

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method hivex_value_type : int64 -> int64

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

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method hivex_value_utf8 : int64 -> string
Deprecated.Use Guestfs.guestfs.hivex_value_string instead

return the data field as a UTF-8 string

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method hivex_value_value : int64 -> string

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

This function depends on the feature "hivex". See also Guestfs.guestfs.feature_available.

method initrd_cat : string -> string -> string

list the contents of a single file in an initrd

method initrd_list : string -> string array

list files in an initrd

method inotify_add_watch : string -> int -> int64

add an inotify watch

This function depends on the feature "inotify". See also Guestfs.guestfs.feature_available.

method inotify_close : unit -> unit

close the inotify handle

This function depends on the feature "inotify". See also Guestfs.guestfs.feature_available.

method inotify_files : unit -> string array

return list of watched files that had events

This function depends on the feature "inotify". See also Guestfs.guestfs.feature_available.

method inotify_init : int -> unit

create an inotify handle

This function depends on the feature "inotify". See also Guestfs.guestfs.feature_available.

method inotify_read : unit -> inotify_event array

return list of inotify events

This function depends on the feature "inotify". See also Guestfs.guestfs.feature_available.

method inotify_rm_watch : int -> unit

remove an inotify watch

This function depends on the feature "inotify". See also Guestfs.guestfs.feature_available.

method inspect_get_arch : string -> string

get architecture of inspected operating system

method inspect_get_distro : string -> string

get distro of inspected operating system

method inspect_get_drive_mappings : string -> (string * string) list

get drive letter mappings

method inspect_get_filesystems : string -> string array

get filesystems associated with inspected operating system

method inspect_get_format : string -> string
Deprecated.There is no documented replacement

get format of inspected operating system

method inspect_get_hostname : string -> string

get hostname of the operating system

method inspect_get_icon : ?favicon:bool -> ?highquality:bool -> string -> string

get the icon corresponding to this operating system

method inspect_get_major_version : string -> int

get major version of inspected operating system

method inspect_get_minor_version : string -> int

get minor version of inspected operating system

method inspect_get_mountpoints : string -> (string * string) list

get mountpoints of inspected operating system

method inspect_get_osinfo : string -> string

get a possible osinfo short ID corresponding to this operating system

method inspect_get_package_format : string -> string

get package format used by the operating system

method inspect_get_package_management : string -> string

get package management tool used by the operating system

method inspect_get_product_name : string -> string

get product name of inspected operating system

method inspect_get_product_variant : string -> string

get product variant of inspected operating system

method inspect_get_roots : unit -> string array

return list of operating systems found by last inspection

method inspect_get_type : string -> string

get type of inspected operating system

method inspect_get_windows_current_control_set : string -> string

get Windows CurrentControlSet of inspected operating system

method inspect_get_windows_software_hive : string -> string

get the path of the Windows software hive

method inspect_get_windows_system_hive : string -> string

get the path of the Windows system hive

method inspect_get_windows_systemroot : string -> string

get Windows systemroot of inspected operating system

method inspect_is_live : string -> bool
Deprecated.There is no documented replacement

get live flag for install disk

method inspect_is_multipart : string -> bool
Deprecated.There is no documented replacement

get multipart flag for install disk

method inspect_is_netinst : string -> bool
Deprecated.There is no documented replacement

get netinst (network installer) flag for install disk

method inspect_list_applications : string -> application array
Deprecated.Use Guestfs.guestfs.inspect_list_applications2 instead

get list of applications installed in the operating system

method inspect_list_applications2 : string -> application2 array

get list of applications installed in the operating system

method inspect_os : unit -> string array

inspect disk and return list of operating systems found

method is_blockdev : ?followsymlinks:bool -> string -> bool

test if block device

method is_blockdev_opts : ?followsymlinks:bool -> string -> bool

alias for Guestfs.guestfs.is_blockdev

method is_busy : unit -> bool

is busy processing a command

method is_chardev : ?followsymlinks:bool -> string -> bool

test if character device

method is_chardev_opts : ?followsymlinks:bool -> string -> bool

alias for Guestfs.guestfs.is_chardev

method is_config : unit -> bool

is in configuration state

method is_dir : ?followsymlinks:bool -> string -> bool

test if a directory

method is_dir_opts : ?followsymlinks:bool -> string -> bool

alias for Guestfs.guestfs.is_dir

method is_fifo : ?followsymlinks:bool -> string -> bool

test if FIFO (named pipe)

method is_fifo_opts : ?followsymlinks:bool -> string -> bool

alias for Guestfs.guestfs.is_fifo

method is_file : ?followsymlinks:bool -> string -> bool

test if a regular file

method is_file_opts : ?followsymlinks:bool -> string -> bool

alias for Guestfs.guestfs.is_file

method is_launching : unit -> bool

is launching subprocess

method is_lv : string -> bool

test if mountable is a logical volume

method is_ready : unit -> bool

is ready to accept commands

method is_socket : ?followsymlinks:bool -> string -> bool

test if socket

method is_socket_opts : ?followsymlinks:bool -> string -> bool

alias for Guestfs.guestfs.is_socket

method is_symlink : string -> bool

test if symbolic link

method is_whole_device : string -> bool

test if a device is a whole device

method is_zero : string -> bool

test if a file contains all zero bytes

method is_zero_device : string -> bool

test if a device contains all zero bytes

method isoinfo : string -> isoinfo

get ISO information from primary volume descriptor of ISO file

method isoinfo_device : string -> isoinfo

get ISO information from primary volume descriptor of device

method journal_close : unit -> unit

close the systemd journal

This function depends on the feature "journal". See also Guestfs.guestfs.feature_available.

method journal_get : unit -> xattr array

read the current journal entry

This function depends on the feature "journal". See also Guestfs.guestfs.feature_available.

method journal_get_data_threshold : unit -> int64

get the data threshold for reading journal entries

This function depends on the feature "journal". See also Guestfs.guestfs.feature_available.

method journal_get_realtime_usec : unit -> int64

get the timestamp of the current journal entry

This function depends on the feature "journal". See also Guestfs.guestfs.feature_available.

method journal_next : unit -> bool

move to the next journal entry

This function depends on the feature "journal". See also Guestfs.guestfs.feature_available.

method journal_open : string -> unit

open the systemd journal

This function depends on the feature "journal". See also Guestfs.guestfs.feature_available.

method journal_set_data_threshold : int64 -> unit

set the data threshold for reading journal entries

This function depends on the feature "journal". See also Guestfs.guestfs.feature_available.

method journal_skip : int64 -> int64

skip forwards or backwards in the journal

This function depends on the feature "journal". See also Guestfs.guestfs.feature_available.

method kill_subprocess : unit -> unit
Deprecated.Use Guestfs.guestfs.shutdown instead

kill the hypervisor

method launch : unit -> unit

launch the backend

method lchown : int -> int -> string -> unit

change file owner and group

method ldmtool_create_all : unit -> unit

scan and create Windows dynamic disk volumes

This function depends on the feature "ldm". See also Guestfs.guestfs.feature_available.

method ldmtool_diskgroup_disks : string -> string array

return the disks in a Windows dynamic disk group

This function depends on the feature "ldm". See also Guestfs.guestfs.feature_available.

method ldmtool_diskgroup_name : string -> string

return the name of a Windows dynamic disk group

This function depends on the feature "ldm". See also Guestfs.guestfs.feature_available.

method ldmtool_diskgroup_volumes : string -> string array

return the volumes in a Windows dynamic disk group

This function depends on the feature "ldm". See also Guestfs.guestfs.feature_available.

method ldmtool_remove_all : unit -> unit

remove all Windows dynamic disk volumes

This function depends on the feature "ldm". See also Guestfs.guestfs.feature_available.

method ldmtool_scan : unit -> string array

scan for Windows dynamic disks

This function depends on the feature "ldm". See also Guestfs.guestfs.feature_available.

method ldmtool_scan_devices : string array -> string array

scan for Windows dynamic disks

This function depends on the feature "ldm". See also Guestfs.guestfs.feature_available.

method ldmtool_volume_hint : string -> string -> string

return the hint field of a Windows dynamic disk volume

This function depends on the feature "ldm". See also Guestfs.guestfs.feature_available.

method ldmtool_volume_partitions : string -> string -> string array

return the partitions in a Windows dynamic disk volume

This function depends on the feature "ldm". See also Guestfs.guestfs.feature_available.

method ldmtool_volume_type : string -> string -> string

return the type of a Windows dynamic disk volume

This function depends on the feature "ldm". See also Guestfs.guestfs.feature_available.

method lgetxattr : string -> string -> string

get a single extended attribute

This function depends on the feature "linuxxattrs". See also Guestfs.guestfs.feature_available.

method lgetxattrs : string -> xattr array

list extended attributes of a file or directory

This function depends on the feature "linuxxattrs". See also Guestfs.guestfs.feature_available.

method list_devices : unit -> string array

list the block devices

method list_disk_labels : unit -> (string * string) list

mapping of disk labels to devices

method list_dm_devices : unit -> string array

list device mapper devices

method list_filesystems : unit -> (string * string) list

list filesystems

method list_ldm_partitions : unit -> string array

list all Windows dynamic disk partitions

This function depends on the feature "ldm". See also Guestfs.guestfs.feature_available.

method list_ldm_volumes : unit -> string array

list all Windows dynamic disk volumes

This function depends on the feature "ldm". See also Guestfs.guestfs.feature_available.

method list_md_devices : unit -> string array

list Linux md (RAID) devices

method list_partitions : unit -> string array

list the partitions

method ll : string -> string

list the files in a directory (long format)

method llz : string -> string
Deprecated.Use Guestfs.guestfs.lgetxattrs instead

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

method ln : string -> string -> unit

create a hard link

method ln_f : string -> string -> unit

create a hard link

method ln_s : string -> string -> unit

create a symbolic link

method ln_sf : string -> string -> unit

create a symbolic link

method lremovexattr : string -> string -> unit

remove extended attribute of a file or directory

This function depends on the feature "linuxxattrs". See also Guestfs.guestfs.feature_available.

method ls : string -> string array

list the files in a directory

method ls0 : string -> string -> unit

get list of files in a directory

method lsetxattr : string -> string -> int -> string -> unit

set extended attribute of a file or directory

This function depends on the feature "linuxxattrs". See also Guestfs.guestfs.feature_available.

method lstat : string -> stat
Deprecated.Use Guestfs.guestfs.lstatns instead

get file information for a symbolic link

method lstatlist : string -> string array -> stat array
Deprecated.Use Guestfs.guestfs.lstatnslist instead

lstat on multiple files

method lstatns : string -> statns

get file information for a symbolic link

method lstatnslist : string -> string array -> statns array

lstat on multiple files

method luks_add_key : string -> string -> string -> int -> unit

add a key on a LUKS encrypted device

This function depends on the feature "luks". See also Guestfs.guestfs.feature_available.

method luks_close : string -> unit
Deprecated.Use Guestfs.guestfs.cryptsetup_close instead

close a LUKS device

This function depends on the feature "luks". See also Guestfs.guestfs.feature_available.

method luks_format : string -> string -> int -> unit

format a block device as a LUKS encrypted device

This function depends on the feature "luks". See also Guestfs.guestfs.feature_available.

method luks_format_cipher : string -> string -> int -> string -> unit

format a block device as a LUKS encrypted device

This function depends on the feature "luks". See also Guestfs.guestfs.feature_available.

method luks_kill_slot : string -> string -> int -> unit

remove a key from a LUKS encrypted device

This function depends on the feature "luks". See also Guestfs.guestfs.feature_available.

method luks_open : string -> string -> string -> unit
Deprecated.Use Guestfs.guestfs.cryptsetup_open instead

open a LUKS-encrypted block device

This function depends on the feature "luks". See also Guestfs.guestfs.feature_available.

method luks_open_ro : string -> string -> string -> unit
Deprecated.Use Guestfs.guestfs.cryptsetup_open instead

open a LUKS-encrypted block device read-only

This function depends on the feature "luks". See also Guestfs.guestfs.feature_available.

method luks_uuid : string -> string

get the UUID of a LUKS device

This function depends on the feature "luks". See also Guestfs.guestfs.feature_available.

method lvcreate : string -> string -> int -> unit

create an LVM logical volume

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method lvcreate_free : string -> string -> int -> unit

create an LVM logical volume in % remaining free space

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method lvm_canonical_lv_name : string -> string

get canonical name of an LV

method lvm_clear_filter : unit -> unit

clear LVM device filter

method lvm_remove_all : unit -> unit

remove all LVM LVs, VGs and PVs

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method lvm_scan : bool -> unit

scan for LVM physical volumes, volume groups and logical volumes

method lvm_set_filter : string array -> unit

set LVM device filter

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method lvremove : string -> unit

remove an LVM logical volume

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method lvrename : string -> string -> unit

rename an LVM logical volume

method lvresize : string -> int -> unit

resize an LVM logical volume

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method lvresize_free : string -> int -> unit

expand an LV to fill free space

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method lvs : unit -> string array

list the LVM logical volumes (LVs)

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method lvs_full : unit -> lvm_lv array

list the LVM logical volumes (LVs)

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method lvuuid : string -> string

get the UUID of a logical volume

method lxattrlist : string -> string array -> xattr array

lgetxattr on multiple files

This function depends on the feature "linuxxattrs". See also Guestfs.guestfs.feature_available.

method max_disks : unit -> int

maximum number of disks that may be added

method md_create : ?missingbitmap:int64 ->
       ?nrdevices:int ->
       ?spare:int -> ?chunk:int64 -> ?level:string -> string -> string array -> unit

create a Linux md (RAID) device

This function depends on the feature "mdadm". See also Guestfs.guestfs.feature_available.

method md_detail : string -> (string * string) list

obtain metadata for an MD device

This function depends on the feature "mdadm". See also Guestfs.guestfs.feature_available.

method md_stat : string -> mdstat array

get underlying devices from an MD device

This function depends on the feature "mdadm". See also Guestfs.guestfs.feature_available.

method md_stop : string -> unit

stop a Linux md (RAID) device

This function depends on the feature "mdadm". See also Guestfs.guestfs.feature_available.

method mkdir : string -> unit

create a directory

method mkdir_mode : string -> int -> unit

create a directory with a particular mode

method mkdir_p : string -> unit

create a directory and parents

method mkdtemp : string -> string

create a temporary directory

method mke2fs : ?blockscount:int64 ->
       ?blocksize:int64 ->
       ?fragsize:int64 ->
       ?blockspergroup:int64 ->
       ?numberofgroups:int64 ->
       ?bytesperinode:int64 ->
       ?inodesize:int64 ->
       ?journalsize:int64 ->
       ?numberofinodes:int64 ->
       ?stridesize:int64 ->
       ?stripewidth:int64 ->
       ?maxonlineresize:int64 ->
       ?reservedblockspercentage:int ->
       ?mmpupdateinterval:int ->
       ?journaldevice:string ->
       ?label:string ->
       ?lastmounteddir:string ->
       ?creatoros:string ->
       ?fstype:string ->
       ?usagetype:string ->
       ?uuid:string ->
       ?forcecreate:bool ->
       ?writesbandgrouponly:bool ->
       ?lazyitableinit:bool ->
       ?lazyjournalinit:bool ->
       ?testfs:bool ->
       ?discard:bool ->
       ?quotatype:bool ->
       ?extent:bool ->
       ?filetype:bool ->
       ?flexbg:bool ->
       ?hasjournal:bool ->
       ?journaldev:bool ->
       ?largefile:bool ->
       ?quota:bool ->
       ?resizeinode:bool -> ?sparsesuper:bool -> ?uninitbg:bool -> string -> unit

create an ext2/ext3/ext4 filesystem on device

method mke2fs_J : string -> int -> string -> string -> unit
Deprecated.Use Guestfs.guestfs.mke2fs instead

make ext2/3/4 filesystem with external journal

method mke2fs_JL : string -> int -> string -> string -> unit
Deprecated.Use Guestfs.guestfs.mke2fs instead

make ext2/3/4 filesystem with external journal

method mke2fs_JU : string -> int -> string -> string -> unit
Deprecated.Use Guestfs.guestfs.mke2fs instead

make ext2/3/4 filesystem with external journal

This function depends on the feature "linuxfsuuid". See also Guestfs.guestfs.feature_available.

method mke2journal : int -> string -> unit
Deprecated.Use Guestfs.guestfs.mke2fs instead

make ext2/3/4 external journal

method mke2journal_L : int -> string -> string -> unit
Deprecated.Use Guestfs.guestfs.mke2fs instead

make ext2/3/4 external journal with label

method mke2journal_U : int -> string -> string -> unit
Deprecated.Use Guestfs.guestfs.mke2fs instead

make ext2/3/4 external journal with UUID

This function depends on the feature "linuxfsuuid". See also Guestfs.guestfs.feature_available.

method mkfifo : int -> string -> unit

make FIFO (named pipe)

This function depends on the feature "mknod". See also Guestfs.guestfs.feature_available.

method mkfs : ?blocksize:int ->
       ?features:string ->
       ?inode:int -> ?sectorsize:int -> ?label:string -> string -> string -> unit

make a filesystem

method mkfs_opts : ?blocksize:int ->
       ?features:string ->
       ?inode:int -> ?sectorsize:int -> ?label:string -> string -> string -> unit

alias for Guestfs.guestfs.mkfs

method mkfs_b : string -> int -> string -> unit
Deprecated.Use Guestfs.guestfs.mkfs instead

make a filesystem with block size

method mkfs_btrfs : ?allocstart:int64 ->
       ?bytecount:int64 ->
       ?datatype:string ->
       ?leafsize:int ->
       ?label:string ->
       ?metadata:string -> ?nodesize:int -> ?sectorsize:int -> string array -> unit

create a btrfs filesystem

This function depends on the feature "btrfs". See also Guestfs.guestfs.feature_available.

method mklost_and_found : string -> unit

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

method mkmountpoint : string -> unit

create a mountpoint

method mknod : int -> int -> int -> string -> unit

make block, character or FIFO devices

This function depends on the feature "mknod". See also Guestfs.guestfs.feature_available.

method mknod_b : int -> int -> int -> string -> unit

make block device node

This function depends on the feature "mknod". See also Guestfs.guestfs.feature_available.

method mknod_c : int -> int -> int -> string -> unit

make char device node

This function depends on the feature "mknod". See also Guestfs.guestfs.feature_available.

method mksquashfs : ?compress:string -> ?excludes:string array -> string -> string -> unit

create a squashfs filesystem

This function depends on the feature "squashfs". See also Guestfs.guestfs.feature_available.

method mkswap : ?label:string -> ?uuid:string -> string -> unit

create a swap partition

method mkswap_opts : ?label:string -> ?uuid:string -> string -> unit

alias for Guestfs.guestfs.mkswap

method mkswap_L : string -> string -> unit
Deprecated.Use Guestfs.guestfs.mkswap instead

create a swap partition with a label

method mkswap_U : string -> string -> unit
Deprecated.Use Guestfs.guestfs.mkswap instead

create a swap partition with an explicit UUID

This function depends on the feature "linuxfsuuid". See also Guestfs.guestfs.feature_available.

method mkswap_file : string -> unit

create a swap file

method mktemp : ?suffix:string -> string -> string

create a temporary file

method modprobe : string -> unit

load a kernel module

This function depends on the feature "linuxmodules". See also Guestfs.guestfs.feature_available.

method mount : string -> string -> unit

mount a guest disk at a position in the filesystem

method mount_local : ?readonly:bool ->
       ?options:string -> ?cachetimeout:int -> ?debugcalls:bool -> string -> unit

mount on the local filesystem

method mount_local_run : unit -> unit

run main loop of mount on the local filesystem

method mount_loop : string -> string -> unit

mount a file using the loop device

method mount_options : string -> string -> string -> unit

mount a guest disk with mount options

method mount_ro : string -> string -> unit

mount a guest disk, read-only

method mount_vfs : string -> string -> string -> string -> unit

mount a guest disk with mount options and vfstype

method mountable_device : string -> string

extract the device part of a mountable

method mountable_subvolume : string -> string

extract the subvolume part of a mountable

method mountpoints : unit -> (string * string) list

show mountpoints

method mounts : unit -> string array

show mounted filesystems

method mv : string -> string -> unit

move a file

method nr_devices : unit -> int

return number of whole block devices (disks) added

method ntfs_3g_probe : bool -> string -> int

probe NTFS volume

This function depends on the feature "ntfs3g". See also Guestfs.guestfs.feature_available.

method ntfscat_i : string -> int64 -> string -> unit

download a file to the local machine given its inode

method ntfsclone_in : string -> string -> unit

restore NTFS from backup file

This function depends on the feature "ntfs3g". See also Guestfs.guestfs.feature_available.

method ntfsclone_out : ?metadataonly:bool ->
       ?rescue:bool ->
       ?ignorefscheck:bool ->
       ?preservetimestamps:bool -> ?force:bool -> string -> string -> unit

save NTFS to backup file

This function depends on the feature "ntfs3g". See also Guestfs.guestfs.feature_available.

method ntfsfix : ?clearbadsectors:bool -> string -> unit

fix common errors and force Windows to check NTFS

This function depends on the feature "ntfs3g". See also Guestfs.guestfs.feature_available.

method ntfsresize : ?size:int64 -> ?force:bool -> string -> unit

resize an NTFS filesystem

This function depends on the feature "ntfsprogs". See also Guestfs.guestfs.feature_available.

method ntfsresize_opts : ?size:int64 -> ?force:bool -> string -> unit

alias for Guestfs.guestfs.ntfsresize

This function depends on the feature "ntfsprogs". See also Guestfs.guestfs.feature_available.

method ntfsresize_size : string -> int64 -> unit
Deprecated.Use Guestfs.guestfs.ntfsresize instead

resize an NTFS filesystem (with size)

This function depends on the feature "ntfsprogs". See also Guestfs.guestfs.feature_available.

method parse_environment : unit -> unit

parse the environment and set handle flags accordingly

method parse_environment_list : string array -> unit

parse the environment and set handle flags accordingly

method part_add : string -> string -> int64 -> int64 -> unit

add a partition to the device

method part_del : string -> int -> unit

delete a partition

method part_disk : string -> string -> unit

partition whole disk with a single primary partition

method part_expand_gpt : string -> unit

move backup GPT header to the end of the disk

This function depends on the feature "gdisk". See also Guestfs.guestfs.feature_available.

method part_get_bootable : string -> int -> bool

return true if a partition is bootable

method part_get_disk_guid : string -> string

get the GUID of a GPT-partitioned disk

This function depends on the feature "gdisk". See also Guestfs.guestfs.feature_available.

method part_get_gpt_attributes : string -> int -> int64

get the attribute flags of a GPT partition

This function depends on the feature "gdisk". See also Guestfs.guestfs.feature_available.

method part_get_gpt_guid : string -> int -> string

get the GUID of a GPT partition

This function depends on the feature "gdisk". See also Guestfs.guestfs.feature_available.

method part_get_gpt_type : string -> int -> string

get the type GUID of a GPT partition

This function depends on the feature "gdisk". See also Guestfs.guestfs.feature_available.

method part_get_mbr_id : string -> int -> int

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

method part_get_mbr_part_type : string -> int -> string

get the MBR partition type

method part_get_name : string -> int -> string

get partition name

method part_get_parttype : string -> string

get the partition table type

method part_init : string -> string -> unit

create an empty partition table

method part_list : string -> partition array

list partitions on a device

method part_resize : string -> int -> int64 -> unit

resize a partition

method part_set_bootable : string -> int -> bool -> unit

make a partition bootable

method part_set_disk_guid : string -> string -> unit

set the GUID of a GPT-partitioned disk

This function depends on the feature "gdisk". See also Guestfs.guestfs.feature_available.

method part_set_disk_guid_random : string -> unit

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

This function depends on the feature "gdisk". See also Guestfs.guestfs.feature_available.

method part_set_gpt_attributes : string -> int -> int64 -> unit

set the attribute flags of a GPT partition

This function depends on the feature "gdisk". See also Guestfs.guestfs.feature_available.

method part_set_gpt_guid : string -> int -> string -> unit

set the GUID of a GPT partition

This function depends on the feature "gdisk". See also Guestfs.guestfs.feature_available.

method part_set_gpt_type : string -> int -> string -> unit

set the type GUID of a GPT partition

This function depends on the feature "gdisk". See also Guestfs.guestfs.feature_available.

method part_set_mbr_id : string -> int -> int -> unit

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

method part_set_name : string -> int -> string -> unit

set partition name

method part_to_dev : string -> string

convert partition name to device name

method part_to_partnum : string -> int

convert partition name to partition number

method ping_daemon : unit -> unit

ping the guest daemon

method pread : string -> int -> int64 -> string

read part of a file

method pread_device : string -> int -> int64 -> string

read part of a device

method pvchange_uuid : string -> unit

generate a new random UUID for a physical volume

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method pvchange_uuid_all : unit -> unit

generate new random UUIDs for all physical volumes

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method pvcreate : string -> unit

create an LVM physical volume

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method pvremove : string -> unit

remove an LVM physical volume

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method pvresize : string -> unit

resize an LVM physical volume

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method pvresize_size : string -> int64 -> unit

resize an LVM physical volume (with size)

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method pvs : unit -> string array

list the LVM physical volumes (PVs)

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method pvs_full : unit -> lvm_pv array

list the LVM physical volumes (PVs)

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method pvuuid : string -> string

get the UUID of a physical volume

method pwrite : string -> string -> int64 -> int

write to part of a file

method pwrite_device : string -> string -> int64 -> int

write to part of a device

method read_file : string -> string

read a file

method read_lines : string -> string array

read file as lines

method readdir : string -> dirent array

read directories entries

method readlink : string -> string

read the target of a symbolic link

method readlinklist : string -> string array -> string array

readlink on multiple files

method realpath : string -> string

canonicalized absolute pathname

method remount : ?rw:bool -> string -> unit

remount a filesystem with different options

method remove_drive : string -> unit

remove a disk image

method removexattr : string -> string -> unit

remove extended attribute of a file or directory

This function depends on the feature "linuxxattrs". See also Guestfs.guestfs.feature_available.

method rename : string -> string -> unit

rename a file on the same filesystem

method resize2fs : string -> unit

resize an ext2, ext3 or ext4 filesystem

method resize2fs_M : string -> unit

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

method resize2fs_size : string -> int64 -> unit

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

method rm : string -> unit

remove a file

method rm_f : string -> unit

remove a file ignoring errors

method rm_rf : string -> unit

remove a file or directory recursively

method rmdir : string -> unit

remove a directory

method rmmountpoint : string -> unit

remove a mountpoint

method rsync : ?archive:bool -> ?deletedest:bool -> string -> string -> unit

synchronize the contents of two directories

This function depends on the feature "rsync". See also Guestfs.guestfs.feature_available.

method rsync_in : ?archive:bool -> ?deletedest:bool -> string -> string -> unit

synchronize host or remote filesystem with filesystem

This function depends on the feature "rsync". See also Guestfs.guestfs.feature_available.

method rsync_out : ?archive:bool -> ?deletedest:bool -> string -> string -> unit

synchronize filesystem with host or remote filesystem

This function depends on the feature "rsync". See also Guestfs.guestfs.feature_available.

method scrub_device : string -> unit

scrub (securely wipe) a device

This function depends on the feature "scrub". See also Guestfs.guestfs.feature_available.

method scrub_file : string -> unit

scrub (securely wipe) a file

This function depends on the feature "scrub". See also Guestfs.guestfs.feature_available.

method scrub_freespace : string -> unit

scrub (securely wipe) free space

This function depends on the feature "scrub". See also Guestfs.guestfs.feature_available.

method selinux_relabel : ?force:bool -> string -> string -> unit

relabel parts of the filesystem

This function depends on the feature "selinuxrelabel". See also Guestfs.guestfs.feature_available.

method set_append : string option -> unit

add options to kernel command line

method set_attach_method : string -> unit
Deprecated.Use Guestfs.guestfs.set_backend instead

set the backend

method set_autosync : bool -> unit

set autosync mode

method set_backend : string -> unit

set the backend

method set_backend_setting : string -> string -> unit

set a single per-backend settings string

method set_backend_settings : string array -> unit

replace per-backend settings strings

method set_cachedir : string option -> unit

set the appliance cache directory

method set_direct : bool -> unit
Deprecated.This is replaced by method internal_get_console_socket which is not exported by the OCaml bindings

enable or disable direct appliance mode

method set_e2attrs : ?clear:bool -> string -> string -> unit

set ext2 file attributes of a file

method set_e2generation : string -> int64 -> unit

set ext2 file generation of a file

method set_e2label : string -> string -> unit
Deprecated.Use Guestfs.guestfs.set_label instead

set the ext2/3/4 filesystem label

method set_e2uuid : string -> string -> unit
Deprecated.Use Guestfs.guestfs.set_uuid instead

set the ext2/3/4 filesystem UUID

method set_hv : string -> unit

set the hypervisor binary

method set_identifier : string -> unit

set the handle identifier

method set_label : string -> string -> unit

set filesystem label

method set_libvirt_requested_credential : int -> string -> unit

pass requested credential back to libvirt

method set_libvirt_supported_credentials : string array -> unit

set libvirt credentials supported by calling program

method set_memsize : int -> unit

set memory allocated to the hypervisor

method set_network : bool -> unit

set enable network flag

method set_path : string option -> unit

set the search path

method set_pgroup : bool -> unit

set process group flag

method set_program : string -> unit

set the program name

method set_qemu : string option -> unit
Deprecated.Use Guestfs.guestfs.set_hv instead

set the hypervisor binary (usually qemu)

method set_recovery_proc : bool -> unit

enable or disable the recovery process

method set_selinux : bool -> unit
Deprecated.Use Guestfs.guestfs.selinux_relabel instead

set SELinux enabled or disabled at appliance boot

method set_smp : int -> unit

set number of virtual CPUs in appliance

method set_tmpdir : string option -> unit

set the temporary directory

method set_trace : bool -> unit

enable or disable command traces

method set_uuid : string -> string -> unit

set the filesystem UUID

method set_uuid_random : string -> unit

set a random UUID for the filesystem

method set_verbose : bool -> unit

set verbose mode

method setcon : string -> unit
Deprecated.Use Guestfs.guestfs.selinux_relabel instead

set SELinux security context

This function depends on the feature "selinux". See also Guestfs.guestfs.feature_available.

method setxattr : string -> string -> int -> string -> unit

set extended attribute of a file or directory

This function depends on the feature "linuxxattrs". See also Guestfs.guestfs.feature_available.

method sfdisk : string -> int -> int -> int -> string array -> unit
Deprecated.Use Guestfs.guestfs.part_add instead

create partitions on a block device

method sfdiskM : string -> string array -> unit
Deprecated.Use Guestfs.guestfs.part_add instead

create partitions on a block device

method sfdisk_N : string -> int -> int -> int -> int -> string -> unit
Deprecated.Use Guestfs.guestfs.part_add instead

modify a single partition on a block device

method sfdisk_disk_geometry : string -> string

display the disk geometry from the partition table

method sfdisk_kernel_geometry : string -> string

display the kernel geometry

method sfdisk_l : string -> string
Deprecated.Use Guestfs.guestfs.part_list instead

display the partition table

method sh : string -> string

run a command via the shell

method sh_lines : string -> string array

run a command via the shell returning lines

method shutdown : unit -> unit

shutdown the hypervisor

method sleep : int -> unit

sleep for some seconds

method stat : string -> stat
Deprecated.Use Guestfs.guestfs.statns instead

get file information

method statns : string -> statns

get file information

method statvfs : string -> statvfs

get file system statistics

method strings : string -> string array

print the printable strings in a file

method strings_e : string -> string -> string array

print the printable strings in a file

method swapoff_device : string -> unit

disable swap on device

method swapoff_file : string -> unit

disable swap on file

method swapoff_label : string -> unit

disable swap on labeled swap partition

method swapoff_uuid : string -> unit

disable swap on swap partition by UUID

This function depends on the feature "linuxfsuuid". See also Guestfs.guestfs.feature_available.

method swapon_device : string -> unit

enable swap on device

method swapon_file : string -> unit

enable swap on file

method swapon_label : string -> unit

enable swap on labeled swap partition

method swapon_uuid : string -> unit

enable swap on swap partition by UUID

This function depends on the feature "linuxfsuuid". See also Guestfs.guestfs.feature_available.

method sync : unit -> unit

sync disks, writes are flushed through to the disk image

method syslinux : ?directory:string -> string -> unit

install the SYSLINUX bootloader

This function depends on the feature "syslinux". See also Guestfs.guestfs.feature_available.

method tail : string -> string array

return last 10 lines of a file

method tail_n : int -> string -> string array

return last N lines of a file

method tar_in : ?compress:string ->
       ?xattrs:bool -> ?selinux:bool -> ?acls:bool -> string -> string -> unit

unpack tarfile to directory

method tar_in_opts : ?compress:string ->
       ?xattrs:bool -> ?selinux:bool -> ?acls:bool -> string -> string -> unit

alias for Guestfs.guestfs.tar_in

method tar_out : ?compress:string ->
       ?numericowner:bool ->
       ?excludes:string array ->
       ?xattrs:bool -> ?selinux:bool -> ?acls:bool -> string -> string -> unit

pack directory into tarfile

method tar_out_opts : ?compress:string ->
       ?numericowner:bool ->
       ?excludes:string array ->
       ?xattrs:bool -> ?selinux:bool -> ?acls:bool -> string -> string -> unit

alias for Guestfs.guestfs.tar_out

method tgz_in : string -> string -> unit
Deprecated.Use Guestfs.guestfs.tar_in instead

unpack compressed tarball to directory

method tgz_out : string -> string -> unit
Deprecated.Use Guestfs.guestfs.tar_out instead

pack directory into compressed tarball

method touch : string -> unit

update file timestamps or create a new file

method truncate : string -> unit

truncate a file to zero size

method truncate_size : string -> int64 -> unit

truncate a file to a particular size

method tune2fs : ?force:bool ->
       ?maxmountcount:int ->
       ?mountcount:int ->
       ?errorbehavior:string ->
       ?group:int64 ->
       ?intervalbetweenchecks:int ->
       ?reservedblockspercentage:int ->
       ?lastmounteddirectory:string ->
       ?reservedblockscount:int64 -> ?user:int64 -> string -> unit

adjust ext2/ext3/ext4 filesystem parameters

method tune2fs_l : string -> (string * string) list

get ext2/ext3/ext4 superblock details

method txz_in : string -> string -> unit
Deprecated.Use Guestfs.guestfs.tar_in instead

unpack compressed tarball to directory

This function depends on the feature "xz". See also Guestfs.guestfs.feature_available.

method txz_out : string -> string -> unit
Deprecated.Use Guestfs.guestfs.tar_out instead

pack directory into compressed tarball

This function depends on the feature "xz". See also Guestfs.guestfs.feature_available.

method umask : int -> int

set file mode creation mask (umask)

method umount : ?force:bool -> ?lazyunmount:bool -> string -> unit

unmount a filesystem

method umount_opts : ?force:bool -> ?lazyunmount:bool -> string -> unit

alias for Guestfs.guestfs.umount

method umount_all : unit -> unit

unmount all filesystems

method umount_local : ?retry:bool -> unit -> unit

unmount a locally mounted filesystem

method upload : string -> string -> unit

upload a file from the local machine

method upload_offset : string -> string -> int64 -> unit

upload a file from the local machine with offset

method user_cancel : unit -> unit

cancel the current upload or download operation

method utimens : string -> int64 -> int64 -> int64 -> int64 -> unit

set timestamp of a file with nanosecond precision

method utsname : unit -> utsname

appliance kernel version

method version : unit -> version

get the library version number

method vfs_label : string -> string

get the filesystem label

method vfs_minimum_size : string -> int64

get minimum filesystem size

method vfs_type : string -> string

get the Linux VFS type corresponding to a mounted device

method vfs_uuid : string -> string

get the filesystem UUID

method vg_activate : bool -> string array -> unit

activate or deactivate some volume groups

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method vg_activate_all : bool -> unit

activate or deactivate all volume groups

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method vgchange_uuid : string -> unit

generate a new random UUID for a volume group

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method vgchange_uuid_all : unit -> unit

generate new random UUIDs for all volume groups

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method vgcreate : string -> string array -> unit

create an LVM volume group

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method vglvuuids : string -> string array

get the LV UUIDs of all LVs in the volume group

method vgmeta : string -> string

get volume group metadata

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method vgpvuuids : string -> string array

get the PV UUIDs containing the volume group

method vgremove : string -> unit

remove an LVM volume group

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method vgrename : string -> string -> unit

rename an LVM volume group

method vgs : unit -> string array

list the LVM volume groups (VGs)

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method vgs_full : unit -> lvm_vg array

list the LVM volume groups (VGs)

This function depends on the feature "lvm2". See also Guestfs.guestfs.feature_available.

method vgscan : unit -> unit
Deprecated.Use Guestfs.guestfs.lvm_scan instead

rescan for LVM physical volumes, volume groups and logical volumes

method vguuid : string -> string

get the UUID of a volume group

method wait_ready : unit -> unit
Deprecated.There is no documented replacement

wait until the hypervisor launches (no op)

method wc_c : string -> int

count characters in a file

method wc_l : string -> int

count lines in a file

method wc_w : string -> int

count words in a file

method wipefs : string -> unit

wipe a filesystem signature from a device

This function depends on the feature "wipefs". See also Guestfs.guestfs.feature_available.

method write : string -> string -> unit

create a new file

method write_append : string -> string -> unit

append content to end of file

method write_file : string -> string -> int -> unit
Deprecated.Use Guestfs.guestfs.write instead

create a file

method xfs_admin : ?extunwritten:bool ->
       ?imgfile:bool ->
       ?v2log:bool ->
       ?projid32bit:bool ->
       ?lazycounter:bool -> ?label:string -> ?uuid:string -> string -> unit

change parameters of an XFS filesystem

This function depends on the feature "xfs". See also Guestfs.guestfs.feature_available.

method xfs_growfs : ?datasec:bool ->
       ?logsec:bool ->
       ?rtsec:bool ->
       ?datasize:int64 ->
       ?logsize:int64 ->
       ?rtsize:int64 -> ?rtextsize:int64 -> ?maxpct:int -> string -> unit

expand an existing XFS filesystem

This function depends on the feature "xfs". See also Guestfs.guestfs.feature_available.

method xfs_info : string -> xfsinfo

get geometry of XFS filesystem

This function depends on the feature "xfs". See also Guestfs.guestfs.feature_available.

method xfs_repair : ?forcelogzero:bool ->
       ?nomodify:bool ->
       ?noprefetch:bool ->
       ?forcegeometry:bool ->
       ?maxmem:int64 ->
       ?ihashsize:int64 ->
       ?bhashsize:int64 ->
       ?agstride:int64 -> ?logdev:string -> ?rtdev:string -> string -> int

repair an XFS filesystem

This function depends on the feature "xfs". See also Guestfs.guestfs.feature_available.

method yara_destroy : unit -> unit

destroy previously loaded yara rules

This function depends on the feature "libyara". See also Guestfs.guestfs.feature_available.

method yara_load : string -> unit

load yara rules within libguestfs

This function depends on the feature "libyara". See also Guestfs.guestfs.feature_available.

method yara_scan : string -> yara_detection array

scan a file with the loaded yara rules

This function depends on the feature "libyara". See also Guestfs.guestfs.feature_available.

method zegrep : string -> string -> string array
Deprecated.Use Guestfs.guestfs.grep instead

return lines matching a pattern

method zegrepi : string -> string -> string array
Deprecated.Use Guestfs.guestfs.grep instead

return lines matching a pattern

method zero : string -> unit

write zeroes to the device

method zero_device : string -> unit

write zeroes to an entire device

method zero_free_space : string -> unit

zero free space in a filesystem

method zerofree : string -> unit

zero unused inodes and disk blocks on ext2/3 filesystem

This function depends on the feature "zerofree". See also Guestfs.guestfs.feature_available.

method zfgrep : string -> string -> string array
Deprecated.Use Guestfs.guestfs.grep instead

return lines matching a pattern

method zfgrepi : string -> string -> string array
Deprecated.Use Guestfs.guestfs.grep instead

return lines matching a pattern

method zfile : string -> string -> string
Deprecated.Use Guestfs.guestfs.file instead

determine file type inside a compressed file

method zgrep : string -> string -> string array
Deprecated.Use Guestfs.guestfs.grep instead

return lines matching a pattern

method zgrepi : string -> string -> string array
Deprecated.Use Guestfs.guestfs.grep instead

return lines matching a pattern