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 type dirent = {
 128   ino : int64;
 129   ftyp : char;
 130   name : string;
 131 }
 132
 133 val test0 : t -> string -> string option -> string array -> bool -> int -> string -> string -> unit
 134 (** internal test function - do not use *)
 135
 136 val test0rint : t -> string -> int
 137 (** internal test function - do not use *)
 138
 139 val test0rinterr : t -> int
 140 (** internal test function - do not use *)
 141
 142 val test0rint64 : t -> string -> int64
 143 (** internal test function - do not use *)
 144
 145 val test0rint64err : t -> int64
 146 (** internal test function - do not use *)
 147
 148 val test0rbool : t -> string -> bool
 149 (** internal test function - do not use *)
 150
 151 val test0rboolerr : t -> bool
 152 (** internal test function - do not use *)
 153
 154 val test0rconststring : t -> string -> string
 155 (** internal test function - do not use *)
 156
 157 val test0rconststringerr : t -> string
 158 (** internal test function - do not use *)
 159
 160 val test0rstring : t -> string -> string
 161 (** internal test function - do not use *)
 162
 163 val test0rstringerr : t -> string
 164 (** internal test function - do not use *)
 165
 166 val test0rstringlist : t -> string -> string array
 167 (** internal test function - do not use *)
 168
 169 val test0rstringlisterr : t -> string array
 170 (** internal test function - do not use *)
 171
 172 val test0rintbool : t -> string -> int * bool
 173 (** internal test function - do not use *)
 174
 175 val test0rintboolerr : t -> int * bool
 176 (** internal test function - do not use *)
 177
 178 val test0rpvlist : t -> string -> lvm_pv array
 179 (** internal test function - do not use *)
 180
 181 val test0rpvlisterr : t -> lvm_pv array
 182 (** internal test function - do not use *)
 183
 184 val test0rvglist : t -> string -> lvm_vg array
 185 (** internal test function - do not use *)
 186
 187 val test0rvglisterr : t -> lvm_vg array
 188 (** internal test function - do not use *)
 189
 190 val test0rlvlist : t -> string -> lvm_lv array
 191 (** internal test function - do not use *)
 192
 193 val test0rlvlisterr : t -> lvm_lv array
 194 (** internal test function - do not use *)
 195
 196 val test0rstat : t -> string -> stat
 197 (** internal test function - do not use *)
 198
 199 val test0rstaterr : t -> stat
 200 (** internal test function - do not use *)
 201
 202 val test0rstatvfs : t -> string -> statvfs
 203 (** internal test function - do not use *)
 204
 205 val test0rstatvfserr : t -> statvfs
 206 (** internal test function - do not use *)
 207
 208 val test0rhashtable : t -> string -> (string * string) list
 209 (** internal test function - do not use *)
 210
 211 val test0rhashtableerr : t -> (string * string) list
 212 (** internal test function - do not use *)
 213
 214 val launch : t -> unit
 215 (** launch the qemu subprocess *)
 216
 217 val wait_ready : t -> unit
 218 (** wait until the qemu subprocess launches *)
 219
 220 val kill_subprocess : t -> unit
 221 (** kill the qemu subprocess *)
 222
 223 val add_drive : t -> string -> unit
 224 (** add an image to examine or modify *)
 225
 226 val add_cdrom : t -> string -> unit
 227 (** add a CD-ROM disk image to examine *)
 228
 229 val add_drive_ro : t -> string -> unit
 230 (** add a drive in snapshot mode (read-only) *)
 231
 232 val config : t -> string -> string option -> unit
 233 (** add qemu parameters *)
 234
 235 val set_qemu : t -> string -> unit
 236 (** set the qemu binary *)
 237
 238 val get_qemu : t -> string
 239 (** get the qemu binary *)
 240
 241 val set_path : t -> string -> unit
 242 (** set the search path *)
 243
 244 val get_path : t -> string
 245 (** get the search path *)
 246
 247 val set_append : t -> string -> unit
 248 (** add options to kernel command line *)
 249
 250 val get_append : t -> string
 251 (** get the additional kernel options *)
 252
 253 val set_autosync : t -> bool -> unit
 254 (** set autosync mode *)
 255
 256 val get_autosync : t -> bool
 257 (** get autosync mode *)
 258
 259 val set_verbose : t -> bool -> unit
 260 (** set verbose mode *)
 261
 262 val get_verbose : t -> bool
 263 (** get verbose mode *)
 264
 265 val is_ready : t -> bool
 266 (** is ready to accept commands *)
 267
 268 val is_config : t -> bool
 269 (** is in configuration state *)
 270
 271 val is_launching : t -> bool
 272 (** is launching subprocess *)
 273
 274 val is_busy : t -> bool
 275 (** is busy processing a command *)
 276
 277 val get_state : t -> int
 278 (** get the current state *)
 279
 280 val set_busy : t -> unit
 281 (** set state to busy *)
 282
 283 val set_ready : t -> unit
 284 (** set state to ready *)
 285
 286 val end_busy : t -> unit
 287 (** leave the busy state *)
 288
 289 val set_memsize : t -> int -> unit
 290 (** set memory allocated to the qemu subprocess *)
 291
 292 val get_memsize : t -> int
 293 (** get memory allocated to the qemu subprocess *)
 294
 295 val mount : t -> string -> string -> unit
 296 (** mount a guest disk at a position in the filesystem *)
 297
 298 val sync : t -> unit
 299 (** sync disks, writes are flushed through to the disk image *)
 300
 301 val touch : t -> string -> unit
 302 (** update file timestamps or create a new file *)
 303
 304 val cat : t -> string -> string
 305 (** list the contents of a file *)
 306
 307 val ll : t -> string -> string
 308 (** list the files in a directory (long format) *)
 309
 310 val ls : t -> string -> string array
 311 (** list the files in a directory *)
 312
 313 val list_devices : t -> string array
 314 (** list the block devices *)
 315
 316 val list_partitions : t -> string array
 317 (** list the partitions *)
 318
 319 val pvs : t -> string array
 320 (** list the LVM physical volumes (PVs) *)
 321
 322 val vgs : t -> string array
 323 (** list the LVM volume groups (VGs) *)
 324
 325 val lvs : t -> string array
 326 (** list the LVM logical volumes (LVs) *)
 327
 328 val pvs_full : t -> lvm_pv array
 329 (** list the LVM physical volumes (PVs) *)
 330
 331 val vgs_full : t -> lvm_vg array
 332 (** list the LVM volume groups (VGs) *)
 333
 334 val lvs_full : t -> lvm_lv array
 335 (** list the LVM logical volumes (LVs) *)
 336
 337 val read_lines : t -> string -> string array
 338 (** read file as lines *)
 339
 340 val aug_init : t -> string -> int -> unit
 341 (** create a new Augeas handle *)
 342
 343 val aug_close : t -> unit
 344 (** close the current Augeas handle *)
 345
 346 val aug_defvar : t -> string -> string option -> int
 347 (** define an Augeas variable *)
 348
 349 val aug_defnode : t -> string -> string -> string -> int * bool
 350 (** define an Augeas node *)
 351
 352 val aug_get : t -> string -> string
 353 (** look up the value of an Augeas path *)
 354
 355 val aug_set : t -> string -> string -> unit
 356 (** set Augeas path to value *)
 357
 358 val aug_insert : t -> string -> string -> bool -> unit
 359 (** insert a sibling Augeas node *)
 360
 361 val aug_rm : t -> string -> int
 362 (** remove an Augeas path *)
 363
 364 val aug_mv : t -> string -> string -> unit
 365 (** move Augeas node *)
 366
 367 val aug_match : t -> string -> string array
 368 (** return Augeas nodes which match path *)
 369
 370 val aug_save : t -> unit
 371 (** write all pending Augeas changes to disk *)
 372
 373 val aug_load : t -> unit
 374 (** load files into the tree *)
 375
 376 val aug_ls : t -> string -> string array
 377 (** list Augeas nodes under a path *)
 378
 379 val rm : t -> string -> unit
 380 (** remove a file *)
 381
 382 val rmdir : t -> string -> unit
 383 (** remove a directory *)
 384
 385 val rm_rf : t -> string -> unit
 386 (** remove a file or directory recursively *)
 387
 388 val mkdir : t -> string -> unit
 389 (** create a directory *)
 390
 391 val mkdir_p : t -> string -> unit
 392 (** create a directory and parents *)
 393
 394 val chmod : t -> int -> string -> unit
 395 (** change file mode *)
 396
 397 val chown : t -> int -> int -> string -> unit
 398 (** change file owner and group *)
 399
 400 val exists : t -> string -> bool
 401 (** test if file or directory exists *)
 402
 403 val is_file : t -> string -> bool
 404 (** test if file exists *)
 405
 406 val is_dir : t -> string -> bool
 407 (** test if file exists *)
 408
 409 val pvcreate : t -> string -> unit
 410 (** create an LVM physical volume *)
 411
 412 val vgcreate : t -> string -> string array -> unit
 413 (** create an LVM volume group *)
 414
 415 val lvcreate : t -> string -> string -> int -> unit
 416 (** create an LVM volume group *)
 417
 418 val mkfs : t -> string -> string -> unit
 419 (** make a filesystem *)
 420
 421 val sfdisk : t -> string -> int -> int -> int -> string array -> unit
 422 (** create partitions on a block device *)
 423
 424 val write_file : t -> string -> string -> int -> unit
 425 (** create a file *)
 426
 427 val umount : t -> string -> unit
 428 (** unmount a filesystem *)
 429
 430 val mounts : t -> string array
 431 (** show mounted filesystems *)
 432
 433 val umount_all : t -> unit
 434 (** unmount all filesystems *)
 435
 436 val lvm_remove_all : t -> unit
 437 (** remove all LVM LVs, VGs and PVs *)
 438
 439 val file : t -> string -> string
 440 (** determine file type *)
 441
 442 val command : t -> string array -> string
 443 (** run a command from the guest filesystem *)
 444
 445 val command_lines : t -> string array -> string array
 446 (** run a command, returning lines *)
 447
 448 val stat : t -> string -> stat
 449 (** get file information *)
 450
 451 val lstat : t -> string -> stat
 452 (** get file information for a symbolic link *)
 453
 454 val statvfs : t -> string -> statvfs
 455 (** get file system statistics *)
 456
 457 val tune2fs_l : t -> string -> (string * string) list
 458 (** get ext2/ext3/ext4 superblock details *)
 459
 460 val blockdev_setro : t -> string -> unit
 461 (** set block device to read-only *)
 462
 463 val blockdev_setrw : t -> string -> unit
 464 (** set block device to read-write *)
 465
 466 val blockdev_getro : t -> string -> bool
 467 (** is block device set to read-only *)
 468
 469 val blockdev_getss : t -> string -> int
 470 (** get sectorsize of block device *)
 471
 472 val blockdev_getbsz : t -> string -> int
 473 (** get blocksize of block device *)
 474
 475 val blockdev_setbsz : t -> string -> int -> unit
 476 (** set blocksize of block device *)
 477
 478 val blockdev_getsz : t -> string -> int64
 479 (** get total size of device in 512-byte sectors *)
 480
 481 val blockdev_getsize64 : t -> string -> int64
 482 (** get total size of device in bytes *)
 483
 484 val blockdev_flushbufs : t -> string -> unit
 485 (** flush device buffers *)
 486
 487 val blockdev_rereadpt : t -> string -> unit
 488 (** reread partition table *)
 489
 490 val upload : t -> string -> string -> unit
 491 (** upload a file from the local machine *)
 492
 493 val download : t -> string -> string -> unit
 494 (** download a file to the local machine *)
 495
 496 val checksum : t -> string -> string -> string
 497 (** compute MD5, SHAx or CRC checksum of file *)
 498
 499 val tar_in : t -> string -> string -> unit
 500 (** unpack tarfile to directory *)
 501
 502 val tar_out : t -> string -> string -> unit
 503 (** pack directory into tarfile *)
 504
 505 val tgz_in : t -> string -> string -> unit
 506 (** unpack compressed tarball to directory *)
 507
 508 val tgz_out : t -> string -> string -> unit
 509 (** pack directory into compressed tarball *)
 510
 511 val mount_ro : t -> string -> string -> unit
 512 (** mount a guest disk, read-only *)
 513
 514 val mount_options : t -> string -> string -> string -> unit
 515 (** mount a guest disk with mount options *)
 516
 517 val mount_vfs : t -> string -> string -> string -> string -> unit
 518 (** mount a guest disk with mount options and vfstype *)
 519
 520 val debug : t -> string -> string array -> string
 521 (** debugging and internals *)
 522
 523 val lvremove : t -> string -> unit
 524 (** remove an LVM logical volume *)
 525
 526 val vgremove : t -> string -> unit
 527 (** remove an LVM volume group *)
 528
 529 val pvremove : t -> string -> unit
 530 (** remove an LVM physical volume *)
 531
 532 val set_e2label : t -> string -> string -> unit
 533 (** set the ext2/3/4 filesystem label *)
 534
 535 val get_e2label : t -> string -> string
 536 (** get the ext2/3/4 filesystem label *)
 537
 538 val set_e2uuid : t -> string -> string -> unit
 539 (** set the ext2/3/4 filesystem UUID *)
 540
 541 val get_e2uuid : t -> string -> string
 542 (** get the ext2/3/4 filesystem UUID *)
 543
 544 val fsck : t -> string -> string -> int
 545 (** run the filesystem checker *)
 546
 547 val zero : t -> string -> unit
 548 (** write zeroes to the device *)
 549
 550 val grub_install : t -> string -> string -> unit
 551 (** install GRUB *)
 552
 553 val cp : t -> string -> string -> unit
 554 (** copy a file *)
 555
 556 val cp_a : t -> string -> string -> unit
 557 (** copy a file or directory recursively *)
 558
 559 val mv : t -> string -> string -> unit
 560 (** move a file *)
 561
 562 val drop_caches : t -> int -> unit
 563 (** drop kernel page cache, dentries and inodes *)
 564
 565 val dmesg : t -> string
 566 (** return kernel messages *)
 567
 568 val ping_daemon : t -> unit
 569 (** ping the guest daemon *)
 570
 571 val equal : t -> string -> string -> bool
 572 (** test if two files have equal contents *)
 573
 574 val strings : t -> string -> string array
 575 (** print the printable strings in a file *)
 576
 577 val strings_e : t -> string -> string -> string array
 578 (** print the printable strings in a file *)
 579
 580 val hexdump : t -> string -> string
 581 (** dump a file in hexadecimal *)
 582
 583 val zerofree : t -> string -> unit
 584 (** zero unused inodes and disk blocks on ext2/3 filesystem *)
 585
 586 val pvresize : t -> string -> unit
 587 (** resize an LVM physical volume *)
 588
 589 val sfdisk_N : t -> string -> int -> int -> int -> int -> string -> unit
 590 (** modify a single partition on a block device *)
 591
 592 val sfdisk_l : t -> string -> string
 593 (** display the partition table *)
 594
 595 val sfdisk_kernel_geometry : t -> string -> string
 596 (** display the kernel geometry *)
 597
 598 val sfdisk_disk_geometry : t -> string -> string
 599 (** display the disk geometry from the partition table *)
 600
 601 val vg_activate_all : t -> bool -> unit
 602 (** activate or deactivate all volume groups *)
 603
 604 val vg_activate : t -> bool -> string array -> unit
 605 (** activate or deactivate some volume groups *)
 606
 607 val lvresize : t -> string -> int -> unit
 608 (** resize an LVM logical volume *)
 609
 610 val resize2fs : t -> string -> unit
 611 (** resize an ext2/ext3 filesystem *)
 612
 613 val find : t -> string -> string array
 614 (** find all files and directories *)
 615
 616 val e2fsck_f : t -> string -> unit
 617 (** check an ext2/ext3 filesystem *)
 618
 619 val sleep : t -> int -> unit
 620 (** sleep for some seconds *)
 621
 622 val ntfs_3g_probe : t -> bool -> string -> int
 623 (** probe NTFS volume *)
 624
 625 val sh : t -> string -> string
 626 (** run a command via the shell *)
 627
 628 val sh_lines : t -> string -> string array
 629 (** run a command via the shell returning lines *)
 630
 631 val glob_expand : t -> string -> string array
 632 (** expand a wildcard path *)
 633
 634 val scrub_device : t -> string -> unit
 635 (** scrub (securely wipe) a device *)
 636
 637 val scrub_file : t -> string -> unit
 638 (** scrub (securely wipe) a file *)
 639
 640 val scrub_freespace : t -> string -> unit
 641 (** scrub (securely wipe) free space *)
 642
 643 val mkdtemp : t -> string -> string
 644 (** create a temporary directory *)
 645
 646 val wc_l : t -> string -> int
 647 (** count lines in a file *)
 648
 649 val wc_w : t -> string -> int
 650 (** count words in a file *)
 651
 652 val wc_c : t -> string -> int
 653 (** count characters in a file *)
 654
 655 val head : t -> string -> string array
 656 (** return first 10 lines of a file *)
 657
 658 val head_n : t -> int -> string -> string array
 659 (** return first N lines of a file *)
 660
 661 val tail : t -> string -> string array
 662 (** return last 10 lines of a file *)
 663
 664 val tail_n : t -> int -> string -> string array
 665 (** return last N lines of a file *)
 666
 667 val df : t -> string
 668 (** report file system disk space usage *)
 669
 670 val df_h : t -> string
 671 (** report file system disk space usage (human readable) *)
 672
 673 val du : t -> string -> int64
 674 (** estimate file space usage *)
 675
 676 val initrd_list : t -> string -> string array
 677 (** list files in an initrd *)
 678
 679 val mount_loop : t -> string -> string -> unit
 680 (** mount a file using the loop device *)
 681
 682 val mkswap : t -> string -> unit
 683 (** create a swap partition *)
 684
 685 val mkswap_L : t -> string -> string -> unit
 686 (** create a swap partition with a label *)
 687
 688 val mkswap_U : t -> string -> string -> unit
 689 (** create a swap partition with an explicit UUID *)
 690
 691 val mknod : t -> int -> int -> int -> string -> unit
 692 (** make block, character or FIFO devices *)
 693
 694 val mkfifo : t -> int -> string -> unit
 695 (** make FIFO (named pipe) *)
 696
 697 val mknod_b : t -> int -> int -> int -> string -> unit
 698 (** make block device node *)
 699
 700 val mknod_c : t -> int -> int -> int -> string -> unit
 701 (** make char device node *)
 702
 703 val umask : t -> int -> int
 704 (** set file mode creation mask (umask) *)
 705
 706 val readdir : t -> string -> dirent array
 707 (** read directories entries *)
 708