1 (** OCaml bindings for libvirt. *)
2 (* (C) Copyright 2007 Richard W.M. Jones, Red Hat Inc.
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2 of the License, or (at your option) any later version.
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with this library; if not, write to the Free Software
17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 {2 Introduction and examples}
23 This is a set of bindings for writing OCaml programs to
24 manage virtual machines through {{:http://libvirt.org/}libvirt}.
26 {3 Using libvirt interactively}
28 Using the interactive toplevel:
32 Objective Caml version 3.10.0
35 # #load "mllibvirt.cma";;
36 # let name = "test:///default";;
37 val name : string = "test:///default"
38 # let conn = Libvirt.Connect.connect_readonly ~name () ;;
39 val conn : Libvirt.ro Libvirt.Connect.t = <abstr>
40 # Libvirt.Connect.get_node_info conn;;
41 : Libvirt.Connect.node_info =
42 {Libvirt.Connect.model = "i686"; Libvirt.Connect.memory = 3145728L;
43 Libvirt.Connect.cpus = 16; Libvirt.Connect.mhz = 1400;
44 Libvirt.Connect.nodes = 2; Libvirt.Connect.sockets = 2;
45 Libvirt.Connect.cores = 2; Libvirt.Connect.threads = 2}
48 {3 Compiling libvirt programs}
50 This command compiles a program to native code:
53 ocamlopt -I +libvirt mllibvirt.cmxa list_domains.ml -o list_domains
56 {3 Example: Connect to the hypervisor}
58 The main modules are {!Libvirt.Connect}, {!Libvirt.Domain} and
59 {!Libvirt.Network} corresponding respectively to the
60 {{:http://libvirt.org/html/libvirt-libvirt.html}virConnect*, virDomain* and virNetwork* functions from libvirt}.
61 For brevity I usually rename these modules like this:
64 module C = Libvirt.Connect
65 module D = Libvirt.Domain
66 module N = Libvirt.Network
69 To get a connection handle, assuming a Xen hypervisor:
73 let conn = C.connect_readonly ~name ()
76 {3 Example: List running domains}
81 let n = C.num_of_domains conn in
82 let ids = C.list_domains conn n in
83 let domains = Array.map (D.lookup_by_id conn) ids in
86 printf "%8d %s\n%!" (D.get_id dom) (D.get_name dom)
90 {3 Example: List inactive domains}
93 let n = C.num_of_defined_domains conn in
94 let names = C.list_defined_domains conn n in
97 printf "inactive %s\n%!" name
101 {3 Example: Print node info}
104 let node_info = C.get_node_info conn in
105 printf "model = %s\n" node_info.C.model;
106 printf "memory = %Ld K\n" node_info.C.memory;
107 printf "cpus = %d\n" node_info.C.cpus;
108 printf "mhz = %d\n" node_info.C.mhz;
109 printf "nodes = %d\n" node_info.C.nodes;
110 printf "sockets = %d\n" node_info.C.sockets;
111 printf "cores = %d\n" node_info.C.cores;
112 printf "threads = %d\n%!" node_info.C.threads;
114 let hostname = C.get_hostname conn in
115 printf "hostname = %s\n%!" hostname;
117 let uri = C.get_uri conn in
118 printf "uri = %s\n%!" uri
124 (** {2 Programming issues}
126 {3 General safety issues}
128 Memory allocation / automatic garbage collection of all libvirt
129 objects should be completely safe (except in the specific
130 virterror case noted below). If you find any safety issues or if your
131 pure OCaml program ever segfaults, please contact the author.
133 You can force a libvirt object to be freed early by calling
134 the [close] function on the object. This shouldn't affect
135 the safety of garbage collection and should only be used when
136 you want to explicitly free memory. Note that explicitly
137 closing a connection object does nothing if there are still
138 unclosed domain or network objects referencing it.
140 Note that even though you hold open (eg) a domain object, that
141 doesn't mean that the domain (virtual machine) actually exists.
142 The domain could have been shut down or deleted by another user.
143 Thus domain objects can through odd exceptions at any time.
144 This is just the nature of virtualisation.
146 Virterror has a specific design error which means that the
147 objects embedded in a virterror exception message are only
148 valid as long as the connection handle is still open. This
149 is a design flaw in the C code of libvirt and we cannot fix
150 or work around it in the OCaml bindings.
152 {3 Backwards and forwards compatibility}
154 OCaml-libvirt is backwards and forwards compatible with
155 any libvirt >= 0.2.1. One consequence of this is that
156 your program can dynamically link to a {i newer} version of
157 libvirt than it was compiled with, and it should still
160 When we link to an older version of libvirt.so, there may
161 be missing functions. If ocaml-libvirt was compiled with
162 gcc, then these are turned into OCaml {!Libvirt.Not_supported}
165 We don't support libvirt < 0.2.1, and never will so don't ask us.
169 You can issue multiple concurrent libvirt requests in
170 different threads. However you must follow this rule:
171 Each thread must have its own separate libvirt connection, {i or}
172 you must implement your own mutex scheme to ensure that no
173 two threads can ever make concurrent calls using the same
176 (Note that multithreaded code is not well tested. If you find
177 bugs please report them.)
181 Libvirt requires all callers to call virInitialize before
182 using the library. This is done automatically for you by
183 these bindings when the program starts up, and we believe
184 that the way this is done is safe.
190 (** This is a "raw" UUID, ie. a packed string of bytes. *)
193 (** Type of XML (an uninterpreted string of bytes). Use PXP, expat,
194 xml-light, etc. if you want to do anything useful with the XML.
197 type filename = string
200 val get_version : ?driver:string -> unit -> int * int
201 (** [get_version ()] returns the library version in the first part
202 of the tuple, and [0] in the second part.
204 [get_version ~driver ()] returns the library version in the first
205 part of the tuple, and the version of the driver called [driver]
208 The version numbers are encoded as
209 1,000,000 * major + 1,000 * minor + release.
212 val uuid_length : int
213 (** Length of packed UUIDs. *)
215 val uuid_string_length : int
216 (** Length of UUID strings. *)
221 {{:http://caml.inria.fr/pub/ml-archives/caml-list/2004/07/80683af867cce6bf8fff273973f70c95.en.html}phantom types}
222 are used to ensure the type-safety of read-only
223 versus read-write connections.
225 All connection/domain/etc. objects are marked with
226 a phantom read-write or read-only type, and trying to
227 pass a read-only object into a function which could
228 mutate the object will cause a compile time error.
230 Each module provides a function like {!Libvirt.Connect.const}
231 to demote a read-write object into a read-only object. The
232 opposite operation is, of course, not allowed.
234 If you want to handle both read-write and read-only
235 connections at runtime, use a variant similar to this:
239 | Read_only of Libvirt.ro Libvirt.Connect.t
240 | Read_write of Libvirt.rw Libvirt.Connect.t
242 See also the source of [mlvirsh].
246 (** Forward definition of {!Job.t} to avoid recursive module dependencies. *)
248 (** {3 Connections} *)
253 (** Connection. Read-only connections have type [ro Connect.t] and
254 read-write connections have type [rw Connect.t].
258 model : string; (** CPU model *)
259 memory : int64; (** memory size in kilobytes *)
260 cpus : int; (** number of active CPUs *)
261 mhz : int; (** expected CPU frequency *)
262 nodes : int; (** number of NUMA nodes (1 = UMA) *)
263 sockets : int; (** number of CPU sockets per node *)
264 cores : int; (** number of cores per socket *)
265 threads : int; (** number of threads per core *)
268 val connect : ?name:string -> unit -> rw t
269 val connect_readonly : ?name:string -> unit -> ro t
270 (** [connect ~name ()] connects to the hypervisor with URI [name].
272 [connect ()] connects to the default hypervisor.
274 [connect_readonly] is the same but connects in read-only mode.
277 val close : [>`R] t -> unit
278 (** [close conn] closes and frees the connection object in memory.
280 The connection is automatically closed if it is garbage
281 collected. This function just forces it to be closed
282 and freed right away.
285 val get_type : [>`R] t -> string
286 (** Returns the name of the driver (hypervisor). *)
288 val get_version : [>`R] t -> int
289 (** Returns the driver version
290 [major * 1_000_000 + minor * 1000 + release]
292 val get_hostname : [>`R] t -> string
293 (** Returns the hostname of the physical server. *)
294 val get_uri : [>`R] t -> string
295 (** Returns the canonical connection URI. *)
296 val get_max_vcpus : [>`R] t -> ?type_:string -> unit -> int
297 (** Returns the maximum number of virtual CPUs
298 supported by a guest VM of a particular type. *)
299 val list_domains : [>`R] t -> int -> int array
300 (** [list_domains conn max] returns the running domain IDs,
301 up to a maximum of [max] entries.
302 Call {!num_of_domains} first to get a value for [max].
304 val num_of_domains : [>`R] t -> int
305 (** Returns the number of running domains. *)
306 val get_capabilities : [>`R] t -> xml
307 (** Returns the hypervisor capabilities (as XML). *)
308 val num_of_defined_domains : [>`R] t -> int
309 (** Returns the number of inactive (shutdown) domains. *)
310 val list_defined_domains : [>`R] t -> int -> string array
311 (** [list_defined_domains conn max]
312 returns the names of the inactive domains, up to
313 a maximum of [max] entries.
314 Call {!num_of_defined_domains} first to get a value for [max].
316 val num_of_networks : [>`R] t -> int
317 (** Returns the number of networks. *)
318 val list_networks : [>`R] t -> int -> string array
319 (** [list_networks conn max]
320 returns the names of the networks, up to a maximum
322 Call {!num_of_networks} first to get a value for [max].
324 val num_of_defined_networks : [>`R] t -> int
325 (** Returns the number of inactive networks. *)
326 val list_defined_networks : [>`R] t -> int -> string array
327 (** [list_defined_networks conn max]
328 returns the names of the inactive networks, up to a maximum
330 Call {!num_of_defined_networks} first to get a value for [max].
333 val num_of_pools : [>`R] t -> int
334 (** Returns the number of storage pools. *)
335 val list_pools : [>`R] t -> int -> string array
336 (** Return list of storage pools. *)
337 val num_of_defined_pools : [>`R] t -> int
338 (** Returns the number of storage pools. *)
339 val list_defined_pools : [>`R] t -> int -> string array
340 (** Return list of storage pools. *)
342 (* The name of this function is inconsistent, but the inconsistency
343 * is really in libvirt itself.
345 val get_node_info : [>`R] t -> node_info
346 (** Return information about the physical server. *)
348 val node_get_free_memory : [> `R] t -> int64
350 [node_get_free_memory conn]
351 returns the amount of free memory (not allocated to any guest)
355 val node_get_cells_free_memory : [> `R] t -> int -> int -> int64 array
357 [node_get_cells_free_memory conn start max]
358 returns the amount of free memory on each NUMA cell in kilobytes.
359 [start] is the first cell for which we return free memory.
360 [max] is the maximum number of cells for which we return free memory.
361 Returns an array of up to [max] entries in length.
364 val maxcpus_of_node_info : node_info -> int
365 (** Calculate the total number of CPUs supported (but not necessarily
369 val cpumaplen : int -> int
370 (** Calculate the length (in bytes) required to store the complete
371 CPU map between a single virtual and all physical CPUs of a domain.
374 val use_cpu : string -> int -> unit
375 (** [use_cpu cpumap cpu] marks [cpu] as usable in [cpumap]. *)
376 val unuse_cpu : string -> int -> unit
377 (** [unuse_cpu cpumap cpu] marks [cpu] as not usable in [cpumap]. *)
378 val cpu_usable : string -> int -> int -> int -> bool
379 (** [cpu_usable cpumaps maplen vcpu cpu] checks returns true iff the
380 [cpu] is usable by [vcpu]. *)
382 external const : [>`R] t -> ro t = "%identity"
383 (** [const conn] turns a read/write connection into a read-only
384 connection. Note that the opposite operation is impossible.
387 (** Module dealing with connections. [Connect.t] is the
396 (** Domain handle. Read-only handles have type [ro Domain.t] and
397 read-write handles have type [rw Domain.t].
401 | InfoNoState | InfoRunning | InfoBlocked | InfoPaused
402 | InfoShutdown | InfoShutoff | InfoCrashed
405 state : state; (** running state *)
406 max_mem : int64; (** maximum memory in kilobytes *)
407 memory : int64; (** memory used in kilobytes *)
408 nr_virt_cpu : int; (** number of virtual CPUs *)
409 cpu_time : int64; (** CPU time used in nanoseconds *)
412 type vcpu_state = VcpuOffline | VcpuRunning | VcpuBlocked
415 number : int; (** virtual CPU number *)
416 vcpu_state : vcpu_state; (** state *)
417 vcpu_time : int64; (** CPU time used in nanoseconds *)
418 cpu : int; (** real CPU number, -1 if offline *)
421 type sched_param = string * sched_param_value
422 and sched_param_value =
423 | SchedFieldInt32 of int32 | SchedFieldUInt32 of int32
424 | SchedFieldInt64 of int64 | SchedFieldUInt64 of int64
425 | SchedFieldFloat of float | SchedFieldBool of bool
427 type migrate_flag = Live
437 type interface_stats = {
448 val create_linux : [>`W] Connect.t -> xml -> rw t
449 (** Create a new guest domain (not necessarily a Linux one)
452 val create_linux_job : [>`W] Connect.t -> xml -> ([`Domain], rw) job_t
453 (** Asynchronous domain creation. *)
454 val lookup_by_id : 'a Connect.t -> int -> 'a t
455 (** Lookup a domain by ID. *)
456 val lookup_by_uuid : 'a Connect.t -> uuid -> 'a t
457 (** Lookup a domain by UUID. This uses the packed byte array UUID. *)
458 val lookup_by_uuid_string : 'a Connect.t -> string -> 'a t
459 (** Lookup a domain by (string) UUID. *)
460 val lookup_by_name : 'a Connect.t -> string -> 'a t
461 (** Lookup a domain by name. *)
462 val destroy : [>`W] t -> unit
463 (** Abruptly destroy a domain. *)
464 val free : [>`R] t -> unit
465 (** [free domain] frees the domain object in memory.
467 The domain object is automatically freed if it is garbage
468 collected. This function just forces it to be freed right
472 val suspend : [>`W] t -> unit
473 (** Suspend a domain. *)
474 val resume : [>`W] t -> unit
475 (** Resume a domain. *)
476 val save : [>`W] t -> filename -> unit
477 (** Suspend a domain, then save it to the file. *)
478 val save_job : [>`W] t -> filename -> ([`Domain_nocreate], rw) job_t
479 (** Asynchronous domain suspend. *)
480 val restore : [>`W] Connect.t -> filename -> unit
481 (** Restore a domain from a file. *)
482 val restore_job : [>`W] Connect.t -> filename -> ([`Domain_nocreate], rw) job_t
483 (** Asynchronous domain restore. *)
484 val core_dump : [>`W] t -> filename -> unit
485 (** Force a domain to core dump to the named file. *)
486 val core_dump_job : [>`W] t -> filename -> ([`Domain_nocreate], rw) job_t
487 (** Asynchronous core dump. *)
488 val shutdown : [>`W] t -> unit
489 (** Shutdown a domain. *)
490 val reboot : [>`W] t -> unit
491 (** Reboot a domain. *)
492 val get_name : [>`R] t -> string
493 (** Get the domain name. *)
494 val get_uuid : [>`R] t -> uuid
495 (** Get the domain UUID (as a packed byte array). *)
496 val get_uuid_string : [>`R] t -> string
497 (** Get the domain UUID (as a printable string). *)
498 val get_id : [>`R] t -> int
499 (** [getid dom] returns the ID of the domain.
501 Do not call this on a defined but not running domain. Those
502 domains don't have IDs, and you'll get an error here.
505 val get_os_type : [>`R] t -> string
506 (** Get the operating system type. *)
507 val get_max_memory : [>`R] t -> int64
508 (** Get the maximum memory allocation. *)
509 val set_max_memory : [>`W] t -> int64 -> unit
510 (** Set the maximum memory allocation. *)
511 val set_memory : [>`W] t -> int64 -> unit
512 (** Set the normal memory allocation. *)
513 val get_info : [>`R] t -> info
514 (** Get information about a domain. *)
515 val get_xml_desc : [>`R] t -> xml
516 (** Get the XML description of a domain. *)
517 val get_scheduler_type : [>`R] t -> string * int
518 (** Get the scheduler type. *)
519 val get_scheduler_parameters : [>`R] t -> int -> sched_param array
520 (** Get the array of scheduler parameters. *)
521 val set_scheduler_parameters : [>`W] t -> sched_param array -> unit
522 (** Set the array of scheduler parameters. *)
523 val define_xml : [>`W] Connect.t -> xml -> rw t
524 (** Define a new domain (but don't start it up) from the XML. *)
525 val undefine : [>`W] t -> unit
526 (** Undefine a domain - removes its configuration. *)
527 val create : [>`W] t -> unit
528 (** Launch a defined (inactive) domain. *)
529 val create_job : [>`W] t -> ([`Domain_nocreate], rw) job_t
530 (** Asynchronous launch domain. *)
531 val get_autostart : [>`R] t -> bool
532 (** Get the autostart flag for a domain. *)
533 val set_autostart : [>`W] t -> bool -> unit
534 (** Set the autostart flag for a domain. *)
535 val set_vcpus : [>`W] t -> int -> unit
536 (** Change the number of vCPUs available to a domain. *)
537 val pin_vcpu : [>`W] t -> int -> string -> unit
538 (** [pin_vcpu dom vcpu bitmap] pins a domain vCPU to a bitmap of physical
539 CPUs. See the libvirt documentation for details of the
540 layout of the bitmap. *)
541 val get_vcpus : [>`R] t -> int -> int -> int * vcpu_info array * string
542 (** [get_vcpus dom maxinfo maplen] returns the pinning information
543 for a domain. See the libvirt documentation for details
544 of the array and bitmap returned from this function.
546 val get_max_vcpus : [>`R] t -> int
547 (** Returns the maximum number of vCPUs supported for this domain. *)
548 val attach_device : [>`W] t -> xml -> unit
549 (** Attach a device (described by the device XML) to a domain. *)
550 val detach_device : [>`W] t -> xml -> unit
551 (** Detach a device (described by the device XML) from a domain. *)
553 val migrate : [>`W] t -> [>`W] Connect.t -> migrate_flag list ->
554 ?dname:string -> ?uri:string -> ?bandwidth:int -> unit -> rw t
555 (** [migrate dom dconn flags ()] migrates a domain to a
556 destination host described by [dconn].
558 The optional flag [?dname] is used to rename the domain.
560 The optional flag [?uri] is used to route the migration.
562 The optional flag [?bandwidth] is used to limit the bandwidth
563 used for migration (in Mbps). *)
565 val block_stats : [>`R] t -> string -> block_stats
566 (** Returns block device stats. *)
567 val interface_stats : [>`R] t -> string -> interface_stats
568 (** Returns network interface stats. *)
570 external const : [>`R] t -> ro t = "%identity"
571 (** [const dom] turns a read/write domain handle into a read-only
572 domain handle. Note that the opposite operation is impossible.
575 (** Module dealing with domains. [Domain.t] is the
584 (** Network handle. Read-only handles have type [ro Network.t] and
585 read-write handles have type [rw Network.t].
588 val lookup_by_name : 'a Connect.t -> string -> 'a t
589 (** Lookup a network by name. *)
590 val lookup_by_uuid : 'a Connect.t -> uuid -> 'a t
591 (** Lookup a network by (packed) UUID. *)
592 val lookup_by_uuid_string : 'a Connect.t -> string -> 'a t
593 (** Lookup a network by UUID string. *)
594 val create_xml : [>`W] Connect.t -> xml -> rw t
595 (** Create a network. *)
596 val create_xml_job : [>`W] Connect.t -> xml -> ([`Network], rw) job_t
597 (** Asynchronous create network. *)
598 val define_xml : [>`W] Connect.t -> xml -> rw t
599 (** Define but don't activate a network. *)
600 val undefine : [>`W] t -> unit
601 (** Undefine configuration of a network. *)
602 val create : [>`W] t -> unit
603 (** Start up a defined (inactive) network. *)
604 val create_job : [>`W] t -> ([`Network_nocreate], rw) job_t
605 (** Asynchronous start network. *)
606 val destroy : [>`W] t -> unit
607 (** Destroy a network. *)
608 val free : [>`R] t -> unit
609 (** [free network] frees the network object in memory.
611 The network object is automatically freed if it is garbage
612 collected. This function just forces it to be freed right
616 val get_name : [>`R] t -> string
617 (** Get network name. *)
618 val get_uuid : [>`R] t -> uuid
619 (** Get network packed UUID. *)
620 val get_uuid_string : [>`R] t -> string
621 (** Get network UUID as a printable string. *)
622 val get_xml_desc : [>`R] t -> xml
623 (** Get XML description of a network. *)
624 val get_bridge_name : [>`R] t -> string
625 (** Get bridge device name of a network. *)
626 val get_autostart : [>`R] t -> bool
627 (** Get the autostart flag for a network. *)
628 val set_autostart : [>`W] t -> bool -> unit
629 (** Set the autostart flag for a network. *)
631 external const : [>`R] t -> ro t = "%identity"
632 (** [const network] turns a read/write network handle into a read-only
633 network handle. Note that the opposite operation is impossible.
636 (** Module dealing with networks. [Network.t] is the
640 (** {3 Storage pools} *)
645 (** Storage pool handle. *)
647 type pool_state = Inactive | Active
648 (** State of the storage pool. *)
651 capacity : int64; (** Logical size in bytes. *)
652 allocation : int64; (** Currently allocated in bytes. *)
655 val lookup_by_name : 'a Connect.t -> string -> 'a t
656 val lookup_by_uuid : 'a Connect.t -> uuid -> 'a t
657 val lookup_by_uuid_string : 'a Connect.t -> string -> 'a t
658 (** Look up a storage pool by name, UUID or UUID string. *)
660 val create_xml : [>`W] Connect.t -> xml -> rw t
661 (** Create a storage pool. *)
662 val define_xml : [>`W] Connect.t -> xml -> rw t
663 (** Define but don't activate a storage pool. *)
664 val undefine : [>`W] t -> unit
665 (** Undefine configuration of a storage pool. *)
666 val create : [>`W] t -> unit
667 (** Start up a defined (inactive) storage pool. *)
668 val destroy : [>`W] t -> unit
669 (** Destroy a storage pool. *)
670 val shutdown : [>`W] t -> unit
671 (** Shutdown a storage pool. *)
672 val free : [>`R] t -> unit
673 (** Free a storage pool object in memory.
675 The storage pool object is automatically freed if it is garbage
676 collected. This function just forces it to be freed right
679 val refresh : [`R] t -> unit
680 (** Refresh the list of volumes in the storage pool. *)
682 val get_name : [`R] t -> string
683 (** Name of the pool. *)
684 val get_uuid : [`R] t -> uuid
685 (** Get the UUID (as a packed byte array). *)
686 val get_uuid_string : [`R] t -> string
687 (** Get the UUID (as a printable string). *)
688 val get_info : [`R] t -> pool_info
689 (** Get information about the pool. *)
690 val get_xml_desc : [`R] t -> xml
691 (** Get the XML description. *)
692 val get_autostart : [`R] t -> bool
693 (** Get the autostart flag for the storage pool. *)
694 val set_autostart : [`W] t -> bool -> unit
695 (** Set the autostart flag for the storage pool. *)
697 external const : [>`R] t -> ro t = "%identity"
698 (** [const conn] turns a read/write storage pool into a read-only
699 pool. Note that the opposite operation is impossible.
702 (** Module dealing with storage pools. *)
704 (** {3 Storage volumes} *)
709 (** Storage volume handle. *)
711 type vol_type = File | Block | Virtual
712 (** Type of a storage volume. *)
715 typ : vol_type; (** Type of storage volume. *)
716 capacity : int64; (** Logical size in bytes. *)
717 allocation : int64; (** Currently allocated in bytes. *)
720 val lookup_by_name : 'a Pool.t -> string -> 'a t
721 val lookup_by_key : 'a Pool.t -> string -> 'a t
722 val lookup_by_path : 'a Pool.t -> string -> 'a t
723 (** Look up a storage volume by name, key or path volume. *)
725 val pool_of_volume : 'a t -> 'a Pool.t
726 (** Get the storage pool containing this volume. *)
728 val get_name : [`R] t -> string
729 (** Name of the volume. *)
730 val get_key : [`R] t -> string
731 (** Key of the volume. *)
732 val get_path : [`R] t -> string
733 (** Path of the volume. *)
734 val get_info : [`R] t -> vol_info
735 (** Get information about the storage volume. *)
736 val get_xml_desc : [`R] t -> xml
737 (** Get the XML description. *)
739 val create_xml : [`W] Pool.t -> xml -> unit
740 (** Create a storage volume. *)
741 val destroy : [`W] t -> unit
742 (** Destroy a storage volume. *)
743 val free : [>`R] t -> unit
744 (** Free a storage volume object in memory.
746 The storage volume object is automatically freed if it is garbage
747 collected. This function just forces it to be freed right
751 external const : [>`R] t -> ro t = "%identity"
752 (** [const conn] turns a read/write storage volume into a read-only
753 volume. Note that the opposite operation is impossible.
756 (** Module dealing with storage volumes. *)
758 (** {3 Jobs and asynchronous processing} *)
762 type ('jobclass, 'rw) t = ('jobclass, 'rw) job_t
763 (** A background asynchronous job.
765 Jobs represent a pending operation such as domain creation.
766 The possible types for a job are:
769 (`Domain, `W) Job.t Job creating a r/w domain
770 (`Domain_nocreate, `W) Job.t Job acting on an existing domain
771 (`Network, `W) Job.t Job creating a r/w network
772 (`Network_nocreate, `W) Job.t Job acting on an existing network
776 type job_type = Bounded | Unbounded
777 (** A Bounded job is one where we can estimate time to completion. *)
779 type job_state = Running | Complete | Failed | Cancelled
780 (** State of the job. *)
783 typ : job_type; (** Job type *)
784 state : job_state; (** Job state *)
785 running_time : int; (** Actual running time (seconds) *)
786 (** The following fields are only available in Bounded jobs: *)
787 remaining_time : int; (** Estimated time left (seconds) *)
788 percent_complete : int (** Estimated percent complete *)
791 val get_info : ('a,'b) t -> job_info
792 (** Get information and status about the job. *)
794 val get_domain : ([`Domain], 'a) t -> 'a Domain.t
795 (** Get the completed domain from a job.
797 You should only call it on a job in state Complete. *)
799 val get_network : ([`Network], 'a) t -> 'a Network.t
800 (** Get the completed network from a job.
802 You should only call it on a job in state Complete. *)
804 val cancel : ('a,'b) t -> unit
807 external const : ('a, [>`R]) t -> ('a, ro) t = "%identity"
808 (** [const conn] turns a read/write job into a read-only
809 job. Note that the opposite operation is impossible.
813 (** {3 Error handling and exceptions} *)
819 | VIR_ERR_INTERNAL_ERROR
822 | VIR_ERR_UNKNOWN_HOST
824 | VIR_ERR_INVALID_CONN
825 | VIR_ERR_INVALID_DOMAIN
826 | VIR_ERR_INVALID_ARG
827 | VIR_ERR_OPERATION_FAILED
829 | VIR_ERR_POST_FAILED
831 | VIR_ERR_SEXPR_SERIAL
842 | VIR_ERR_NO_XENSTORE
843 | VIR_ERR_DRIVER_FULL
844 | VIR_ERR_CALL_FAILED
847 | VIR_ERR_OPERATION_DENIED
848 | VIR_ERR_OPEN_FAILED
849 | VIR_ERR_READ_FAILED
850 | VIR_ERR_PARSE_FAILED
851 | VIR_ERR_CONF_SYNTAX
852 | VIR_ERR_WRITE_FAILED
854 | VIR_ERR_INVALID_NETWORK
855 | VIR_ERR_NETWORK_EXIST
856 | VIR_ERR_SYSTEM_ERROR
858 | VIR_ERR_GNUTLS_ERROR
862 | VIR_ERR_INVALID_MAC
863 (* ^^ NB: If you add a variant you MUST edit libvirt_c.c:MAX_VIR_* *)
864 | VIR_ERR_UNKNOWN of int
865 (** See [<libvirt/virterror.h>] for meaning of these codes. *)
867 val string_of_code : code -> string
886 | VIR_FROM_STATS_LINUX
887 (* ^^ NB: If you add a variant you MUST edit libvirt_c.c: MAX_VIR_* *)
888 | VIR_FROM_UNKNOWN of int
889 (** Subsystem / driver which produced the error. *)
891 val string_of_domain : domain -> string
897 (* ^^ NB: If you add a variant you MUST edit libvirt_c.c: MAX_VIR_* *)
898 | VIR_ERR_UNKNOWN_LEVEL of int
899 (** No error, a warning or an error. *)
901 val string_of_level : level -> string
904 code : code; (** Error code. *)
905 domain : domain; (** Origin of the error. *)
906 message : string option; (** Human-readable message. *)
907 level : level; (** Error or warning. *)
908 conn : ro Connect.t option; (** Associated connection. *)
909 dom : ro Domain.t option; (** Associated domain. *)
910 str1 : string option; (** Informational string. *)
911 str2 : string option; (** Informational string. *)
912 str3 : string option; (** Informational string. *)
913 int1 : int32; (** Informational integer. *)
914 int2 : int32; (** Informational integer. *)
915 net : ro Network.t option; (** Associated network. *)
917 (** An error object. *)
919 val to_string : t -> string
920 (** Turn the exception into a printable string. *)
922 val get_last_error : unit -> t option
923 val get_last_conn_error : [>`R] Connect.t -> t option
924 (** Get the last error at a global or connection level.
926 Normally you do not need to use these functions because
927 the library automatically turns errors into exceptions.
930 val reset_last_error : unit -> unit
931 val reset_last_conn_error : [>`R] Connect.t -> unit
932 (** Reset the error at a global or connection level.
934 Normally you do not need to use these functions.
937 val no_error : unit -> t
938 (** Creates an empty error message.
940 Normally you do not need to use this function.
943 (** Module dealing with errors. *)
945 exception Virterror of Virterror.t
946 (** This exception can be raised by any library function that detects
947 an error. To get a printable error message, call
948 {!Virterror.to_string} on the content of this exception.
951 exception Not_supported of string
954 [Not_supported "virFoo"]
955 (where [virFoo] is the libvirt function name) if a function is
956 not supported at either compile or run time. This applies to
957 any libvirt function added after version 0.2.1.
959 See also {{:http://libvirt.org/hvsupport.html}http://libvirt.org/hvsupport.html}