module Guestfs:sig
..end
For API documentation, the canonical reference is the guestfs(3) man page. The OCaml API uses almost exactly the same calls.
For examples written in OCaml see the
guestfs-ocaml(3) man page.
This is the module-style API. There is also an object-oriented API
(see the end of this file and Guestfs.guestfs
)
which is functionally completely equivalent, but is more compact.
type
t
guestfs_h
handle.exception Error of string
exception Handle_closed of string
Guestfs.t
handle
after calling Guestfs.close
on it. The string is the name of
the function that was called incorrectly.val create : ?environment:bool -> ?close_on_exit:bool -> unit -> t
Guestfs.t
handle.
?environment
defaults to true
. If set to false, it sets
the GUESTFS_CREATE_NO_ENVIRONMENT
flag.
?close_on_exit
defaults to true
. If set to false, it sets
the GUESTFS_CREATE_NO_CLOSE_ON_EXIT
flag.
val close : t -> unit
Guestfs.t
handle and free up all resources used
by it immediately.
Handles are closed by the garbage collector when they become
unreferenced, but callers can call this in order to provide
predictable cleanup.
type
event =
| |
EVENT_CLOSE |
| |
EVENT_SUBPROCESS_QUIT |
| |
EVENT_LAUNCH_DONE |
| |
EVENT_PROGRESS |
| |
EVENT_APPLIANCE |
| |
EVENT_LIBRARY |
| |
EVENT_TRACE |
| |
EVENT_ENTER |
| |
EVENT_LIBVIRT_AUTH |
| |
EVENT_WARNING |
val event_all : event list
type
event_handle
typeevent_callback =
event -> event_handle -> string -> int64 array -> unit
val set_event_callback : t ->
event_callback -> event list -> event_handle
set_event_callback g f es
sets f
as the event callback function
for all events in the set es
.
Note that if the closure captures a reference to the handle,
this reference will prevent the handle from being
automatically closed by the garbage collector.
val delete_event_callback : t -> event_handle -> unit
delete_event_callback g eh
removes a previously registered
event callback. See Guestfs.set_event_callback
.val event_to_string : event list -> string
event_to_string events
returns the event(s) as a printable string
for debugging etc.val last_errno : t -> int
last_errno g
returns the last errno that happened on the handle g
(or 0
if there was no errno). Note that the returned integer is the
raw errno number, and it is not related to the Unix.error
type.
Some raw errno numbers are exposed by the Guestfs.Errno
submodule,
and we can add more as required.
last_errno
can be overwritten by subsequent operations on a handle,
so if you want to capture the errno correctly, you must call this
in the Guestfs.Error
exception handler, before any other operation on g
.
Guestfs.Errno
submodule exposes some raw errno numbers,
which you can use to test the return value of Guestfs.last_errno
.module Errno:sig
..end
type
application = {
|
app_name : |
|
app_display_name : |
|
app_epoch : |
|
app_version : |
|
app_release : |
|
app_install_path : |
|
app_trans_path : |
|
app_publisher : |
|
app_url : |
|
app_source_package : |
|
app_summary : |
|
app_description : |
type
application2 = {
|
app2_name : |
|
app2_display_name : |
|
app2_epoch : |
|
app2_version : |
|
app2_release : |
|
app2_arch : |
|
app2_install_path : |
|
app2_trans_path : |
|
app2_publisher : |
|
app2_url : |
|
app2_source_package : |
|
app2_summary : |
|
app2_description : |
|
app2_spare1 : |
|
app2_spare2 : |
|
app2_spare3 : |
|
app2_spare4 : |
type
btrfsbalance = {
|
btrfsbalance_status : |
|
btrfsbalance_total : |
|
btrfsbalance_balanced : |
|
btrfsbalance_considered : |
|
btrfsbalance_left : |
type
btrfsqgroup = {
|
btrfsqgroup_id : |
|
btrfsqgroup_rfer : |
|
btrfsqgroup_excl : |
type
btrfsscrub = {
|
btrfsscrub_data_extents_scrubbed : |
|
btrfsscrub_tree_extents_scrubbed : |
|
btrfsscrub_data_bytes_scrubbed : |
|
btrfsscrub_tree_bytes_scrubbed : |
|
btrfsscrub_read_errors : |
|
btrfsscrub_csum_errors : |
|
btrfsscrub_verify_errors : |
|
btrfsscrub_no_csum : |
|
btrfsscrub_csum_discards : |
|
btrfsscrub_super_errors : |
|
btrfsscrub_malloc_errors : |
|
btrfsscrub_uncorrectable_errors : |
|
btrfsscrub_unverified_errors : |
|
btrfsscrub_corrected_errors : |
|
btrfsscrub_last_physical : |
type
btrfssubvolume = {
|
btrfssubvolume_id : |
|
btrfssubvolume_top_level_id : |
|
btrfssubvolume_path : |
type
dirent = {
|
ino : |
|
ftyp : |
|
name : |
type
hivex_node = {
|
hivex_node_h : |
type
hivex_value = {
|
hivex_value_h : |
type
inotify_event = {
|
in_wd : |
|
in_mask : |
|
: |
|
in_name : |
type
int_bool = {
|
i : |
|
b : |
type
isoinfo = {
|
iso_system_id : |
|
iso_volume_id : |
|
iso_volume_space_size : |
|
iso_volume_set_size : |
|
iso_volume_sequence_number : |
|
iso_logical_block_size : |
|
iso_volume_set_id : |
|
iso_publisher_id : |
|
iso_data_preparer_id : |
|
iso_application_id : |
|
iso_copyright_file_id : |
|
iso_abstract_file_id : |
|
iso_bibliographic_file_id : |
|
iso_volume_creation_t : |
|
iso_volume_modification_t : |
|
iso_volume_expiration_t : |
|
iso_volume_effective_t : |
type
lvm_lv = {
|
lv_name : |
|
lv_uuid : |
|
lv_attr : |
|
lv_major : |
|
lv_minor : |
|
lv_kernel_major : |
|
lv_kernel_minor : |
|
lv_size : |
|
seg_count : |
|
origin : |
|
snap_percent : |
|
copy_percent : |
|
move_pv : |
|
: |
|
mirror_log : |
|
modules : |
type
lvm_pv = {
|
pv_name : |
|
pv_uuid : |
|
pv_fmt : |
|
pv_size : |
|
dev_size : |
|
pv_free : |
|
pv_used : |
|
pv_attr : |
|
pv_pe_count : |
|
pv_pe_alloc_count : |
|
: |
|
pe_start : |
|
pv_mda_count : |
|
pv_mda_free : |
type
lvm_vg = {
|
vg_name : |
|
vg_uuid : |
|
vg_fmt : |
|
vg_attr : |
|
vg_size : |
|
vg_free : |
|
vg_sysid : |
|
vg_extent_size : |
|
vg_extent_count : |
|
vg_free_count : |
|
max_lv : |
|
max_pv : |
|
pv_count : |
|
lv_count : |
|
snap_count : |
|
vg_seqno : |
|
: |
|
vg_mda_count : |
|
vg_mda_free : |
type
mdstat = {
|
mdstat_device : |
|
mdstat_index : |
|
mdstat_flags : |
type
partition = {
|
part_num : |
|
part_start : |
|
part_end : |
|
part_size : |
type
stat = {
|
dev : |
|
ino : |
|
mode : |
|
nlink : |
|
uid : |
|
gid : |
|
rdev : |
|
size : |
|
blksize : |
|
blocks : |
|
atime : |
|
mtime : |
|
ctime : |
type
statns = {
|
st_dev : |
|
st_ino : |
|
st_mode : |
|
st_nlink : |
|
st_uid : |
|
st_gid : |
|
st_rdev : |
|
st_size : |
|
st_blksize : |
|
st_blocks : |
|
st_atime_sec : |
|
st_atime_nsec : |
|
st_mtime_sec : |
|
st_mtime_nsec : |
|
st_ctime_sec : |
|
st_ctime_nsec : |
|
st_spare1 : |
|
st_spare2 : |
|
st_spare3 : |
|
st_spare4 : |
|
st_spare5 : |
|
st_spare6 : |
type
statvfs = {
|
bsize : |
|
frsize : |
|
blocks : |
|
bfree : |
|
bavail : |
|
files : |
|
ffree : |
|
favail : |
|
fsid : |
|
flag : |
|
namemax : |
type
tsk_dirent = {
|
tsk_inode : |
|
tsk_type : |
|
tsk_size : |
|
tsk_name : |
|
tsk_flags : |
|
tsk_atime_sec : |
|
tsk_atime_nsec : |
|
tsk_mtime_sec : |
|
tsk_mtime_nsec : |
|
tsk_ctime_sec : |
|
tsk_ctime_nsec : |
|
tsk_crtime_sec : |
|
tsk_crtime_nsec : |
|
tsk_nlink : |
|
tsk_link : |
|
tsk_spare1 : |
type
utsname = {
|
uts_sysname : |
|
uts_release : |
|
uts_version : |
|
uts_machine : |
type
version = {
|
major : |
|
minor : |
|
release : |
|
extra : |
type
xattr = {
|
attrname : |
|
attrval : |
type
xfsinfo = {
|
xfs_mntpoint : |
|
xfs_inodesize : |
|
xfs_agcount : |
|
xfs_agsize : |
|
xfs_sectsize : |
|
xfs_attr : |
|
xfs_blocksize : |
|
xfs_datablocks : |
|
xfs_imaxpct : |
|
xfs_sunit : |
|
xfs_swidth : |
|
xfs_dirversion : |
|
xfs_dirblocksize : |
|
xfs_cimode : |
|
xfs_logname : |
|
xfs_logblocksize : |
|
xfs_logblocks : |
|
xfs_logversion : |
|
xfs_logsectsize : |
|
xfs_logsunit : |
|
xfs_lazycount : |
|
xfs_rtname : |
|
xfs_rtextsize : |
|
xfs_rtblocks : |
|
xfs_rtextents : |
type
yara_detection = {
|
yara_name : |
|
yara_rule : |
val acl_delete_def_file : t -> string -> unit
This function depends on the feature "acl". See also Guestfs.feature_available
.
Since 1.19.63
val acl_get_file : t -> string -> string -> string
This function depends on the feature "acl". See also Guestfs.feature_available
.
Since 1.19.63
val acl_set_file : t -> string -> string -> string -> unit
This function depends on the feature "acl". See also Guestfs.feature_available
.
Since 1.19.63
val add_cdrom : t -> string -> unit
val add_domain : t ->
?libvirturi:string ->
?readonly:bool ->
?iface:string ->
?live:bool ->
?allowuuid:bool ->
?readonlydisk:string ->
?cachemode:string -> ?discard:string -> ?copyonread:bool -> string -> int
val add_drive : t ->
?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 -> string -> unit
val add_drive_opts : t ->
?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 -> string -> unit
val add_drive_ro : t -> string -> unit
val add_drive_ro_with_if : t -> string -> string -> unit
Guestfs.add_drive
insteadval add_drive_scratch : t -> ?name:string -> ?label:string -> int64 -> unit
val add_drive_with_if : t -> string -> string -> unit
Guestfs.add_drive
insteadval add_libvirt_dom : t ->
?readonly:bool ->
?iface:string ->
?live:bool ->
?readonlydisk:string ->
?cachemode:string -> ?discard:string -> ?copyonread:bool -> int64 -> int
val aug_clear : t -> string -> unit
val aug_close : t -> unit
val aug_defnode : t -> string -> string -> string -> int_bool
val aug_defvar : t -> string -> string option -> int
val aug_get : t -> string -> string
val aug_init : t -> string -> int -> unit
val aug_insert : t -> string -> string -> bool -> unit
val aug_label : t -> string -> string
val aug_load : t -> unit
val aug_ls : t -> string -> string array
val aug_match : t -> string -> string array
val aug_mv : t -> string -> string -> unit
val aug_rm : t -> string -> int
val aug_save : t -> unit
val aug_set : t -> string -> string -> unit
val aug_setm : t -> string -> string option -> string -> int
val aug_transform : t -> ?remove:bool -> string -> string -> unit
val available : t -> string array -> unit
val available_all_groups : t -> string array
val base64_in : t -> string -> string -> unit
val base64_out : t -> string -> string -> unit
val blkdiscard : t -> string -> unit
This function depends on the feature "blkdiscard". See also Guestfs.feature_available
.
Since 1.25.44
val blkdiscardzeroes : t -> string -> bool
This function depends on the feature "blkdiscardzeroes". See also Guestfs.feature_available
.
Since 1.25.44
val blkid : t -> string -> (string * string) list
val blockdev_flushbufs : t -> string -> unit
val blockdev_getbsz : t -> string -> int
val blockdev_getro : t -> string -> bool
val blockdev_getsize64 : t -> string -> int64
val blockdev_getss : t -> string -> int
val blockdev_getsz : t -> string -> int64
val blockdev_rereadpt : t -> string -> unit
val blockdev_setbsz : t -> string -> int -> unit
val blockdev_setra : t -> string -> int -> unit
val blockdev_setro : t -> string -> unit
val blockdev_setrw : t -> string -> unit
val btrfs_balance_cancel : t -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.22
val btrfs_balance_pause : t -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.22
val btrfs_balance_resume : t -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.22
val btrfs_balance_status : t -> string -> btrfsbalance
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.26
val btrfs_device_add : t -> string array -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.17.35
val btrfs_device_delete : t -> string array -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.17.35
val btrfs_filesystem_balance : t -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.17.35
val btrfs_filesystem_defragment : t -> ?flush:bool -> ?compress:string -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.22
val btrfs_filesystem_resize : t -> ?size:int64 -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.11.17
val btrfs_filesystem_show : t -> string -> string array
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.33.29
val btrfs_filesystem_sync : t -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.17.35
val btrfs_fsck : t -> ?superblock:int64 -> ?repair:bool -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.17.43
val btrfs_image : t -> ?compresslevel:int -> string array -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.32
val btrfs_qgroup_assign : t -> string -> string -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.17
val btrfs_qgroup_create : t -> string -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.17
val btrfs_qgroup_destroy : t -> string -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.17
val btrfs_qgroup_limit : t -> string -> int64 -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.17
val btrfs_qgroup_remove : t -> string -> string -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.17
val btrfs_qgroup_show : t -> string -> btrfsqgroup array
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.17
val btrfs_quota_enable : t -> string -> bool -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.17
val btrfs_quota_rescan : t -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.17
val btrfs_replace : t -> string -> string -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.48
val btrfs_rescue_chunk_recover : t -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.22
val btrfs_rescue_super_recover : t -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.22
val btrfs_scrub_cancel : t -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.22
val btrfs_scrub_resume : t -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.22
val btrfs_scrub_start : t -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.22
val btrfs_scrub_status : t -> string -> btrfsscrub
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.26
val btrfs_set_seeding : t -> string -> bool -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.17.43
val btrfs_subvolume_create : t -> ?qgroupid:string -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.17.35
val btrfs_subvolume_create_opts : t -> ?qgroupid:string -> string -> unit
Guestfs.btrfs_subvolume_create
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.17.35
val btrfs_subvolume_delete : t -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.17.35
val btrfs_subvolume_get_default : t -> string -> int64
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.17
val btrfs_subvolume_list : t -> string -> btrfssubvolume array
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.17.35
val btrfs_subvolume_set_default : t -> int64 -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.17.35
val btrfs_subvolume_show : t -> string -> (string * string) list
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.17
val btrfs_subvolume_snapshot : t -> ?ro:bool -> ?qgroupid:string -> string -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.17.35
val btrfs_subvolume_snapshot_opts : t -> ?ro:bool -> ?qgroupid:string -> string -> string -> unit
Guestfs.btrfs_subvolume_snapshot
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.17.35
val btrfstune_enable_extended_inode_refs : t -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.29
val btrfstune_enable_skinny_metadata_extent_refs : t -> string -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.29
val btrfstune_seeding : t -> string -> bool -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.29.29
val c_pointer : t -> int64
val canonical_device_name : t -> string -> string
val cap_get_file : t -> string -> string
This function depends on the feature "linuxcaps". See also Guestfs.feature_available
.
Since 1.19.63
val cap_set_file : t -> string -> string -> unit
This function depends on the feature "linuxcaps". See also Guestfs.feature_available
.
Since 1.19.63
val case_sensitive_path : t -> string -> string
val cat : t -> string -> string
val checksum : t -> string -> string -> string
val checksum_device : t -> string -> string -> string
val checksums_out : t -> string -> string -> string -> unit
val chmod : t -> int -> string -> unit
val chown : t -> int -> int -> string -> unit
val clear_backend_setting : t -> string -> int
val command : t -> string array -> string
val command_lines : t -> string array -> string array
val compress_device_out : t -> ?level:int -> string -> string -> string -> unit
val compress_out : t -> ?level:int -> string -> string -> string -> unit
val config : t -> string -> string option -> unit
val copy_attributes : t ->
?all:bool ->
?mode:bool ->
?xattributes:bool -> ?ownership:bool -> string -> string -> unit
val copy_device_to_device : t ->
?srcoffset:int64 ->
?destoffset:int64 ->
?size:int64 -> ?sparse:bool -> ?append:bool -> string -> string -> unit
val copy_device_to_file : t ->
?srcoffset:int64 ->
?destoffset:int64 ->
?size:int64 -> ?sparse:bool -> ?append:bool -> string -> string -> unit
val copy_file_to_device : t ->
?srcoffset:int64 ->
?destoffset:int64 ->
?size:int64 -> ?sparse:bool -> ?append:bool -> string -> string -> unit
val copy_file_to_file : t ->
?srcoffset:int64 ->
?destoffset:int64 ->
?size:int64 -> ?sparse:bool -> ?append:bool -> string -> string -> unit
val copy_in : t -> string -> string -> unit
val copy_out : t -> string -> string -> unit
val copy_size : t -> string -> string -> int64 -> unit
Guestfs.copy_device_to_device
insteadval cp : t -> string -> string -> unit
val cp_a : t -> string -> string -> unit
val cp_r : t -> string -> string -> unit
val cpio_out : t -> ?format:string -> string -> string -> unit
val dd : t -> string -> string -> unit
Guestfs.copy_device_to_device
insteadval device_index : t -> string -> int
val df : t -> string
val df_h : t -> string
val disk_create : t ->
?backingfile:string ->
?backingformat:string ->
?preallocation:string ->
?compat:string -> ?clustersize:int -> string -> string -> int64 -> unit
val disk_format : t -> string -> string
val disk_has_backing_file : t -> string -> bool
val disk_virtual_size : t -> string -> int64
val dmesg : t -> string
val download : t -> string -> string -> unit
val download_blocks : t -> ?unallocated:bool -> string -> int64 -> int64 -> string -> unit
This function depends on the feature "sleuthkit". See also Guestfs.feature_available
.
Since 1.33.45
val download_inode : t -> string -> int64 -> string -> unit
This function depends on the feature "sleuthkit". See also Guestfs.feature_available
.
Since 1.33.14
val download_offset : t -> string -> string -> int64 -> int64 -> unit
val drop_caches : t -> int -> unit
val du : t -> string -> int64
val e2fsck : t -> ?correct:bool -> ?forceall:bool -> string -> unit
val e2fsck_f : t -> string -> unit
val echo_daemon : t -> string array -> string
val egrep : t -> string -> string -> string array
val egrepi : t -> string -> string -> string array
val equal : t -> string -> string -> bool
val exists : t -> string -> bool
val extlinux : t -> string -> unit
This function depends on the feature "extlinux". See also Guestfs.feature_available
.
Since 1.21.27
val f2fs_expand : t -> string -> unit
This function depends on the feature "f2fs". See also Guestfs.feature_available
.
Since 1.39.3
val fallocate : t -> string -> int -> unit
val fallocate64 : t -> string -> int64 -> unit
val feature_available : t -> string array -> bool
val fgrep : t -> string -> string -> string array
val fgrepi : t -> string -> string -> string array
val file : t -> string -> string
val file_architecture : t -> string -> string
val filesize : t -> string -> int64
val filesystem_available : t -> string -> bool
val filesystem_walk : t -> string -> tsk_dirent array
This function depends on the feature "libtsk". See also Guestfs.feature_available
.
Since 1.33.39
val fill : t -> int -> int -> string -> unit
val fill_dir : t -> string -> int -> unit
val fill_pattern : t -> string -> int -> string -> unit
val find : t -> string -> string array
val find0 : t -> string -> string -> unit
val find_inode : t -> string -> int64 -> tsk_dirent array
This function depends on the feature "libtsk". See also Guestfs.feature_available
.
Since 1.35.6
val findfs_label : t -> string -> string
val findfs_uuid : t -> string -> string
val fsck : t -> string -> string -> int
val fstrim : t ->
?offset:int64 -> ?length:int64 -> ?minimumfreeextent:int64 -> string -> unit
This function depends on the feature "fstrim". See also Guestfs.feature_available
.
Since 1.19.6
val get_append : t -> string option
val get_attach_method : t -> string
val get_autosync : t -> bool
val get_backend : t -> string
val get_backend_setting : t -> string -> string
val get_backend_settings : t -> string array
val get_cachedir : t -> string
val get_direct : t -> bool
val get_e2attrs : t -> string -> string
val get_e2generation : t -> string -> int64
val get_e2label : t -> string -> string
val get_e2uuid : t -> string -> string
val get_hv : t -> string
val get_identifier : t -> string
val get_libvirt_requested_credential_challenge : t -> int -> string
val get_libvirt_requested_credential_defresult : t -> int -> string
val get_libvirt_requested_credential_prompt : t -> int -> string
val get_libvirt_requested_credentials : t -> string array
val get_memsize : t -> int
val get_network : t -> bool
val get_path : t -> string
val get_pgroup : t -> bool
val get_pid : t -> int
val get_program : t -> string
val get_qemu : t -> string
val get_recovery_proc : t -> bool
val get_selinux : t -> bool
val get_smp : t -> int
val get_sockdir : t -> string
val get_state : t -> int
val get_tmpdir : t -> string
val get_trace : t -> bool
val get_umask : t -> int
val get_verbose : t -> bool
val getcon : t -> string
Guestfs.selinux_relabel
instead
This function depends on the feature "selinux". See also Guestfs.feature_available
.
Since 1.0.67
val getxattr : t -> string -> string -> string
This function depends on the feature "linuxxattrs". See also Guestfs.feature_available
.
Since 1.7.24
val getxattrs : t -> string -> xattr array
This function depends on the feature "linuxxattrs". See also Guestfs.feature_available
.
Since 1.0.59
val glob_expand : t -> ?directoryslash:bool -> string -> string array
val glob_expand_opts : t -> ?directoryslash:bool -> string -> string array
val grep : t ->
?extended:bool ->
?fixed:bool ->
?insensitive:bool -> ?compressed:bool -> string -> string -> string array
val grep_opts : t ->
?extended:bool ->
?fixed:bool ->
?insensitive:bool -> ?compressed:bool -> string -> string -> string array
val grepi : t -> string -> string -> string array
val grub_install : t -> string -> string -> unit
This function depends on the feature "grub". See also Guestfs.feature_available
.
Since 1.0.17
val head : t -> string -> string array
val head_n : t -> int -> string -> string array
val hexdump : t -> string -> string
val hivex_close : t -> unit
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.19.35
val hivex_commit : t -> string option -> unit
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.19.35
val hivex_node_add_child : t -> int64 -> string -> int64
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.19.35
val hivex_node_children : t -> int64 -> hivex_node array
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.19.35
val hivex_node_delete_child : t -> int64 -> unit
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.19.35
val hivex_node_get_child : t -> int64 -> string -> int64
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.19.35
val hivex_node_get_value : t -> int64 -> string -> int64
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.19.35
val hivex_node_name : t -> int64 -> string
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.19.35
val hivex_node_parent : t -> int64 -> int64
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.19.35
val hivex_node_set_value : t -> int64 -> string -> int64 -> string -> unit
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.19.35
val hivex_node_values : t -> int64 -> hivex_value array
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.19.35
val hivex_open : t ->
?verbose:bool -> ?debug:bool -> ?write:bool -> ?unsafe:bool -> string -> unit
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.19.35
val hivex_root : t -> int64
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.19.35
val hivex_value_key : t -> int64 -> string
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.19.35
val hivex_value_string : t -> int64 -> string
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.37.22
val hivex_value_type : t -> int64 -> int64
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.19.35
val hivex_value_utf8 : t -> int64 -> string
Guestfs.hivex_value_string
instead
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.19.35
val hivex_value_value : t -> int64 -> string
This function depends on the feature "hivex". See also Guestfs.feature_available
.
Since 1.19.35
val initrd_cat : t -> string -> string -> string
val initrd_list : t -> string -> string array
val inotify_add_watch : t -> string -> int -> int64
This function depends on the feature "inotify". See also Guestfs.feature_available
.
Since 1.0.66
val inotify_close : t -> unit
This function depends on the feature "inotify". See also Guestfs.feature_available
.
Since 1.0.66
val inotify_files : t -> string array
This function depends on the feature "inotify". See also Guestfs.feature_available
.
Since 1.0.66
val inotify_init : t -> int -> unit
This function depends on the feature "inotify". See also Guestfs.feature_available
.
Since 1.0.66
val inotify_read : t -> inotify_event array
This function depends on the feature "inotify". See also Guestfs.feature_available
.
Since 1.0.66
val inotify_rm_watch : t -> int -> unit
This function depends on the feature "inotify". See also Guestfs.feature_available
.
Since 1.0.66
val inspect_get_arch : t -> string -> string
val inspect_get_distro : t -> string -> string
val inspect_get_drive_mappings : t -> string -> (string * string) list
val inspect_get_filesystems : t -> string -> string array
val inspect_get_format : t -> string -> string
val inspect_get_hostname : t -> string -> string
val inspect_get_icon : t -> ?favicon:bool -> ?highquality:bool -> string -> string
val inspect_get_major_version : t -> string -> int
val inspect_get_minor_version : t -> string -> int
val inspect_get_mountpoints : t -> string -> (string * string) list
val inspect_get_osinfo : t -> string -> string
val inspect_get_package_format : t -> string -> string
val inspect_get_package_management : t -> string -> string
val inspect_get_product_name : t -> string -> string
val inspect_get_product_variant : t -> string -> string
val inspect_get_roots : t -> string array
val inspect_get_type : t -> string -> string
val inspect_get_windows_current_control_set : t -> string -> string
val inspect_get_windows_software_hive : t -> string -> string
val inspect_get_windows_system_hive : t -> string -> string
val inspect_get_windows_systemroot : t -> string -> string
val inspect_is_live : t -> string -> bool
val inspect_is_multipart : t -> string -> bool
val inspect_is_netinst : t -> string -> bool
val inspect_list_applications : t -> string -> application array
Guestfs.inspect_list_applications2
insteadval inspect_list_applications2 : t -> string -> application2 array
val inspect_os : t -> string array
val is_blockdev : t -> ?followsymlinks:bool -> string -> bool
val is_blockdev_opts : t -> ?followsymlinks:bool -> string -> bool
val is_busy : t -> bool
val is_chardev : t -> ?followsymlinks:bool -> string -> bool
val is_chardev_opts : t -> ?followsymlinks:bool -> string -> bool
val is_config : t -> bool
val is_dir : t -> ?followsymlinks:bool -> string -> bool
val is_dir_opts : t -> ?followsymlinks:bool -> string -> bool
val is_fifo : t -> ?followsymlinks:bool -> string -> bool
val is_fifo_opts : t -> ?followsymlinks:bool -> string -> bool
val is_file : t -> ?followsymlinks:bool -> string -> bool
val is_file_opts : t -> ?followsymlinks:bool -> string -> bool
val is_launching : t -> bool
val is_lv : t -> string -> bool
val is_ready : t -> bool
val is_socket : t -> ?followsymlinks:bool -> string -> bool
val is_socket_opts : t -> ?followsymlinks:bool -> string -> bool
val is_symlink : t -> string -> bool
val is_whole_device : t -> string -> bool
val is_zero : t -> string -> bool
val is_zero_device : t -> string -> bool
val isoinfo : t -> string -> isoinfo
val isoinfo_device : t -> string -> isoinfo
val journal_close : t -> unit
This function depends on the feature "journal". See also Guestfs.feature_available
.
Since 1.23.11
val journal_get : t -> xattr array
This function depends on the feature "journal". See also Guestfs.feature_available
.
Since 1.23.11
val journal_get_data_threshold : t -> int64
This function depends on the feature "journal". See also Guestfs.feature_available
.
Since 1.23.11
val journal_get_realtime_usec : t -> int64
This function depends on the feature "journal". See also Guestfs.feature_available
.
Since 1.27.18
val journal_next : t -> bool
This function depends on the feature "journal". See also Guestfs.feature_available
.
Since 1.23.11
val journal_open : t -> string -> unit
This function depends on the feature "journal". See also Guestfs.feature_available
.
Since 1.23.11
val journal_set_data_threshold : t -> int64 -> unit
This function depends on the feature "journal". See also Guestfs.feature_available
.
Since 1.23.11
val journal_skip : t -> int64 -> int64
This function depends on the feature "journal". See also Guestfs.feature_available
.
Since 1.23.11
val kill_subprocess : t -> unit
val launch : t -> unit
val lchown : t -> int -> int -> string -> unit
val ldmtool_create_all : t -> unit
This function depends on the feature "ldm". See also Guestfs.feature_available
.
Since 1.20.0
val ldmtool_diskgroup_disks : t -> string -> string array
This function depends on the feature "ldm". See also Guestfs.feature_available
.
Since 1.20.0
val ldmtool_diskgroup_name : t -> string -> string
This function depends on the feature "ldm". See also Guestfs.feature_available
.
Since 1.20.0
val ldmtool_diskgroup_volumes : t -> string -> string array
This function depends on the feature "ldm". See also Guestfs.feature_available
.
Since 1.20.0
val ldmtool_remove_all : t -> unit
This function depends on the feature "ldm". See also Guestfs.feature_available
.
Since 1.20.0
val ldmtool_scan : t -> string array
This function depends on the feature "ldm". See also Guestfs.feature_available
.
Since 1.20.0
val ldmtool_scan_devices : t -> string array -> string array
This function depends on the feature "ldm". See also Guestfs.feature_available
.
Since 1.20.0
val ldmtool_volume_hint : t -> string -> string -> string
This function depends on the feature "ldm". See also Guestfs.feature_available
.
Since 1.20.0
val ldmtool_volume_partitions : t -> string -> string -> string array
This function depends on the feature "ldm". See also Guestfs.feature_available
.
Since 1.20.0
val ldmtool_volume_type : t -> string -> string -> string
This function depends on the feature "ldm". See also Guestfs.feature_available
.
Since 1.20.0
val lgetxattr : t -> string -> string -> string
This function depends on the feature "linuxxattrs". See also Guestfs.feature_available
.
Since 1.7.24
val lgetxattrs : t -> string -> xattr array
This function depends on the feature "linuxxattrs". See also Guestfs.feature_available
.
Since 1.0.59
val list_devices : t -> string array
val list_disk_labels : t -> (string * string) list
val list_dm_devices : t -> string array
val list_filesystems : t -> (string * string) list
val list_ldm_partitions : t -> string array
This function depends on the feature "ldm". See also Guestfs.feature_available
.
Since 1.20.0
val list_ldm_volumes : t -> string array
This function depends on the feature "ldm". See also Guestfs.feature_available
.
Since 1.20.0
val list_md_devices : t -> string array
val list_partitions : t -> string array
val ll : t -> string -> string
val llz : t -> string -> string
Guestfs.lgetxattrs
insteadval ln : t -> string -> string -> unit
val ln_f : t -> string -> string -> unit
val ln_s : t -> string -> string -> unit
val ln_sf : t -> string -> string -> unit
val lremovexattr : t -> string -> string -> unit
This function depends on the feature "linuxxattrs". See also Guestfs.feature_available
.
Since 1.0.59
val ls : t -> string -> string array
val ls0 : t -> string -> string -> unit
val lsetxattr : t -> string -> string -> int -> string -> unit
This function depends on the feature "linuxxattrs". See also Guestfs.feature_available
.
Since 1.0.59
val lstat : t -> string -> stat
val lstatlist : t -> string -> string array -> stat array
val lstatns : t -> string -> statns
val lstatnslist : t -> string -> string array -> statns array
val luks_add_key : t -> string -> string -> string -> int -> unit
This function depends on the feature "luks". See also Guestfs.feature_available
.
Since 1.5.2
val luks_close : t -> string -> unit
This function depends on the feature "luks". See also Guestfs.feature_available
.
Since 1.5.1
val luks_format : t -> string -> string -> int -> unit
This function depends on the feature "luks". See also Guestfs.feature_available
.
Since 1.5.2
val luks_format_cipher : t -> string -> string -> int -> string -> unit
This function depends on the feature "luks". See also Guestfs.feature_available
.
Since 1.5.2
val luks_kill_slot : t -> string -> string -> int -> unit
This function depends on the feature "luks". See also Guestfs.feature_available
.
Since 1.5.2
val luks_open : t -> string -> string -> string -> unit
This function depends on the feature "luks". See also Guestfs.feature_available
.
Since 1.5.1
val luks_open_ro : t -> string -> string -> string -> unit
This function depends on the feature "luks". See also Guestfs.feature_available
.
Since 1.5.1
val lvcreate : t -> string -> string -> int -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 0.8
val lvcreate_free : t -> string -> string -> int -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 1.17.18
val lvm_canonical_lv_name : t -> string -> string
val lvm_clear_filter : t -> unit
val lvm_remove_all : t -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 0.8
val lvm_scan : t -> bool -> unit
val lvm_set_filter : t -> string array -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 1.5.1
val lvremove : t -> string -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 1.0.13
val lvrename : t -> string -> string -> unit
val lvresize : t -> string -> int -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 1.0.27
val lvresize_free : t -> string -> int -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 1.3.3
val lvs : t -> string array
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 0.4
val lvs_full : t -> lvm_lv array
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 0.4
val lvuuid : t -> string -> string
val lxattrlist : t -> string -> string array -> xattr array
This function depends on the feature "linuxxattrs". See also Guestfs.feature_available
.
Since 1.0.77
val max_disks : t -> int
val md_create : t ->
?missingbitmap:int64 ->
?nrdevices:int ->
?spare:int -> ?chunk:int64 -> ?level:string -> string -> string array -> unit
This function depends on the feature "mdadm". See also Guestfs.feature_available
.
Since 1.15.6
val md_detail : t -> string -> (string * string) list
This function depends on the feature "mdadm". See also Guestfs.feature_available
.
Since 1.15.6
val md_stat : t -> string -> mdstat array
This function depends on the feature "mdadm". See also Guestfs.feature_available
.
Since 1.17.21
val md_stop : t -> string -> unit
This function depends on the feature "mdadm". See also Guestfs.feature_available
.
Since 1.15.6
val mkdir : t -> string -> unit
val mkdir_mode : t -> string -> int -> unit
val mkdir_p : t -> string -> unit
val mkdtemp : t -> string -> string
val mke2fs : t ->
?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
val mke2fs_J : t -> string -> int -> string -> string -> unit
val mke2fs_JL : t -> string -> int -> string -> string -> unit
val mke2fs_JU : t -> string -> int -> string -> string -> unit
Guestfs.mke2fs
instead
This function depends on the feature "linuxfsuuid". See also Guestfs.feature_available
.
Since 1.0.68
val mke2journal : t -> int -> string -> unit
val mke2journal_L : t -> int -> string -> string -> unit
val mke2journal_U : t -> int -> string -> string -> unit
Guestfs.mke2fs
instead
This function depends on the feature "linuxfsuuid". See also Guestfs.feature_available
.
Since 1.0.68
val mkfifo : t -> int -> string -> unit
This function depends on the feature "mknod". See also Guestfs.feature_available
.
Since 1.0.55
val mkfs : t ->
?blocksize:int ->
?features:string ->
?inode:int -> ?sectorsize:int -> ?label:string -> string -> string -> unit
val mkfs_opts : t ->
?blocksize:int ->
?features:string ->
?inode:int -> ?sectorsize:int -> ?label:string -> string -> string -> unit
val mkfs_b : t -> string -> int -> string -> unit
val mkfs_btrfs : t ->
?allocstart:int64 ->
?bytecount:int64 ->
?datatype:string ->
?leafsize:int ->
?label:string ->
?metadata:string -> ?nodesize:int -> ?sectorsize:int -> string array -> unit
This function depends on the feature "btrfs". See also Guestfs.feature_available
.
Since 1.17.25
val mklost_and_found : t -> string -> unit
val mkmountpoint : t -> string -> unit
val mknod : t -> int -> int -> int -> string -> unit
This function depends on the feature "mknod". See also Guestfs.feature_available
.
Since 1.0.55
val mknod_b : t -> int -> int -> int -> string -> unit
This function depends on the feature "mknod". See also Guestfs.feature_available
.
Since 1.0.55
val mknod_c : t -> int -> int -> int -> string -> unit
This function depends on the feature "mknod". See also Guestfs.feature_available
.
Since 1.0.55
val mksquashfs : t ->
?compress:string -> ?excludes:string array -> string -> string -> unit
This function depends on the feature "squashfs". See also Guestfs.feature_available
.
Since 1.35.25
val mkswap : t -> ?label:string -> ?uuid:string -> string -> unit
val mkswap_opts : t -> ?label:string -> ?uuid:string -> string -> unit
val mkswap_L : t -> string -> string -> unit
val mkswap_U : t -> string -> string -> unit
Guestfs.mkswap
instead
This function depends on the feature "linuxfsuuid". See also Guestfs.feature_available
.
Since 1.0.55
val mkswap_file : t -> string -> unit
val mktemp : t -> ?suffix:string -> string -> string
val modprobe : t -> string -> unit
This function depends on the feature "linuxmodules". See also Guestfs.feature_available
.
Since 1.0.68
val mount : t -> string -> string -> unit
val mount_local : t ->
?readonly:bool ->
?options:string -> ?cachetimeout:int -> ?debugcalls:bool -> string -> unit
val mount_local_run : t -> unit
val mount_loop : t -> string -> string -> unit
val mount_options : t -> string -> string -> string -> unit
val mount_ro : t -> string -> string -> unit
val mount_vfs : t -> string -> string -> string -> string -> unit
val mountable_device : t -> string -> string
val mountable_subvolume : t -> string -> string
val mountpoints : t -> (string * string) list
val mounts : t -> string array
val mv : t -> string -> string -> unit
val nr_devices : t -> int
val ntfs_3g_probe : t -> bool -> string -> int
This function depends on the feature "ntfs3g". See also Guestfs.feature_available
.
Since 1.0.43
val ntfscat_i : t -> string -> int64 -> string -> unit
val ntfsclone_in : t -> string -> string -> unit
This function depends on the feature "ntfs3g". See also Guestfs.feature_available
.
Since 1.17.9
val ntfsclone_out : t ->
?metadataonly:bool ->
?rescue:bool ->
?ignorefscheck:bool ->
?preservetimestamps:bool -> ?force:bool -> string -> string -> unit
This function depends on the feature "ntfs3g". See also Guestfs.feature_available
.
Since 1.17.9
val ntfsfix : t -> ?clearbadsectors:bool -> string -> unit
This function depends on the feature "ntfs3g". See also Guestfs.feature_available
.
Since 1.17.9
val ntfsresize : t -> ?size:int64 -> ?force:bool -> string -> unit
This function depends on the feature "ntfsprogs". See also Guestfs.feature_available
.
Since 1.3.2
val ntfsresize_opts : t -> ?size:int64 -> ?force:bool -> string -> unit
Guestfs.ntfsresize
This function depends on the feature "ntfsprogs". See also Guestfs.feature_available
.
Since 1.3.2
val ntfsresize_size : t -> string -> int64 -> unit
Guestfs.ntfsresize
instead
This function depends on the feature "ntfsprogs". See also Guestfs.feature_available
.
Since 1.3.14
val parse_environment : t -> unit
val parse_environment_list : t -> string array -> unit
val part_add : t -> string -> string -> int64 -> int64 -> unit
val part_del : t -> string -> int -> unit
val part_disk : t -> string -> string -> unit
val part_expand_gpt : t -> string -> unit
This function depends on the feature "gdisk". See also Guestfs.feature_available
.
Since 1.33.2
val part_get_bootable : t -> string -> int -> bool
val part_get_disk_guid : t -> string -> string
This function depends on the feature "gdisk". See also Guestfs.feature_available
.
Since 1.33.2
val part_get_gpt_attributes : t -> string -> int -> int64
This function depends on the feature "gdisk". See also Guestfs.feature_available
.
Since 1.21.1
val part_get_gpt_guid : t -> string -> int -> string
This function depends on the feature "gdisk". See also Guestfs.feature_available
.
Since 1.29.25
val part_get_gpt_type : t -> string -> int -> string
This function depends on the feature "gdisk". See also Guestfs.feature_available
.
Since 1.21.1
val part_get_mbr_id : t -> string -> int -> int
val part_get_mbr_part_type : t -> string -> int -> string
val part_get_name : t -> string -> int -> string
val part_get_parttype : t -> string -> string
val part_init : t -> string -> string -> unit
val part_list : t -> string -> partition array
val part_resize : t -> string -> int -> int64 -> unit
val part_set_bootable : t -> string -> int -> bool -> unit
val part_set_disk_guid : t -> string -> string -> unit
This function depends on the feature "gdisk". See also Guestfs.feature_available
.
Since 1.33.2
val part_set_disk_guid_random : t -> string -> unit
This function depends on the feature "gdisk". See also Guestfs.feature_available
.
Since 1.33.2
val part_set_gpt_attributes : t -> string -> int -> int64 -> unit
This function depends on the feature "gdisk". See also Guestfs.feature_available
.
Since 1.21.1
val part_set_gpt_guid : t -> string -> int -> string -> unit
This function depends on the feature "gdisk". See also Guestfs.feature_available
.
Since 1.29.25
val part_set_gpt_type : t -> string -> int -> string -> unit
This function depends on the feature "gdisk". See also Guestfs.feature_available
.
Since 1.21.1
val part_set_mbr_id : t -> string -> int -> int -> unit
val part_set_name : t -> string -> int -> string -> unit
val part_to_dev : t -> string -> string
val part_to_partnum : t -> string -> int
val ping_daemon : t -> unit
val pread : t -> string -> int -> int64 -> string
val pread_device : t -> string -> int -> int64 -> string
val pvchange_uuid : t -> string -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 1.19.26
val pvchange_uuid_all : t -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 1.19.26
val pvcreate : t -> string -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 0.8
val pvremove : t -> string -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 1.0.13
val pvresize : t -> string -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 1.0.26
val pvresize_size : t -> string -> int64 -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 1.3.14
val pvs : t -> string array
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 0.4
val pvs_full : t -> lvm_pv array
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 0.4
val pvuuid : t -> string -> string
val pwrite : t -> string -> string -> int64 -> int
val pwrite_device : t -> string -> string -> int64 -> int
val read_file : t -> string -> string
val read_lines : t -> string -> string array
val readdir : t -> string -> dirent array
val readlink : t -> string -> string
val readlinklist : t -> string -> string array -> string array
val realpath : t -> string -> string
val remount : t -> ?rw:bool -> string -> unit
val remove_drive : t -> string -> unit
val removexattr : t -> string -> string -> unit
This function depends on the feature "linuxxattrs". See also Guestfs.feature_available
.
Since 1.0.59
val rename : t -> string -> string -> unit
val resize2fs : t -> string -> unit
val resize2fs_M : t -> string -> unit
val resize2fs_size : t -> string -> int64 -> unit
val rm : t -> string -> unit
val rm_f : t -> string -> unit
val rm_rf : t -> string -> unit
val rmdir : t -> string -> unit
val rmmountpoint : t -> string -> unit
val rsync : t -> ?archive:bool -> ?deletedest:bool -> string -> string -> unit
This function depends on the feature "rsync". See also Guestfs.feature_available
.
Since 1.19.29
val rsync_in : t -> ?archive:bool -> ?deletedest:bool -> string -> string -> unit
This function depends on the feature "rsync". See also Guestfs.feature_available
.
Since 1.19.29
val rsync_out : t -> ?archive:bool -> ?deletedest:bool -> string -> string -> unit
This function depends on the feature "rsync". See also Guestfs.feature_available
.
Since 1.19.29
val scrub_device : t -> string -> unit
This function depends on the feature "scrub". See also Guestfs.feature_available
.
Since 1.0.52
val scrub_file : t -> string -> unit
This function depends on the feature "scrub". See also Guestfs.feature_available
.
Since 1.0.52
val scrub_freespace : t -> string -> unit
This function depends on the feature "scrub". See also Guestfs.feature_available
.
Since 1.0.52
val selinux_relabel : t -> ?force:bool -> string -> string -> unit
This function depends on the feature "selinuxrelabel". See also Guestfs.feature_available
.
Since 1.33.43
val set_append : t -> string option -> unit
val set_attach_method : t -> string -> unit
val set_autosync : t -> bool -> unit
val set_backend : t -> string -> unit
val set_backend_setting : t -> string -> string -> unit
val set_backend_settings : t -> string array -> unit
val set_cachedir : t -> string option -> unit
val set_direct : t -> bool -> unit
val set_e2attrs : t -> ?clear:bool -> string -> string -> unit
val set_e2generation : t -> string -> int64 -> unit
val set_e2label : t -> string -> string -> unit
val set_e2uuid : t -> string -> string -> unit
val set_hv : t -> string -> unit
val set_identifier : t -> string -> unit
val set_label : t -> string -> string -> unit
val set_libvirt_requested_credential : t -> int -> string -> unit
val set_libvirt_supported_credentials : t -> string array -> unit
val set_memsize : t -> int -> unit
val set_network : t -> bool -> unit
val set_path : t -> string option -> unit
val set_pgroup : t -> bool -> unit
val set_program : t -> string -> unit
val set_qemu : t -> string option -> unit
val set_recovery_proc : t -> bool -> unit
val set_selinux : t -> bool -> unit
Guestfs.selinux_relabel
insteadval set_smp : t -> int -> unit
val set_tmpdir : t -> string option -> unit
val set_trace : t -> bool -> unit
val set_uuid : t -> string -> string -> unit
val set_uuid_random : t -> string -> unit
val set_verbose : t -> bool -> unit
val setcon : t -> string -> unit
Guestfs.selinux_relabel
instead
This function depends on the feature "selinux". See also Guestfs.feature_available
.
Since 1.0.67
val setxattr : t -> string -> string -> int -> string -> unit
This function depends on the feature "linuxxattrs". See also Guestfs.feature_available
.
Since 1.0.59
val sfdisk : t -> string -> int -> int -> int -> string array -> unit
val sfdiskM : t -> string -> string array -> unit
val sfdisk_N : t -> string -> int -> int -> int -> int -> string -> unit
val sfdisk_disk_geometry : t -> string -> string
val sfdisk_kernel_geometry : t -> string -> string
val sfdisk_l : t -> string -> string
val sh : t -> string -> string
val sh_lines : t -> string -> string array
val shutdown : t -> unit
val sleep : t -> int -> unit
val stat : t -> string -> stat
val statns : t -> string -> statns
val statvfs : t -> string -> statvfs
val strings : t -> string -> string array
val strings_e : t -> string -> string -> string array
val swapoff_device : t -> string -> unit
val swapoff_file : t -> string -> unit
val swapoff_label : t -> string -> unit
val swapoff_uuid : t -> string -> unit
This function depends on the feature "linuxfsuuid". See also Guestfs.feature_available
.
Since 1.0.66
val swapon_device : t -> string -> unit
val swapon_file : t -> string -> unit
val swapon_label : t -> string -> unit
val swapon_uuid : t -> string -> unit
This function depends on the feature "linuxfsuuid". See also Guestfs.feature_available
.
Since 1.0.66
val sync : t -> unit
val syslinux : t -> ?directory:string -> string -> unit
This function depends on the feature "syslinux". See also Guestfs.feature_available
.
Since 1.21.27
val tail : t -> string -> string array
val tail_n : t -> int -> string -> string array
val tar_in : t ->
?compress:string ->
?xattrs:bool -> ?selinux:bool -> ?acls:bool -> string -> string -> unit
val tar_in_opts : t ->
?compress:string ->
?xattrs:bool -> ?selinux:bool -> ?acls:bool -> string -> string -> unit
val tar_out : t ->
?compress:string ->
?numericowner:bool ->
?excludes:string array ->
?xattrs:bool -> ?selinux:bool -> ?acls:bool -> string -> string -> unit
val tar_out_opts : t ->
?compress:string ->
?numericowner:bool ->
?excludes:string array ->
?xattrs:bool -> ?selinux:bool -> ?acls:bool -> string -> string -> unit
val tgz_in : t -> string -> string -> unit
val tgz_out : t -> string -> string -> unit
val touch : t -> string -> unit
val truncate : t -> string -> unit
val truncate_size : t -> string -> int64 -> unit
val tune2fs : t ->
?force:bool ->
?maxmountcount:int ->
?mountcount:int ->
?errorbehavior:string ->
?group:int64 ->
?intervalbetweenchecks:int ->
?reservedblockspercentage:int ->
?lastmounteddirectory:string ->
?reservedblockscount:int64 -> ?user:int64 -> string -> unit
val tune2fs_l : t -> string -> (string * string) list
val txz_in : t -> string -> string -> unit
Guestfs.tar_in
instead
This function depends on the feature "xz". See also Guestfs.feature_available
.
Since 1.3.2
val txz_out : t -> string -> string -> unit
Guestfs.tar_out
instead
This function depends on the feature "xz". See also Guestfs.feature_available
.
Since 1.3.2
val umask : t -> int -> int
val umount : t -> ?force:bool -> ?lazyunmount:bool -> string -> unit
val umount_opts : t -> ?force:bool -> ?lazyunmount:bool -> string -> unit
val umount_all : t -> unit
val umount_local : t -> ?retry:bool -> unit
val upload : t -> string -> string -> unit
val upload_offset : t -> string -> string -> int64 -> unit
val user_cancel : t -> unit
val utimens : t -> string -> int64 -> int64 -> int64 -> int64 -> unit
val utsname : t -> utsname
val version : t -> version
val vfs_label : t -> string -> string
val vfs_minimum_size : t -> string -> int64
val vfs_type : t -> string -> string
val vfs_uuid : t -> string -> string
val vg_activate : t -> bool -> string array -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 1.0.26
val vg_activate_all : t -> bool -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 1.0.26
val vgchange_uuid : t -> string -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 1.19.26
val vgchange_uuid_all : t -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 1.19.26
val vgcreate : t -> string -> string array -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 0.8
val vglvuuids : t -> string -> string array
val vgmeta : t -> string -> string
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 1.17.20
val vgpvuuids : t -> string -> string array
val vgremove : t -> string -> unit
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 1.0.13
val vgrename : t -> string -> string -> unit
val vgs : t -> string array
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 0.4
val vgs_full : t -> lvm_vg array
This function depends on the feature "lvm2". See also Guestfs.feature_available
.
Since 0.4
val vgscan : t -> unit
Guestfs.lvm_scan
insteadval vguuid : t -> string -> string
val wait_ready : t -> unit
val wc_c : t -> string -> int
val wc_l : t -> string -> int
val wc_w : t -> string -> int
val wipefs : t -> string -> unit
This function depends on the feature "wipefs". See also Guestfs.feature_available
.
Since 1.17.6
val write : t -> string -> string -> unit
val write_append : t -> string -> string -> unit
val write_file : t -> string -> string -> int -> unit
val xfs_admin : t ->
?extunwritten:bool ->
?imgfile:bool ->
?v2log:bool ->
?projid32bit:bool ->
?lazycounter:bool -> ?label:string -> ?uuid:string -> string -> unit
This function depends on the feature "xfs". See also Guestfs.feature_available
.
Since 1.19.33
val xfs_growfs : t ->
?datasec:bool ->
?logsec:bool ->
?rtsec:bool ->
?datasize:int64 ->
?logsize:int64 ->
?rtsize:int64 -> ?rtextsize:int64 -> ?maxpct:int -> string -> unit
This function depends on the feature "xfs". See also Guestfs.feature_available
.
Since 1.19.28
val xfs_info : t -> string -> xfsinfo
This function depends on the feature "xfs". See also Guestfs.feature_available
.
Since 1.19.21
val xfs_repair : t ->
?forcelogzero:bool ->
?nomodify:bool ->
?noprefetch:bool ->
?forcegeometry:bool ->
?maxmem:int64 ->
?ihashsize:int64 ->
?bhashsize:int64 ->
?agstride:int64 -> ?logdev:string -> ?rtdev:string -> string -> int
This function depends on the feature "xfs". See also Guestfs.feature_available
.
Since 1.19.36
val yara_destroy : t -> unit
This function depends on the feature "libyara". See also Guestfs.feature_available
.
Since 1.37.13
val yara_load : t -> string -> unit
This function depends on the feature "libyara". See also Guestfs.feature_available
.
Since 1.37.13
val yara_scan : t -> string -> yara_detection array
This function depends on the feature "libyara". See also Guestfs.feature_available
.
Since 1.37.13
val zegrep : t -> string -> string -> string array
val zegrepi : t -> string -> string -> string array
val zero : t -> string -> unit
val zero_device : t -> string -> unit
val zero_free_space : t -> string -> unit
val zerofree : t -> string -> unit
This function depends on the feature "zerofree". See also Guestfs.feature_available
.
Since 1.0.26
val zfgrep : t -> string -> string -> string array
val zfgrepi : t -> string -> string -> string array
val zfile : t -> string -> string -> string
val zgrep : t -> string -> string -> string array
val zgrepi : t -> string -> string -> string array
This is an alternate way of calling the API using an object-oriented
style, so you can use
g#
add_drive_opts filename
instead of Guestfs.add_drive_opts g filename
.
Apart from the different style, it offers exactly the same functionality.
Calling new guestfs ()
creates both the object and the handle.
The object and handle are closed either implicitly when the
object is garbage collected, or explicitly by calling the
g#
close ()
method.
You can get the Guestfs.t
handle by calling
g#
ocaml_handle.
Note that methods that take no required parameters
(except the implicit handle) get an extra unit ()
parameter.
This is so you can create a closure from the method easily.
For example g#
get_verbose ()
calls the method, whereas g#get_verbose
is a function.
class guestfs :?environment:bool -> ?close_on_exit:bool -> unit ->
object
..end