1 (* libguestfs generated file
2 * WARNING: THIS FILE IS GENERATED BY 'src/generator.ml'.
3 * ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.
5 * Copyright (C) 2009 Red Hat Inc.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 (** For API documentation you should refer to the C API
23 in the guestfs(3) manual page. The OCaml API uses almost
24 exactly the same calls. *)
27 (** A [guestfs_h] handle. *)
29 exception Error of string
30 (** This exception is raised when there is an error. *)
32 val create : unit -> t
35 (** Handles are closed by the garbage collector when they become
36 unreferenced, but callers can also call this in order to
37 provide predictable cleanup. *)
39 val launch : t -> unit
40 val wait_ready : t -> unit
41 val kill_subprocess : t -> unit
43 val add_drive : t -> string -> unit
44 val add_cdrom : t -> string -> unit
45 val config : t -> string -> string option -> unit
47 val set_path : t -> string option -> unit
48 val get_path : t -> string
49 val set_autosync : t -> bool -> unit
50 val get_autosync : t -> bool
51 val set_verbose : t -> bool -> unit
52 val get_verbose : t -> bool
64 pv_pe_alloc_count : int64;
79 vg_extent_size : int64;
80 vg_extent_count : int64;
81 vg_free_count : int64;
99 lv_kernel_major : int64;
100 lv_kernel_minor : int64;
104 snap_percent : float option;
105 copy_percent : float option;
112 val cat : t -> string -> string
113 (** list the contents of a file *)
115 val list_devices : t -> string list
116 (** list the block devices *)
118 val list_partitions : t -> string list
119 (** list the partitions *)
121 val ll : t -> string -> string
122 (** list the files in a directory (long format) *)
124 val ls : t -> string -> string list
125 (** list the files in a directory *)
127 val lvs : t -> string list
128 (** list the LVM logical volumes (LVs) *)
130 val lvs_full : t -> lvm_lv list
131 (** list the LVM logical volumes (LVs) *)
133 val mount : t -> string -> string -> unit
134 (** mount a guest disk at a position in the filesystem *)
136 val pvs : t -> string list
137 (** list the LVM physical volumes (PVs) *)
139 val pvs_full : t -> lvm_pv list
140 (** list the LVM physical volumes (PVs) *)
143 (** sync disks, writes are flushed through to the disk image *)
145 val touch : t -> string -> unit
146 (** update file timestamps or create a new file *)
148 val vgs : t -> string list
149 (** list the LVM volume groups (VGs) *)
151 val vgs_full : t -> lvm_vg list
152 (** list the LVM volume groups (VGs) *)