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 test0 : t -> string -> string option -> string array -> bool -> int -> string -> string -> unit
128 (** internal test function - do not use *)
130 val test0rint : t -> string -> int
131 (** internal test function - do not use *)
133 val test0rinterr : t -> int
134 (** internal test function - do not use *)
136 val test0rint64 : t -> string -> int64
137 (** internal test function - do not use *)
139 val test0rint64err : t -> int64
140 (** internal test function - do not use *)
142 val test0rbool : t -> string -> bool
143 (** internal test function - do not use *)
145 val test0rboolerr : t -> bool
146 (** internal test function - do not use *)
148 val test0rconststring : t -> string -> string
149 (** internal test function - do not use *)
151 val test0rconststringerr : t -> string
152 (** internal test function - do not use *)
154 val test0rstring : t -> string -> string
155 (** internal test function - do not use *)
157 val test0rstringerr : t -> string
158 (** internal test function - do not use *)
160 val test0rstringlist : t -> string -> string array
161 (** internal test function - do not use *)
163 val test0rstringlisterr : t -> string array
164 (** internal test function - do not use *)
166 val test0rintbool : t -> string -> int * bool
167 (** internal test function - do not use *)
169 val test0rintboolerr : t -> int * bool
170 (** internal test function - do not use *)
172 val test0rpvlist : t -> string -> lvm_pv array
173 (** internal test function - do not use *)
175 val test0rpvlisterr : t -> lvm_pv array
176 (** internal test function - do not use *)
178 val test0rvglist : t -> string -> lvm_vg array
179 (** internal test function - do not use *)
181 val test0rvglisterr : t -> lvm_vg array
182 (** internal test function - do not use *)
184 val test0rlvlist : t -> string -> lvm_lv array
185 (** internal test function - do not use *)
187 val test0rlvlisterr : t -> lvm_lv array
188 (** internal test function - do not use *)
190 val test0rstat : t -> string -> stat
191 (** internal test function - do not use *)
193 val test0rstaterr : t -> stat
194 (** internal test function - do not use *)
196 val test0rstatvfs : t -> string -> statvfs
197 (** internal test function - do not use *)
199 val test0rstatvfserr : t -> statvfs
200 (** internal test function - do not use *)
202 val test0rhashtable : t -> string -> (string * string) list
203 (** internal test function - do not use *)
205 val test0rhashtableerr : t -> (string * string) list
206 (** internal test function - do not use *)
208 val launch : t -> unit
209 (** launch the qemu subprocess *)
211 val wait_ready : t -> unit
212 (** wait until the qemu subprocess launches *)
214 val kill_subprocess : t -> unit
215 (** kill the qemu subprocess *)
217 val add_drive : t -> string -> unit
218 (** add an image to examine or modify *)
220 val add_cdrom : t -> string -> unit
221 (** add a CD-ROM disk image to examine *)
223 val config : t -> string -> string option -> unit
224 (** add qemu parameters *)
226 val set_qemu : t -> string -> unit
227 (** set the qemu binary *)
229 val get_qemu : t -> string
230 (** get the qemu binary *)
232 val set_path : t -> string -> unit
233 (** set the search path *)
235 val get_path : t -> string
236 (** get the search path *)
238 val set_append : t -> string -> unit
239 (** add options to kernel command line *)
241 val get_append : t -> string
242 (** get the additional kernel options *)
244 val set_autosync : t -> bool -> unit
245 (** set autosync mode *)
247 val get_autosync : t -> bool
248 (** get autosync mode *)
250 val set_verbose : t -> bool -> unit
251 (** set verbose mode *)
253 val get_verbose : t -> bool
254 (** get verbose mode *)
256 val is_ready : t -> bool
257 (** is ready to accept commands *)
259 val is_config : t -> bool
260 (** is in configuration state *)
262 val is_launching : t -> bool
263 (** is launching subprocess *)
265 val is_busy : t -> bool
266 (** is busy processing a command *)
268 val get_state : t -> int
269 (** get the current state *)
271 val set_busy : t -> unit
272 (** set state to busy *)
274 val set_ready : t -> unit
275 (** set state to ready *)
277 val end_busy : t -> unit
278 (** leave the busy state *)
280 val mount : t -> string -> string -> unit
281 (** mount a guest disk at a position in the filesystem *)
284 (** sync disks, writes are flushed through to the disk image *)
286 val touch : t -> string -> unit
287 (** update file timestamps or create a new file *)
289 val cat : t -> string -> string
290 (** list the contents of a file *)
292 val ll : t -> string -> string
293 (** list the files in a directory (long format) *)
295 val ls : t -> string -> string array
296 (** list the files in a directory *)
298 val list_devices : t -> string array
299 (** list the block devices *)
301 val list_partitions : t -> string array
302 (** list the partitions *)
304 val pvs : t -> string array
305 (** list the LVM physical volumes (PVs) *)
307 val vgs : t -> string array
308 (** list the LVM volume groups (VGs) *)
310 val lvs : t -> string array
311 (** list the LVM logical volumes (LVs) *)
313 val pvs_full : t -> lvm_pv array
314 (** list the LVM physical volumes (PVs) *)
316 val vgs_full : t -> lvm_vg array
317 (** list the LVM volume groups (VGs) *)
319 val lvs_full : t -> lvm_lv array
320 (** list the LVM logical volumes (LVs) *)
322 val read_lines : t -> string -> string array
323 (** read file as lines *)
325 val aug_init : t -> string -> int -> unit
326 (** create a new Augeas handle *)
328 val aug_close : t -> unit
329 (** close the current Augeas handle *)
331 val aug_defvar : t -> string -> string option -> int
332 (** define an Augeas variable *)
334 val aug_defnode : t -> string -> string -> string -> int * bool
335 (** define an Augeas node *)
337 val aug_get : t -> string -> string
338 (** look up the value of an Augeas path *)
340 val aug_set : t -> string -> string -> unit
341 (** set Augeas path to value *)
343 val aug_insert : t -> string -> string -> bool -> unit
344 (** insert a sibling Augeas node *)
346 val aug_rm : t -> string -> int
347 (** remove an Augeas path *)
349 val aug_mv : t -> string -> string -> unit
350 (** move Augeas node *)
352 val aug_match : t -> string -> string array
353 (** return Augeas nodes which match path *)
355 val aug_save : t -> unit
356 (** write all pending Augeas changes to disk *)
358 val aug_load : t -> unit
359 (** load files into the tree *)
361 val aug_ls : t -> string -> string array
362 (** list Augeas nodes under a path *)
364 val rm : t -> string -> unit
367 val rmdir : t -> string -> unit
368 (** remove a directory *)
370 val rm_rf : t -> string -> unit
371 (** remove a file or directory recursively *)
373 val mkdir : t -> string -> unit
374 (** create a directory *)
376 val mkdir_p : t -> string -> unit
377 (** create a directory and parents *)
379 val chmod : t -> int -> string -> unit
380 (** change file mode *)
382 val chown : t -> int -> int -> string -> unit
383 (** change file owner and group *)
385 val exists : t -> string -> bool
386 (** test if file or directory exists *)
388 val is_file : t -> string -> bool
389 (** test if file exists *)
391 val is_dir : t -> string -> bool
392 (** test if file exists *)
394 val pvcreate : t -> string -> unit
395 (** create an LVM physical volume *)
397 val vgcreate : t -> string -> string array -> unit
398 (** create an LVM volume group *)
400 val lvcreate : t -> string -> string -> int -> unit
401 (** create an LVM volume group *)
403 val mkfs : t -> string -> string -> unit
404 (** make a filesystem *)
406 val sfdisk : t -> string -> int -> int -> int -> string array -> unit
407 (** create partitions on a block device *)
409 val write_file : t -> string -> string -> int -> unit
412 val umount : t -> string -> unit
413 (** unmount a filesystem *)
415 val mounts : t -> string array
416 (** show mounted filesystems *)
418 val umount_all : t -> unit
419 (** unmount all filesystems *)
421 val lvm_remove_all : t -> unit
422 (** remove all LVM LVs, VGs and PVs *)
424 val file : t -> string -> string
425 (** determine file type *)
427 val command : t -> string array -> string
428 (** run a command from the guest filesystem *)
430 val command_lines : t -> string array -> string array
431 (** run a command, returning lines *)
433 val stat : t -> string -> stat
434 (** get file information *)
436 val lstat : t -> string -> stat
437 (** get file information for a symbolic link *)
439 val statvfs : t -> string -> statvfs
440 (** get file system statistics *)
442 val tune2fs_l : t -> string -> (string * string) list
443 (** get ext2/ext3/ext4 superblock details *)
445 val blockdev_setro : t -> string -> unit
446 (** set block device to read-only *)
448 val blockdev_setrw : t -> string -> unit
449 (** set block device to read-write *)
451 val blockdev_getro : t -> string -> bool
452 (** is block device set to read-only *)
454 val blockdev_getss : t -> string -> int
455 (** get sectorsize of block device *)
457 val blockdev_getbsz : t -> string -> int
458 (** get blocksize of block device *)
460 val blockdev_setbsz : t -> string -> int -> unit
461 (** set blocksize of block device *)
463 val blockdev_getsz : t -> string -> int64
464 (** get total size of device in 512-byte sectors *)
466 val blockdev_getsize64 : t -> string -> int64
467 (** get total size of device in bytes *)
469 val blockdev_flushbufs : t -> string -> unit
470 (** flush device buffers *)
472 val blockdev_rereadpt : t -> string -> unit
473 (** reread partition table *)
475 val upload : t -> string -> string -> unit
476 (** upload a file from the local machine *)
478 val download : t -> string -> string -> unit
479 (** download a file to the local machine *)
481 val checksum : t -> string -> string -> string
482 (** compute MD5, SHAx or CRC checksum of file *)
484 val tar_in : t -> string -> string -> unit
485 (** unpack tarfile to directory *)
487 val tar_out : t -> string -> string -> unit
488 (** pack directory into tarfile *)
490 val tgz_in : t -> string -> string -> unit
491 (** unpack compressed tarball to directory *)
493 val tgz_out : t -> string -> string -> unit
494 (** pack directory into compressed tarball *)
496 val mount_ro : t -> string -> string -> unit
497 (** mount a guest disk, read-only *)
499 val mount_options : t -> string -> string -> string -> unit
500 (** mount a guest disk with mount options *)
502 val mount_vfs : t -> string -> string -> string -> string -> unit
503 (** mount a guest disk with mount options and vfstype *)
505 val debug : t -> string -> string array -> string
506 (** debugging and internals *)
508 val lvremove : t -> string -> unit
509 (** remove an LVM logical volume *)
511 val vgremove : t -> string -> unit
512 (** remove an LVM volume group *)
514 val pvremove : t -> string -> unit
515 (** remove an LVM physical volume *)
517 val set_e2label : t -> string -> string -> unit
518 (** set the ext2/3/4 filesystem label *)
520 val get_e2label : t -> string -> string
521 (** get the ext2/3/4 filesystem label *)
523 val set_e2uuid : t -> string -> string -> unit
524 (** set the ext2/3/4 filesystem UUID *)
526 val get_e2uuid : t -> string -> string
527 (** get the ext2/3/4 filesystem UUID *)
529 val fsck : t -> string -> string -> int
530 (** run the filesystem checker *)
532 val zero : t -> string -> unit
533 (** write zeroes to the device *)
535 val grub_install : t -> string -> string -> unit
538 val cp : t -> string -> string -> unit
541 val cp_a : t -> string -> string -> unit
542 (** copy a file or directory recursively *)
544 val mv : t -> string -> string -> unit
547 val drop_caches : t -> int -> unit
548 (** drop kernel page cache, dentries and inodes *)
550 val dmesg : t -> string
551 (** return kernel messages *)
553 val ping_daemon : t -> unit
554 (** ping the guest daemon *)
556 val equal : t -> string -> string -> bool
557 (** test if two files have equal contents *)
559 val strings : t -> string -> string array
560 (** print the printable strings in a file *)
562 val strings_e : t -> string -> string -> string array
563 (** print the printable strings in a file *)
565 val hexdump : t -> string -> string
566 (** dump a file in hexadecimal *)
568 val zerofree : t -> string -> unit
569 (** zero unused inodes and disk blocks on ext2/3 filesystem *)
571 val pvresize : t -> string -> unit
572 (** resize an LVM physical volume *)
574 val sfdisk_N : t -> string -> int -> int -> int -> int -> string -> unit
575 (** modify a single partition on a block device *)
577 val sfdisk_l : t -> string -> string
578 (** display the partition table *)
580 val sfdisk_kernel_geometry : t -> string -> string
581 (** display the kernel geometry *)
583 val sfdisk_disk_geometry : t -> string -> string
584 (** display the disk geometry from the partition table *)
586 val vg_activate_all : t -> bool -> unit
587 (** activate or deactivate all volume groups *)
589 val vg_activate : t -> bool -> string array -> unit
590 (** activate or deactivate some volume groups *)
592 val lvresize : t -> string -> int -> unit
593 (** resize an LVM logical volume *)
595 val resize2fs : t -> string -> unit
596 (** resize an ext2/ext3 filesystem *)
598 val find : t -> string -> string array
599 (** find all files and directories *)
601 val e2fsck_f : t -> string -> unit
602 (** check an ext2/ext3 filesystem *)