Prepare for 1.0.46.
[libguestfs.git] / ocaml / guestfs.mli
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.
4  *
5  * Copyright (C) 2009 Red Hat Inc.
6  *
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.
11  *
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.
16  *
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
20  *)
21
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. *)
25
26 type t
27 (** A [guestfs_h] handle. *)
28
29 exception Error of string
30 (** This exception is raised when there is an error. *)
31
32 val create : unit -> t
33
34 val close : t -> unit
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. *)
38
39 type lvm_pv = {
40   pv_name : string;
41   pv_uuid : string;
42   pv_fmt : string;
43   pv_size : int64;
44   dev_size : int64;
45   pv_free : int64;
46   pv_used : int64;
47   pv_attr : string;
48   pv_pe_count : int64;
49   pv_pe_alloc_count : int64;
50   pv_tags : string;
51   pe_start : int64;
52   pv_mda_count : int64;
53   pv_mda_free : int64;
54 }
55
56 type lvm_vg = {
57   vg_name : string;
58   vg_uuid : string;
59   vg_fmt : string;
60   vg_attr : string;
61   vg_size : int64;
62   vg_free : int64;
63   vg_sysid : string;
64   vg_extent_size : int64;
65   vg_extent_count : int64;
66   vg_free_count : int64;
67   max_lv : int64;
68   max_pv : int64;
69   pv_count : int64;
70   lv_count : int64;
71   snap_count : int64;
72   vg_seqno : int64;
73   vg_tags : string;
74   vg_mda_count : int64;
75   vg_mda_free : int64;
76 }
77
78 type lvm_lv = {
79   lv_name : string;
80   lv_uuid : string;
81   lv_attr : string;
82   lv_major : int64;
83   lv_minor : int64;
84   lv_kernel_major : int64;
85   lv_kernel_minor : int64;
86   lv_size : int64;
87   seg_count : int64;
88   origin : string;
89   snap_percent : float option;
90   copy_percent : float option;
91   move_pv : string;
92   lv_tags : string;
93   mirror_log : string;
94   modules : string;
95 }
96
97 type stat = {
98   dev : int64;
99   ino : int64;
100   mode : int64;
101   nlink : int64;
102   uid : int64;
103   gid : int64;
104   rdev : int64;
105   size : int64;
106   blksize : int64;
107   blocks : int64;
108   atime : int64;
109   mtime : int64;
110   ctime : int64;
111 }
112
113 type statvfs = {
114   bsize : int64;
115   frsize : int64;
116   blocks : int64;
117   bfree : int64;
118   bavail : int64;
119   files : int64;
120   ffree : int64;
121   favail : int64;
122   fsid : int64;
123   flag : int64;
124   namemax : int64;
125 }
126
127 val test0 : t -> string -> string option -> string array -> bool -> int -> string -> string -> unit
128 (** internal test function - do not use *)
129
130 val test0rint : t -> string -> int
131 (** internal test function - do not use *)
132
133 val test0rinterr : t -> int
134 (** internal test function - do not use *)
135
136 val test0rint64 : t -> string -> int64
137 (** internal test function - do not use *)
138
139 val test0rint64err : t -> int64
140 (** internal test function - do not use *)
141
142 val test0rbool : t -> string -> bool
143 (** internal test function - do not use *)
144
145 val test0rboolerr : t -> bool
146 (** internal test function - do not use *)
147
148 val test0rconststring : t -> string -> string
149 (** internal test function - do not use *)
150
151 val test0rconststringerr : t -> string
152 (** internal test function - do not use *)
153
154 val test0rstring : t -> string -> string
155 (** internal test function - do not use *)
156
157 val test0rstringerr : t -> string
158 (** internal test function - do not use *)
159
160 val test0rstringlist : t -> string -> string array
161 (** internal test function - do not use *)
162
163 val test0rstringlisterr : t -> string array
164 (** internal test function - do not use *)
165
166 val test0rintbool : t -> string -> int * bool
167 (** internal test function - do not use *)
168
169 val test0rintboolerr : t -> int * bool
170 (** internal test function - do not use *)
171
172 val test0rpvlist : t -> string -> lvm_pv array
173 (** internal test function - do not use *)
174
175 val test0rpvlisterr : t -> lvm_pv array
176 (** internal test function - do not use *)
177
178 val test0rvglist : t -> string -> lvm_vg array
179 (** internal test function - do not use *)
180
181 val test0rvglisterr : t -> lvm_vg array
182 (** internal test function - do not use *)
183
184 val test0rlvlist : t -> string -> lvm_lv array
185 (** internal test function - do not use *)
186
187 val test0rlvlisterr : t -> lvm_lv array
188 (** internal test function - do not use *)
189
190 val test0rstat : t -> string -> stat
191 (** internal test function - do not use *)
192
193 val test0rstaterr : t -> stat
194 (** internal test function - do not use *)
195
196 val test0rstatvfs : t -> string -> statvfs
197 (** internal test function - do not use *)
198
199 val test0rstatvfserr : t -> statvfs
200 (** internal test function - do not use *)
201
202 val test0rhashtable : t -> string -> (string * string) list
203 (** internal test function - do not use *)
204
205 val test0rhashtableerr : t -> (string * string) list
206 (** internal test function - do not use *)
207
208 val launch : t -> unit
209 (** launch the qemu subprocess *)
210
211 val wait_ready : t -> unit
212 (** wait until the qemu subprocess launches *)
213
214 val kill_subprocess : t -> unit
215 (** kill the qemu subprocess *)
216
217 val add_drive : t -> string -> unit
218 (** add an image to examine or modify *)
219
220 val add_cdrom : t -> string -> unit
221 (** add a CD-ROM disk image to examine *)
222
223 val add_drive_ro : t -> string -> unit
224 (** add a drive in snapshot mode (read-only) *)
225
226 val config : t -> string -> string option -> unit
227 (** add qemu parameters *)
228
229 val set_qemu : t -> string -> unit
230 (** set the qemu binary *)
231
232 val get_qemu : t -> string
233 (** get the qemu binary *)
234
235 val set_path : t -> string -> unit
236 (** set the search path *)
237
238 val get_path : t -> string
239 (** get the search path *)
240
241 val set_append : t -> string -> unit
242 (** add options to kernel command line *)
243
244 val get_append : t -> string
245 (** get the additional kernel options *)
246
247 val set_autosync : t -> bool -> unit
248 (** set autosync mode *)
249
250 val get_autosync : t -> bool
251 (** get autosync mode *)
252
253 val set_verbose : t -> bool -> unit
254 (** set verbose mode *)
255
256 val get_verbose : t -> bool
257 (** get verbose mode *)
258
259 val is_ready : t -> bool
260 (** is ready to accept commands *)
261
262 val is_config : t -> bool
263 (** is in configuration state *)
264
265 val is_launching : t -> bool
266 (** is launching subprocess *)
267
268 val is_busy : t -> bool
269 (** is busy processing a command *)
270
271 val get_state : t -> int
272 (** get the current state *)
273
274 val set_busy : t -> unit
275 (** set state to busy *)
276
277 val set_ready : t -> unit
278 (** set state to ready *)
279
280 val end_busy : t -> unit
281 (** leave the busy state *)
282
283 val mount : t -> string -> string -> unit
284 (** mount a guest disk at a position in the filesystem *)
285
286 val sync : t -> unit
287 (** sync disks, writes are flushed through to the disk image *)
288
289 val touch : t -> string -> unit
290 (** update file timestamps or create a new file *)
291
292 val cat : t -> string -> string
293 (** list the contents of a file *)
294
295 val ll : t -> string -> string
296 (** list the files in a directory (long format) *)
297
298 val ls : t -> string -> string array
299 (** list the files in a directory *)
300
301 val list_devices : t -> string array
302 (** list the block devices *)
303
304 val list_partitions : t -> string array
305 (** list the partitions *)
306
307 val pvs : t -> string array
308 (** list the LVM physical volumes (PVs) *)
309
310 val vgs : t -> string array
311 (** list the LVM volume groups (VGs) *)
312
313 val lvs : t -> string array
314 (** list the LVM logical volumes (LVs) *)
315
316 val pvs_full : t -> lvm_pv array
317 (** list the LVM physical volumes (PVs) *)
318
319 val vgs_full : t -> lvm_vg array
320 (** list the LVM volume groups (VGs) *)
321
322 val lvs_full : t -> lvm_lv array
323 (** list the LVM logical volumes (LVs) *)
324
325 val read_lines : t -> string -> string array
326 (** read file as lines *)
327
328 val aug_init : t -> string -> int -> unit
329 (** create a new Augeas handle *)
330
331 val aug_close : t -> unit
332 (** close the current Augeas handle *)
333
334 val aug_defvar : t -> string -> string option -> int
335 (** define an Augeas variable *)
336
337 val aug_defnode : t -> string -> string -> string -> int * bool
338 (** define an Augeas node *)
339
340 val aug_get : t -> string -> string
341 (** look up the value of an Augeas path *)
342
343 val aug_set : t -> string -> string -> unit
344 (** set Augeas path to value *)
345
346 val aug_insert : t -> string -> string -> bool -> unit
347 (** insert a sibling Augeas node *)
348
349 val aug_rm : t -> string -> int
350 (** remove an Augeas path *)
351
352 val aug_mv : t -> string -> string -> unit
353 (** move Augeas node *)
354
355 val aug_match : t -> string -> string array
356 (** return Augeas nodes which match path *)
357
358 val aug_save : t -> unit
359 (** write all pending Augeas changes to disk *)
360
361 val aug_load : t -> unit
362 (** load files into the tree *)
363
364 val aug_ls : t -> string -> string array
365 (** list Augeas nodes under a path *)
366
367 val rm : t -> string -> unit
368 (** remove a file *)
369
370 val rmdir : t -> string -> unit
371 (** remove a directory *)
372
373 val rm_rf : t -> string -> unit
374 (** remove a file or directory recursively *)
375
376 val mkdir : t -> string -> unit
377 (** create a directory *)
378
379 val mkdir_p : t -> string -> unit
380 (** create a directory and parents *)
381
382 val chmod : t -> int -> string -> unit
383 (** change file mode *)
384
385 val chown : t -> int -> int -> string -> unit
386 (** change file owner and group *)
387
388 val exists : t -> string -> bool
389 (** test if file or directory exists *)
390
391 val is_file : t -> string -> bool
392 (** test if file exists *)
393
394 val is_dir : t -> string -> bool
395 (** test if file exists *)
396
397 val pvcreate : t -> string -> unit
398 (** create an LVM physical volume *)
399
400 val vgcreate : t -> string -> string array -> unit
401 (** create an LVM volume group *)
402
403 val lvcreate : t -> string -> string -> int -> unit
404 (** create an LVM volume group *)
405
406 val mkfs : t -> string -> string -> unit
407 (** make a filesystem *)
408
409 val sfdisk : t -> string -> int -> int -> int -> string array -> unit
410 (** create partitions on a block device *)
411
412 val write_file : t -> string -> string -> int -> unit
413 (** create a file *)
414
415 val umount : t -> string -> unit
416 (** unmount a filesystem *)
417
418 val mounts : t -> string array
419 (** show mounted filesystems *)
420
421 val umount_all : t -> unit
422 (** unmount all filesystems *)
423
424 val lvm_remove_all : t -> unit
425 (** remove all LVM LVs, VGs and PVs *)
426
427 val file : t -> string -> string
428 (** determine file type *)
429
430 val command : t -> string array -> string
431 (** run a command from the guest filesystem *)
432
433 val command_lines : t -> string array -> string array
434 (** run a command, returning lines *)
435
436 val stat : t -> string -> stat
437 (** get file information *)
438
439 val lstat : t -> string -> stat
440 (** get file information for a symbolic link *)
441
442 val statvfs : t -> string -> statvfs
443 (** get file system statistics *)
444
445 val tune2fs_l : t -> string -> (string * string) list
446 (** get ext2/ext3/ext4 superblock details *)
447
448 val blockdev_setro : t -> string -> unit
449 (** set block device to read-only *)
450
451 val blockdev_setrw : t -> string -> unit
452 (** set block device to read-write *)
453
454 val blockdev_getro : t -> string -> bool
455 (** is block device set to read-only *)
456
457 val blockdev_getss : t -> string -> int
458 (** get sectorsize of block device *)
459
460 val blockdev_getbsz : t -> string -> int
461 (** get blocksize of block device *)
462
463 val blockdev_setbsz : t -> string -> int -> unit
464 (** set blocksize of block device *)
465
466 val blockdev_getsz : t -> string -> int64
467 (** get total size of device in 512-byte sectors *)
468
469 val blockdev_getsize64 : t -> string -> int64
470 (** get total size of device in bytes *)
471
472 val blockdev_flushbufs : t -> string -> unit
473 (** flush device buffers *)
474
475 val blockdev_rereadpt : t -> string -> unit
476 (** reread partition table *)
477
478 val upload : t -> string -> string -> unit
479 (** upload a file from the local machine *)
480
481 val download : t -> string -> string -> unit
482 (** download a file to the local machine *)
483
484 val checksum : t -> string -> string -> string
485 (** compute MD5, SHAx or CRC checksum of file *)
486
487 val tar_in : t -> string -> string -> unit
488 (** unpack tarfile to directory *)
489
490 val tar_out : t -> string -> string -> unit
491 (** pack directory into tarfile *)
492
493 val tgz_in : t -> string -> string -> unit
494 (** unpack compressed tarball to directory *)
495
496 val tgz_out : t -> string -> string -> unit
497 (** pack directory into compressed tarball *)
498
499 val mount_ro : t -> string -> string -> unit
500 (** mount a guest disk, read-only *)
501
502 val mount_options : t -> string -> string -> string -> unit
503 (** mount a guest disk with mount options *)
504
505 val mount_vfs : t -> string -> string -> string -> string -> unit
506 (** mount a guest disk with mount options and vfstype *)
507
508 val debug : t -> string -> string array -> string
509 (** debugging and internals *)
510
511 val lvremove : t -> string -> unit
512 (** remove an LVM logical volume *)
513
514 val vgremove : t -> string -> unit
515 (** remove an LVM volume group *)
516
517 val pvremove : t -> string -> unit
518 (** remove an LVM physical volume *)
519
520 val set_e2label : t -> string -> string -> unit
521 (** set the ext2/3/4 filesystem label *)
522
523 val get_e2label : t -> string -> string
524 (** get the ext2/3/4 filesystem label *)
525
526 val set_e2uuid : t -> string -> string -> unit
527 (** set the ext2/3/4 filesystem UUID *)
528
529 val get_e2uuid : t -> string -> string
530 (** get the ext2/3/4 filesystem UUID *)
531
532 val fsck : t -> string -> string -> int
533 (** run the filesystem checker *)
534
535 val zero : t -> string -> unit
536 (** write zeroes to the device *)
537
538 val grub_install : t -> string -> string -> unit
539 (** install GRUB *)
540
541 val cp : t -> string -> string -> unit
542 (** copy a file *)
543
544 val cp_a : t -> string -> string -> unit
545 (** copy a file or directory recursively *)
546
547 val mv : t -> string -> string -> unit
548 (** move a file *)
549
550 val drop_caches : t -> int -> unit
551 (** drop kernel page cache, dentries and inodes *)
552
553 val dmesg : t -> string
554 (** return kernel messages *)
555
556 val ping_daemon : t -> unit
557 (** ping the guest daemon *)
558
559 val equal : t -> string -> string -> bool
560 (** test if two files have equal contents *)
561
562 val strings : t -> string -> string array
563 (** print the printable strings in a file *)
564
565 val strings_e : t -> string -> string -> string array
566 (** print the printable strings in a file *)
567
568 val hexdump : t -> string -> string
569 (** dump a file in hexadecimal *)
570
571 val zerofree : t -> string -> unit
572 (** zero unused inodes and disk blocks on ext2/3 filesystem *)
573
574 val pvresize : t -> string -> unit
575 (** resize an LVM physical volume *)
576
577 val sfdisk_N : t -> string -> int -> int -> int -> int -> string -> unit
578 (** modify a single partition on a block device *)
579
580 val sfdisk_l : t -> string -> string
581 (** display the partition table *)
582
583 val sfdisk_kernel_geometry : t -> string -> string
584 (** display the kernel geometry *)
585
586 val sfdisk_disk_geometry : t -> string -> string
587 (** display the disk geometry from the partition table *)
588
589 val vg_activate_all : t -> bool -> unit
590 (** activate or deactivate all volume groups *)
591
592 val vg_activate : t -> bool -> string array -> unit
593 (** activate or deactivate some volume groups *)
594
595 val lvresize : t -> string -> int -> unit
596 (** resize an LVM logical volume *)
597
598 val resize2fs : t -> string -> unit
599 (** resize an ext2/ext3 filesystem *)
600
601 val find : t -> string -> string array
602 (** find all files and directories *)
603
604 val e2fsck_f : t -> string -> unit
605 (** check an ext2/ext3 filesystem *)
606
607 val sleep : t -> int -> unit
608 (** sleep for some seconds *)
609
610 val ntfs_3g_probe : t -> bool -> string -> int
611 (** probe NTFS volume *)
612