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,
9 with the OCaml linking exception described in ../COPYING.LIB.
11 This library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public
17 License along with this library; if not, write to the Free Software
18 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 {2 Introduction and examples}
24 This is a set of bindings for writing OCaml programs to
25 manage virtual machines through {{:http://libvirt.org/}libvirt}.
27 {3 Using libvirt interactively}
29 Using the interactive toplevel:
33 Objective Caml version 3.10.0
36 # #load "mllibvirt.cma";;
37 # let name = "test:///default";;
38 val name : string = "test:///default"
39 # let conn = Libvirt.Connect.connect_readonly ~name () ;;
40 val conn : Libvirt.ro Libvirt.Connect.t = <abstr>
41 # Libvirt.Connect.get_node_info conn;;
42 : Libvirt.Connect.node_info =
43 {Libvirt.Connect.model = "i686"; Libvirt.Connect.memory = 3145728L;
44 Libvirt.Connect.cpus = 16; Libvirt.Connect.mhz = 1400;
45 Libvirt.Connect.nodes = 2; Libvirt.Connect.sockets = 2;
46 Libvirt.Connect.cores = 2; Libvirt.Connect.threads = 2}
49 {3 Compiling libvirt programs}
51 This command compiles a program to native code:
54 ocamlopt -I +libvirt mllibvirt.cmxa list_domains.ml -o list_domains
57 {3 Example: Connect to the hypervisor}
59 The main modules are {!Libvirt.Connect}, {!Libvirt.Domain} and
60 {!Libvirt.Network} corresponding respectively to the
61 {{:http://libvirt.org/html/libvirt-libvirt.html}virConnect*, virDomain* and virNetwork* functions from libvirt}.
62 For brevity I usually rename these modules like this:
65 module C = Libvirt.Connect
66 module D = Libvirt.Domain
67 module N = Libvirt.Network
70 To get a connection handle, assuming a Xen hypervisor:
74 let conn = C.connect_readonly ~name ()
77 {3 Example: List running domains}
82 let domains = D.get_domains conn [D.ListActive] in
85 printf "%8d %s\n%!" (D.get_id dom) (D.get_name dom)
89 {3 Example: List inactive domains}
92 let domains = D.get_domains conn [D.ListInactive] in
95 printf "inactive %s\n%!" (D.get_name dom)
99 {3 Example: Print node info}
102 let node_info = C.get_node_info conn in
103 printf "model = %s\n" node_info.C.model;
104 printf "memory = %Ld K\n" node_info.C.memory;
105 printf "cpus = %d\n" node_info.C.cpus;
106 printf "mhz = %d\n" node_info.C.mhz;
107 printf "nodes = %d\n" node_info.C.nodes;
108 printf "sockets = %d\n" node_info.C.sockets;
109 printf "cores = %d\n" node_info.C.cores;
110 printf "threads = %d\n%!" node_info.C.threads;
112 let hostname = C.get_hostname conn in
113 printf "hostname = %s\n%!" hostname;
115 let uri = C.get_uri conn in
116 printf "uri = %s\n%!" uri
122 (** {2 Programming issues}
124 {3 General safety issues}
126 Memory allocation / automatic garbage collection of all libvirt
127 objects should be completely safe. If you find any safety issues
128 or if your pure OCaml program ever segfaults, please contact the author.
130 You can force a libvirt object to be freed early by calling
131 the [close] function on the object. This shouldn't affect
132 the safety of garbage collection and should only be used when
133 you want to explicitly free memory. Note that explicitly
134 closing a connection object does nothing if there are still
135 unclosed domain or network objects referencing it.
137 Note that even though you hold open (eg) a domain object, that
138 doesn't mean that the domain (virtual machine) actually exists.
139 The domain could have been shut down or deleted by another user.
140 Thus domain objects can raise odd exceptions at any time.
141 This is just the nature of virtualisation.
143 {3 Backwards and forwards compatibility}
145 OCaml-libvirt is backwards and forwards compatible with
146 any libvirt >= 0.2.1. One consequence of this is that
147 your program can dynamically link to a {i newer} version of
148 libvirt than it was compiled with, and it should still
151 When we link to an older version of libvirt.so, there may
152 be missing functions. If ocaml-libvirt was compiled with
153 gcc, then these are turned into OCaml {!Libvirt.Not_supported}
156 We don't support libvirt < 0.2.1, and never will so don't ask us.
158 {3 Get list of domains and domain infos}
160 This is a very common operation, and libvirt supports various
161 different methods to do it. We have hidden the complexity in a
162 flexible {!Libvirt.Domain.get_domains} and
163 {!Libvirt.Domain.get_domains_and_infos} calls which is easy to use and
164 automatically chooses the most efficient method depending on the
165 version of libvirt in use.
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
244 (** {3 Forward definitions}
246 These definitions are placed here to avoid the need to
247 use recursive module dependencies.
250 (** {3 Connections} *)
255 (** Connection. Read-only connections have type [ro Connect.t] and
256 read-write connections have type [rw Connect.t].
260 model : string; (** CPU model *)
261 memory : int64; (** memory size in kilobytes *)
262 cpus : int; (** number of active CPUs *)
263 mhz : int; (** expected CPU frequency *)
264 nodes : int; (** number of NUMA nodes (1 = UMA) *)
265 sockets : int; (** number of CPU sockets per node *)
266 cores : int; (** number of cores per socket *)
267 threads : int; (** number of threads per core *)
270 val connect : ?name:string -> unit -> rw t
271 val connect_readonly : ?name:string -> unit -> ro t
272 (** [connect ~name ()] connects to the hypervisor with URI [name].
274 [connect ()] connects to the default hypervisor.
276 [connect_readonly] is the same but connects in read-only mode.
279 val close : [>`R] t -> unit
280 (** [close conn] closes and frees the connection object in memory.
282 The connection is automatically closed if it is garbage
283 collected. This function just forces it to be closed
284 and freed right away.
287 val get_type : [>`R] t -> string
288 (** Returns the name of the driver (hypervisor). *)
290 val get_version : [>`R] t -> int
291 (** Returns the driver version
292 [major * 1_000_000 + minor * 1000 + release]
294 val get_hostname : [>`R] t -> string
295 (** Returns the hostname of the physical server. *)
296 val get_uri : [>`R] t -> string
297 (** Returns the canonical connection URI. *)
298 val get_max_vcpus : [>`R] t -> ?type_:string -> unit -> int
299 (** Returns the maximum number of virtual CPUs
300 supported by a guest VM of a particular type. *)
301 val list_domains : [>`R] t -> int -> int array
302 (** [list_domains conn max] returns the running domain IDs,
303 up to a maximum of [max] entries.
305 Call {!num_of_domains} first to get a value for [max].
308 {!Libvirt.Domain.get_domains},
309 {!Libvirt.Domain.get_domains_and_infos}.
311 val num_of_domains : [>`R] t -> int
312 (** Returns the number of running domains. *)
313 val get_capabilities : [>`R] t -> xml
314 (** Returns the hypervisor capabilities (as XML). *)
315 val num_of_defined_domains : [>`R] t -> int
316 (** Returns the number of inactive (shutdown) domains. *)
317 val list_defined_domains : [>`R] t -> int -> string array
318 (** [list_defined_domains conn max]
319 returns the names of the inactive domains, up to
320 a maximum of [max] entries.
322 Call {!num_of_defined_domains} first to get a value for [max].
325 {!Libvirt.Domain.get_domains},
326 {!Libvirt.Domain.get_domains_and_infos}.
328 val num_of_networks : [>`R] t -> int
329 (** Returns the number of networks. *)
330 val list_networks : [>`R] t -> int -> string array
331 (** [list_networks conn max]
332 returns the names of the networks, up to a maximum
334 Call {!num_of_networks} first to get a value for [max].
336 val num_of_defined_networks : [>`R] t -> int
337 (** Returns the number of inactive networks. *)
338 val list_defined_networks : [>`R] t -> int -> string array
339 (** [list_defined_networks conn max]
340 returns the names of the inactive networks, up to a maximum
342 Call {!num_of_defined_networks} first to get a value for [max].
345 val num_of_pools : [>`R] t -> int
346 (** Returns the number of storage pools. *)
347 val list_pools : [>`R] t -> int -> string array
348 (** Return list of storage pools. *)
349 val num_of_defined_pools : [>`R] t -> int
350 (** Returns the number of storage pools. *)
351 val list_defined_pools : [>`R] t -> int -> string array
352 (** Return list of storage pools. *)
354 (* The name of this function is inconsistent, but the inconsistency
355 * is really in libvirt itself.
357 val get_node_info : [>`R] t -> node_info
358 (** Return information about the physical server. *)
360 val node_get_free_memory : [> `R] t -> int64
362 [node_get_free_memory conn]
363 returns the amount of free memory (not allocated to any guest)
367 val node_get_cells_free_memory : [> `R] t -> int -> int -> int64 array
369 [node_get_cells_free_memory conn start max]
370 returns the amount of free memory on each NUMA cell in kilobytes.
371 [start] is the first cell for which we return free memory.
372 [max] is the maximum number of cells for which we return free memory.
373 Returns an array of up to [max] entries in length.
376 val maxcpus_of_node_info : node_info -> int
377 (** Calculate the total number of CPUs supported (but not necessarily
381 val cpumaplen : int -> int
382 (** Calculate the length (in bytes) required to store the complete
383 CPU map between a single virtual and all physical CPUs of a domain.
386 val use_cpu : string -> int -> unit
387 (** [use_cpu cpumap cpu] marks [cpu] as usable in [cpumap]. *)
388 val unuse_cpu : string -> int -> unit
389 (** [unuse_cpu cpumap cpu] marks [cpu] as not usable in [cpumap]. *)
390 val cpu_usable : string -> int -> int -> int -> bool
391 (** [cpu_usable cpumaps maplen vcpu cpu] checks returns true iff the
392 [cpu] is usable by [vcpu]. *)
394 external const : [>`R] t -> ro t = "%identity"
395 (** [const conn] turns a read/write connection into a read-only
396 connection. Note that the opposite operation is impossible.
399 (** Module dealing with connections. [Connect.t] is the
400 connection object. *)
407 (** Domain handle. Read-only handles have type [ro Domain.t] and
408 read-write handles have type [rw Domain.t].
412 | InfoNoState | InfoRunning | InfoBlocked | InfoPaused
413 | InfoShutdown | InfoShutoff | InfoCrashed
416 state : state; (** running state *)
417 max_mem : int64; (** maximum memory in kilobytes *)
418 memory : int64; (** memory used in kilobytes *)
419 nr_virt_cpu : int; (** number of virtual CPUs *)
420 cpu_time : int64; (** CPU time used in nanoseconds *)
423 type vcpu_state = VcpuOffline | VcpuRunning | VcpuBlocked
426 number : int; (** virtual CPU number *)
427 vcpu_state : vcpu_state; (** state *)
428 vcpu_time : int64; (** CPU time used in nanoseconds *)
429 cpu : int; (** real CPU number, -1 if offline *)
432 type sched_param = string * sched_param_value
433 and sched_param_value =
434 | SchedFieldInt32 of int32 | SchedFieldUInt32 of int32
435 | SchedFieldInt64 of int64 | SchedFieldUInt64 of int64
436 | SchedFieldFloat of float | SchedFieldBool of bool
438 type migrate_flag = Live
440 type memory_flag = Virtual
455 type interface_stats = {
466 val max_peek : [>`R] t -> int
467 (** Maximum size supported by the {!block_peek} and {!memory_peek}
468 functions. If you want to peek more than this then you must
469 break your request into chunks. *)
471 val create_linux : [>`W] Connect.t -> xml -> rw t
472 (** Create a new guest domain (not necessarily a Linux one)
475 val lookup_by_id : 'a Connect.t -> int -> 'a t
476 (** Lookup a domain by ID. *)
477 val lookup_by_uuid : 'a Connect.t -> uuid -> 'a t
478 (** Lookup a domain by UUID. This uses the packed byte array UUID. *)
479 val lookup_by_uuid_string : 'a Connect.t -> string -> 'a t
480 (** Lookup a domain by (string) UUID. *)
481 val lookup_by_name : 'a Connect.t -> string -> 'a t
482 (** Lookup a domain by name. *)
483 val destroy : [>`W] t -> unit
484 (** Abruptly destroy a domain. *)
485 val free : [>`R] t -> unit
486 (** [free domain] frees the domain object in memory.
488 The domain object is automatically freed if it is garbage
489 collected. This function just forces it to be freed right
493 val suspend : [>`W] t -> unit
494 (** Suspend a domain. *)
495 val resume : [>`W] t -> unit
496 (** Resume a domain. *)
497 val save : [>`W] t -> filename -> unit
498 (** Suspend a domain, then save it to the file. *)
499 val restore : [>`W] Connect.t -> filename -> unit
500 (** Restore a domain from a file. *)
501 val core_dump : [>`W] t -> filename -> unit
502 (** Force a domain to core dump to the named file. *)
503 val shutdown : [>`W] t -> unit
504 (** Shutdown a domain. *)
505 val reboot : [>`W] t -> unit
506 (** Reboot a domain. *)
507 val get_name : [>`R] t -> string
508 (** Get the domain name. *)
509 val get_uuid : [>`R] t -> uuid
510 (** Get the domain UUID (as a packed byte array). *)
511 val get_uuid_string : [>`R] t -> string
512 (** Get the domain UUID (as a printable string). *)
513 val get_id : [>`R] t -> int
514 (** [get_id dom] returns the ID of the domain. In most cases
515 this returns [-1] if the domain is not running. *)
516 val get_os_type : [>`R] t -> string
517 (** Get the operating system type. *)
518 val get_max_memory : [>`R] t -> int64
519 (** Get the maximum memory allocation. *)
520 val set_max_memory : [>`W] t -> int64 -> unit
521 (** Set the maximum memory allocation. *)
522 val set_memory : [>`W] t -> int64 -> unit
523 (** Set the normal memory allocation. *)
524 val get_info : [>`R] t -> info
525 (** Get information about a domain. *)
526 val get_xml_desc : [>`R] t -> xml
527 (** Get the XML description of a domain. *)
528 val get_scheduler_type : [>`R] t -> string * int
529 (** Get the scheduler type. *)
530 val get_scheduler_parameters : [>`R] t -> int -> sched_param array
531 (** Get the array of scheduler parameters. *)
532 val set_scheduler_parameters : [>`W] t -> sched_param array -> unit
533 (** Set the array of scheduler parameters. *)
534 val define_xml : [>`W] Connect.t -> xml -> rw t
535 (** Define a new domain (but don't start it up) from the XML. *)
536 val undefine : [>`W] t -> unit
537 (** Undefine a domain - removes its configuration. *)
538 val create : [>`W] t -> unit
539 (** Launch a defined (inactive) domain. *)
540 val get_autostart : [>`R] t -> bool
541 (** Get the autostart flag for a domain. *)
542 val set_autostart : [>`W] t -> bool -> unit
543 (** Set the autostart flag for a domain. *)
544 val set_vcpus : [>`W] t -> int -> unit
545 (** Change the number of vCPUs available to a domain. *)
546 val pin_vcpu : [>`W] t -> int -> string -> unit
547 (** [pin_vcpu dom vcpu bitmap] pins a domain vCPU to a bitmap of physical
548 CPUs. See the libvirt documentation for details of the
549 layout of the bitmap. *)
550 val get_vcpus : [>`R] t -> int -> int -> int * vcpu_info array * string
551 (** [get_vcpus dom maxinfo maplen] returns the pinning information
552 for a domain. See the libvirt documentation for details
553 of the array and bitmap returned from this function.
555 val get_max_vcpus : [>`R] t -> int
556 (** Returns the maximum number of vCPUs supported for this domain. *)
557 val attach_device : [>`W] t -> xml -> unit
558 (** Attach a device (described by the device XML) to a domain. *)
559 val detach_device : [>`W] t -> xml -> unit
560 (** Detach a device (described by the device XML) from a domain. *)
562 val migrate : [>`W] t -> [>`W] Connect.t -> migrate_flag list ->
563 ?dname:string -> ?uri:string -> ?bandwidth:int -> unit -> rw t
564 (** [migrate dom dconn flags ()] migrates a domain to a
565 destination host described by [dconn].
567 The optional flag [?dname] is used to rename the domain.
569 The optional flag [?uri] is used to route the migration.
571 The optional flag [?bandwidth] is used to limit the bandwidth
572 used for migration (in Mbps). *)
574 val block_stats : [>`R] t -> string -> block_stats
575 (** Returns block device stats. *)
576 val interface_stats : [>`R] t -> string -> interface_stats
577 (** Returns network interface stats. *)
579 val block_peek : [>`W] t -> string -> int64 -> int -> string -> int -> unit
580 (** [block_peek dom path offset size buf boff] reads [size] bytes at
581 [offset] in the domain's [path] block device.
583 If successful then the data is written into [buf] starting
584 at offset [boff], for [size] bytes.
586 See also {!max_peek}. *)
587 val memory_peek : [>`W] t -> memory_flag list -> int64 -> int ->
588 string -> int -> unit
589 (** [memory_peek dom Virtual offset size] reads [size] bytes
590 at [offset] in the domain's virtual memory.
592 If successful then the data is written into [buf] starting
593 at offset [boff], for [size] bytes.
595 See also {!max_peek}. *)
597 external const : [>`R] t -> ro t = "%identity"
598 (** [const dom] turns a read/write domain handle into a read-only
599 domain handle. Note that the opposite operation is impossible.
602 val get_domains : ([>`R] as 'a) Connect.t -> list_flag list -> 'a t list
603 (** Get the active and/or inactive domains using the most
604 efficient method available.
607 {!get_domains_and_infos},
608 {!Connect.list_domains},
609 {!Connect.list_defined_domains}.
612 val get_domains_and_infos : ([>`R] as 'a) Connect.t -> list_flag list ->
614 (** This gets the active and/or inactive domains and the
615 domain info for each one using the most efficient
620 {!Connect.list_domains},
621 {!Connect.list_defined_domains},
626 (** Module dealing with domains. [Domain.t] is the
634 (** Network handle. Read-only handles have type [ro Network.t] and
635 read-write handles have type [rw Network.t].
638 val lookup_by_name : 'a Connect.t -> string -> 'a t
639 (** Lookup a network by name. *)
640 val lookup_by_uuid : 'a Connect.t -> uuid -> 'a t
641 (** Lookup a network by (packed) UUID. *)
642 val lookup_by_uuid_string : 'a Connect.t -> string -> 'a t
643 (** Lookup a network by UUID string. *)
644 val create_xml : [>`W] Connect.t -> xml -> rw t
645 (** Create a network. *)
646 val define_xml : [>`W] Connect.t -> xml -> rw t
647 (** Define but don't activate a network. *)
648 val undefine : [>`W] t -> unit
649 (** Undefine configuration of a network. *)
650 val create : [>`W] t -> unit
651 (** Start up a defined (inactive) network. *)
652 val destroy : [>`W] t -> unit
653 (** Destroy a network. *)
654 val free : [>`R] t -> unit
655 (** [free network] frees the network object in memory.
657 The network object is automatically freed if it is garbage
658 collected. This function just forces it to be freed right
662 val get_name : [>`R] t -> string
663 (** Get network name. *)
664 val get_uuid : [>`R] t -> uuid
665 (** Get network packed UUID. *)
666 val get_uuid_string : [>`R] t -> string
667 (** Get network UUID as a printable string. *)
668 val get_xml_desc : [>`R] t -> xml
669 (** Get XML description of a network. *)
670 val get_bridge_name : [>`R] t -> string
671 (** Get bridge device name of a network. *)
672 val get_autostart : [>`R] t -> bool
673 (** Get the autostart flag for a network. *)
674 val set_autostart : [>`W] t -> bool -> unit
675 (** Set the autostart flag for a network. *)
677 external const : [>`R] t -> ro t = "%identity"
678 (** [const network] turns a read/write network handle into a read-only
679 network handle. Note that the opposite operation is impossible.
682 (** Module dealing with networks. [Network.t] is the
685 (** {3 Storage pools} *)
690 (** Storage pool handle. *)
692 type pool_state = Inactive | Building | Running | Degraded
693 (** State of the storage pool. *)
695 type pool_build_flags = New | Repair | Resize
696 (** Flags for creating a storage pool. *)
698 type pool_delete_flags = Normal | Zeroed
699 (** Flags for deleting a storage pool. *)
702 state : pool_state; (** Pool state. *)
703 capacity : int64; (** Logical size in bytes. *)
704 allocation : int64; (** Currently allocated in bytes. *)
705 available : int64; (** Remaining free space bytes. *)
708 val lookup_by_name : 'a Connect.t -> string -> 'a t
709 val lookup_by_uuid : 'a Connect.t -> uuid -> 'a t
710 val lookup_by_uuid_string : 'a Connect.t -> string -> 'a t
711 (** Look up a storage pool by name, UUID or UUID string. *)
713 val create_xml : [>`W] Connect.t -> xml -> rw t
714 (** Create a storage pool. *)
715 val define_xml : [>`W] Connect.t -> xml -> rw t
716 (** Define but don't activate a storage pool. *)
717 val build : [>`W] t -> pool_build_flags -> unit
718 (** Build a storage pool. *)
719 val undefine : [>`W] t -> unit
720 (** Undefine configuration of a storage pool. *)
721 val create : [>`W] t -> unit
722 (** Start up a defined (inactive) storage pool. *)
723 val destroy : [>`W] t -> unit
724 (** Destroy a storage pool. *)
725 val delete : [>`W] t -> unit
726 (** Delete a storage pool. *)
727 val free : [>`R] t -> unit
728 (** Free a storage pool object in memory.
730 The storage pool object is automatically freed if it is garbage
731 collected. This function just forces it to be freed right
734 val refresh : [`R] t -> unit
735 (** Refresh the list of volumes in the storage pool. *)
737 val get_name : [`R] t -> string
738 (** Name of the pool. *)
739 val get_uuid : [`R] t -> uuid
740 (** Get the UUID (as a packed byte array). *)
741 val get_uuid_string : [`R] t -> string
742 (** Get the UUID (as a printable string). *)
743 val get_info : [`R] t -> pool_info
744 (** Get information about the pool. *)
745 val get_xml_desc : [`R] t -> xml
746 (** Get the XML description. *)
747 val get_autostart : [`R] t -> bool
748 (** Get the autostart flag for the storage pool. *)
749 val set_autostart : [`W] t -> bool -> unit
750 (** Set the autostart flag for the storage pool. *)
752 val num_of_volumes : [`R] t -> int
753 (** Returns the number of storage volumes within the storage pool. *)
754 val list_volumes : [`R] t -> int -> string array
755 (** Return list of storage volumes. *)
757 external const : [>`R] t -> ro t = "%identity"
758 (** [const conn] turns a read/write storage pool into a read-only
759 pool. Note that the opposite operation is impossible.
762 (** Module dealing with storage pools. *)
764 (** {3 Storage volumes} *)
769 (** Storage volume handle. *)
771 type vol_type = File | Block
772 (** Type of a storage volume. *)
774 type vol_delete_flags = Normal | Zeroed
775 (** Flags for deleting a storage volume. *)
778 typ : vol_type; (** Type of storage volume. *)
779 capacity : int64; (** Logical size in bytes. *)
780 allocation : int64; (** Currently allocated in bytes. *)
783 val lookup_by_name : 'a Pool.t -> string -> 'a t
784 val lookup_by_key : 'a Connect.t -> string -> 'a t
785 val lookup_by_path : 'a Connect.t -> string -> 'a t
786 (** Look up a storage volume by name, key or path volume. *)
788 val pool_of_volume : 'a t -> 'a Pool.t
789 (** Get the storage pool containing this volume. *)
791 val get_name : [`R] t -> string
792 (** Name of the volume. *)
793 val get_key : [`R] t -> string
794 (** Key of the volume. *)
795 val get_path : [`R] t -> string
796 (** Path of the volume. *)
797 val get_info : [`R] t -> vol_info
798 (** Get information about the storage volume. *)
799 val get_xml_desc : [`R] t -> xml
800 (** Get the XML description. *)
802 val create_xml : [`W] Pool.t -> xml -> unit
803 (** Create a storage volume. *)
804 val delete : [`W] t -> unit
805 (** Delete a storage volume. *)
806 val free : [>`R] t -> unit
807 (** Free a storage volume object in memory.
809 The storage volume object is automatically freed if it is garbage
810 collected. This function just forces it to be freed right
814 external const : [>`R] t -> ro t = "%identity"
815 (** [const conn] turns a read/write storage volume into a read-only
816 volume. Note that the opposite operation is impossible.
819 (** Module dealing with storage volumes. *)
821 (** {3 Error handling and exceptions} *)
827 | VIR_ERR_INTERNAL_ERROR
830 | VIR_ERR_UNKNOWN_HOST
832 | VIR_ERR_INVALID_CONN
833 | VIR_ERR_INVALID_DOMAIN
834 | VIR_ERR_INVALID_ARG
835 | VIR_ERR_OPERATION_FAILED
837 | VIR_ERR_POST_FAILED
839 | VIR_ERR_SEXPR_SERIAL
850 | VIR_ERR_NO_XENSTORE
851 | VIR_ERR_DRIVER_FULL
852 | VIR_ERR_CALL_FAILED
855 | VIR_ERR_OPERATION_DENIED
856 | VIR_ERR_OPEN_FAILED
857 | VIR_ERR_READ_FAILED
858 | VIR_ERR_PARSE_FAILED
859 | VIR_ERR_CONF_SYNTAX
860 | VIR_ERR_WRITE_FAILED
862 | VIR_ERR_INVALID_NETWORK
863 | VIR_ERR_NETWORK_EXIST
864 | VIR_ERR_SYSTEM_ERROR
866 | VIR_ERR_GNUTLS_ERROR
870 | VIR_ERR_INVALID_MAC
871 | VIR_ERR_AUTH_FAILED
872 | VIR_ERR_INVALID_STORAGE_POOL
873 | VIR_ERR_INVALID_STORAGE_VOL
875 | VIR_ERR_NO_STORAGE_POOL
876 | VIR_ERR_NO_STORAGE_VOL
877 (* ^^ NB: If you add a variant you MUST edit
878 libvirt_c_epilogue.c:MAX_VIR_* *)
879 | VIR_ERR_UNKNOWN of int
880 (** See [<libvirt/virterror.h>] for meaning of these codes. *)
882 val string_of_code : code -> string
901 | VIR_FROM_STATS_LINUX
903 (* ^^ NB: If you add a variant you MUST edit
904 libvirt_c_epilogue.c: MAX_VIR_* *)
905 | VIR_FROM_UNKNOWN of int
906 (** Subsystem / driver which produced the error. *)
908 val string_of_domain : domain -> string
914 (* ^^ NB: If you add a variant you MUST edit libvirt_c.c: MAX_VIR_* *)
915 | VIR_ERR_UNKNOWN_LEVEL of int
916 (** No error, a warning or an error. *)
918 val string_of_level : level -> string
921 code : code; (** Error code. *)
922 domain : domain; (** Origin of the error. *)
923 message : string option; (** Human-readable message. *)
924 level : level; (** Error or warning. *)
925 str1 : string option; (** Informational string. *)
926 str2 : string option; (** Informational string. *)
927 str3 : string option; (** Informational string. *)
928 int1 : int32; (** Informational integer. *)
929 int2 : int32; (** Informational integer. *)
931 (** An error object. *)
933 val to_string : t -> string
934 (** Turn the exception into a printable string. *)
936 val get_last_error : unit -> t option
937 val get_last_conn_error : [>`R] Connect.t -> t option
938 (** Get the last error at a global or connection level.
940 Normally you do not need to use these functions because
941 the library automatically turns errors into exceptions.
944 val reset_last_error : unit -> unit
945 val reset_last_conn_error : [>`R] Connect.t -> unit
946 (** Reset the error at a global or connection level.
948 Normally you do not need to use these functions.
951 val no_error : unit -> t
952 (** Creates an empty error message.
954 Normally you do not need to use this function.
957 (** Module dealing with errors. *)
959 exception Virterror of Virterror.t
960 (** This exception can be raised by any library function that detects
961 an error. To get a printable error message, call
962 {!Virterror.to_string} on the content of this exception.
965 exception Not_supported of string
968 [Not_supported "virFoo"]
969 (where [virFoo] is the libvirt function name) if a function is
970 not supported at either compile or run time. This applies to
971 any libvirt function added after version 0.2.1.
973 See also {{:http://libvirt.org/hvsupport.html}http://libvirt.org/hvsupport.html}
976 (** {3 Utility functions} *)
978 val map_ignore_errors : ('a -> 'b) -> 'a list -> 'b list
979 (** [map_ignore_errors f xs] calls function [f] for each element of [xs].
981 This is just like [List.map] except that if [f x] throws a
982 {!Virterror.t} exception, the error is ignored and [f x]
983 is not returned in the final list.
985 This function is primarily useful when dealing with domains which
986 might 'disappear' asynchronously from the currently running