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. *)
49 pv_pe_alloc_count : int64;
64 vg_extent_size : int64;
65 vg_extent_count : int64;
66 vg_free_count : int64;
84 lv_kernel_major : int64;
85 lv_kernel_minor : int64;
89 snap_percent : float option;
90 copy_percent : float option;
127 val launch : t -> unit
128 (** launch the qemu subprocess *)
130 val wait_ready : t -> unit
131 (** wait until the qemu subprocess launches *)
133 val kill_subprocess : t -> unit
134 (** kill the qemu subprocess *)
136 val add_drive : t -> string -> unit
137 (** add an image to examine or modify *)
139 val add_cdrom : t -> string -> unit
140 (** add a CD-ROM disk image to examine *)
142 val config : t -> string -> string option -> unit
143 (** add qemu parameters *)
145 val set_path : t -> string -> unit
146 (** set the search path *)
148 val get_path : t -> string
149 (** get the search path *)
151 val set_autosync : t -> bool -> unit
152 (** set autosync mode *)
154 val get_autosync : t -> bool
155 (** get autosync mode *)
157 val set_verbose : t -> bool -> unit
158 (** set verbose mode *)
160 val get_verbose : t -> bool
161 (** get verbose mode *)
163 val is_ready : t -> bool
164 (** is ready to accept commands *)
166 val is_config : t -> bool
167 (** is in configuration state *)
169 val is_launching : t -> bool
170 (** is launching subprocess *)
172 val is_busy : t -> bool
173 (** is busy processing a command *)
175 val get_state : t -> int
176 (** get the current state *)
178 val set_busy : t -> unit
179 (** set state to busy *)
181 val set_ready : t -> unit
182 (** set state to ready *)
184 val mount : t -> string -> string -> unit
185 (** mount a guest disk at a position in the filesystem *)
188 (** sync disks, writes are flushed through to the disk image *)
190 val touch : t -> string -> unit
191 (** update file timestamps or create a new file *)
193 val cat : t -> string -> string
194 (** list the contents of a file *)
196 val ll : t -> string -> string
197 (** list the files in a directory (long format) *)
199 val ls : t -> string -> string array
200 (** list the files in a directory *)
202 val list_devices : t -> string array
203 (** list the block devices *)
205 val list_partitions : t -> string array
206 (** list the partitions *)
208 val pvs : t -> string array
209 (** list the LVM physical volumes (PVs) *)
211 val vgs : t -> string array
212 (** list the LVM volume groups (VGs) *)
214 val lvs : t -> string array
215 (** list the LVM logical volumes (LVs) *)
217 val pvs_full : t -> lvm_pv array
218 (** list the LVM physical volumes (PVs) *)
220 val vgs_full : t -> lvm_vg array
221 (** list the LVM volume groups (VGs) *)
223 val lvs_full : t -> lvm_lv array
224 (** list the LVM logical volumes (LVs) *)
226 val read_lines : t -> string -> string array
227 (** read file as lines *)
229 val aug_init : t -> string -> int -> unit
230 (** create a new Augeas handle *)
232 val aug_close : t -> unit
233 (** close the current Augeas handle *)
235 val aug_defvar : t -> string -> string option -> int
236 (** define an Augeas variable *)
238 val aug_defnode : t -> string -> string -> string -> int * bool
239 (** define an Augeas node *)
241 val aug_get : t -> string -> string
242 (** look up the value of an Augeas path *)
244 val aug_set : t -> string -> string -> unit
245 (** set Augeas path to value *)
247 val aug_insert : t -> string -> string -> bool -> unit
248 (** insert a sibling Augeas node *)
250 val aug_rm : t -> string -> int
251 (** remove an Augeas path *)
253 val aug_mv : t -> string -> string -> unit
254 (** move Augeas node *)
256 val aug_match : t -> string -> string array
257 (** return Augeas nodes which match path *)
259 val aug_save : t -> unit
260 (** write all pending Augeas changes to disk *)
262 val aug_load : t -> unit
263 (** load files into the tree *)
265 val aug_ls : t -> string -> string array
266 (** list Augeas nodes under a path *)
268 val rm : t -> string -> unit
271 val rmdir : t -> string -> unit
272 (** remove a directory *)
274 val rm_rf : t -> string -> unit
275 (** remove a file or directory recursively *)
277 val mkdir : t -> string -> unit
278 (** create a directory *)
280 val mkdir_p : t -> string -> unit
281 (** create a directory and parents *)
283 val chmod : t -> int -> string -> unit
284 (** change file mode *)
286 val chown : t -> int -> int -> string -> unit
287 (** change file owner and group *)
289 val exists : t -> string -> bool
290 (** test if file or directory exists *)
292 val is_file : t -> string -> bool
293 (** test if file exists *)
295 val is_dir : t -> string -> bool
296 (** test if file exists *)
298 val pvcreate : t -> string -> unit
299 (** create an LVM physical volume *)
301 val vgcreate : t -> string -> string array -> unit
302 (** create an LVM volume group *)
304 val lvcreate : t -> string -> string -> int -> unit
305 (** create an LVM volume group *)
307 val mkfs : t -> string -> string -> unit
308 (** make a filesystem *)
310 val sfdisk : t -> string -> int -> int -> int -> string array -> unit
311 (** create partitions on a block device *)
313 val write_file : t -> string -> string -> int -> unit
316 val umount : t -> string -> unit
317 (** unmount a filesystem *)
319 val mounts : t -> string array
320 (** show mounted filesystems *)
322 val umount_all : t -> unit
323 (** unmount all filesystems *)
325 val lvm_remove_all : t -> unit
326 (** remove all LVM LVs, VGs and PVs *)
328 val file : t -> string -> string
329 (** determine file type *)
331 val command : t -> string array -> string
332 (** run a command from the guest filesystem *)
334 val command_lines : t -> string array -> string array
335 (** run a command, returning lines *)
337 val stat : t -> string -> stat
338 (** get file information *)
340 val lstat : t -> string -> stat
341 (** get file information for a symbolic link *)
343 val statvfs : t -> string -> statvfs
344 (** get file system statistics *)
346 val tune2fs_l : t -> string -> (string * string) list
347 (** get ext2/ext3 superblock details *)
349 val blockdev_setro : t -> string -> unit
350 (** set block device to read-only *)
352 val blockdev_setrw : t -> string -> unit
353 (** set block device to read-write *)
355 val blockdev_getro : t -> string -> bool
356 (** is block device set to read-only *)
358 val blockdev_getss : t -> string -> int
359 (** get sectorsize of block device *)
361 val blockdev_getbsz : t -> string -> int
362 (** get blocksize of block device *)
364 val blockdev_setbsz : t -> string -> int -> unit
365 (** set blocksize of block device *)
367 val blockdev_getsz : t -> string -> int64
368 (** get total size of device in 512-byte sectors *)
370 val blockdev_getsize64 : t -> string -> int64
371 (** get total size of device in bytes *)
373 val blockdev_flushbufs : t -> string -> unit
374 (** flush device buffers *)
376 val blockdev_rereadpt : t -> string -> unit
377 (** reread partition table *)
379 val upload : t -> string -> string -> unit
380 (** upload a file from the local machine *)
382 val download : t -> string -> string -> unit
383 (** download a file to the local machine *)
385 val checksum : t -> string -> string -> string
386 (** compute MD5, SHAx or CRC checksum of file *)
388 val tar_in : t -> string -> string -> unit
389 (** unpack tarfile to directory *)
391 val tar_out : t -> string -> string -> unit
392 (** pack directory into tarfile *)
394 val tgz_in : t -> string -> string -> unit
395 (** unpack compressed tarball to directory *)
397 val tgz_out : t -> string -> string -> unit
398 (** pack directory into compressed tarball *)