# Index of values

A
add_timeout [Libvirt.Event] | `add_timeout con ms cb` registers `cb` as a timeout callback which will be called every `ms` milliseconds
attach_device [Libvirt.Domain] | Attach a device (described by the device XML) to a domain.
B
block_peek [Libvirt.Domain] | `block_peek dom path offset size buf boff` reads `size` bytes at `offset` in the domain's `path` block device.
block_stats [Libvirt.Domain] | Returns block device stats.
build [Libvirt.Pool] | Build a storage pool.
C
close [Libvirt.Connect] | `close conn` closes and frees the connection object in memory.
connect [Libvirt.Connect] |
connect_readonly [Libvirt.Connect] | `connect ~name ()` connects to the hypervisor with URI `name`.
const [Libvirt.Volume] | `const conn` turns a read/write storage volume into a read-only volume.
const [Libvirt.Pool] | `const conn` turns a read/write storage pool into a read-only pool.
const [Libvirt.Network] | `const network` turns a read/write network handle into a read-only network handle.
const [Libvirt.Domain] | `const dom` turns a read/write domain handle into a read-only domain handle.
const [Libvirt.Connect] | `const conn` turns a read/write connection into a read-only connection.
core_dump [Libvirt.Domain] | Force a domain to core dump to the named file.
cpu_usable [Libvirt.Connect] | `cpu_usable cpumaps maplen vcpu cpu` checks returns true iff the `cpu` is usable by `vcpu`.
cpumaplen [Libvirt.Connect] | Calculate the length (in bytes) required to store the complete CPU map between a single virtual and all physical CPUs of a domain.
create [Libvirt.Pool] | Start up a defined (inactive) storage pool.
create [Libvirt.Network] | Start up a defined (inactive) network.
create [Libvirt.Domain] | Launch a defined (inactive) domain.
create_linux [Libvirt.Domain] | Create a new guest domain (not necessarily a Linux one) from the given XML.
create_xml [Libvirt.Volume] | Create a storage volume.
create_xml [Libvirt.Pool] | Create a storage pool.
create_xml [Libvirt.Network] | Create a network.
D
define_xml [Libvirt.Pool] | Define but don't activate a storage pool.
define_xml [Libvirt.Network] | Define but don't activate a network.
define_xml [Libvirt.Domain] | Define a new domain (but don't start it up) from the XML.
delete [Libvirt.Volume] | Delete a storage volume.
delete [Libvirt.Pool] | Delete a storage pool.
deregister_any [Libvirt.Event] | `deregister_any con id` deregisters the previously registered callback with id `id`.
destroy [Libvirt.Pool] | Destroy a storage pool.
destroy [Libvirt.Network] | Destroy a network.
destroy [Libvirt.Domain] | Abruptly destroy a domain.
detach_device [Libvirt.Domain] | Detach a device (described by the device XML) from a domain.
F
free [Libvirt.Volume] | Free a storage volume object in memory.
free [Libvirt.Pool] | Free a storage pool object in memory.
free [Libvirt.Network] | `free network` frees the network object in memory.
free [Libvirt.Domain] | `free domain` frees the domain object in memory.
G
get_autostart [Libvirt.Pool] | Get the autostart flag for the storage pool.
get_autostart [Libvirt.Network] | Get the autostart flag for a network.
get_autostart [Libvirt.Domain] | Get the autostart flag for a domain.
get_bridge_name [Libvirt.Network] | Get bridge device name of a network.
get_capabilities [Libvirt.Connect] | Returns the hypervisor capabilities (as XML).
get_cpu_stats [Libvirt.Domain] | `get_pcpu_stats dom` returns the physical CPU stats for a domain.
get_domains [Libvirt.Domain] | Get the active and/or inactive domains using the most efficient method available.
get_domains_and_infos [Libvirt.Domain] | This gets the active and/or inactive domains and the domain info for each one using the most efficient method available.
get_hostname [Libvirt.Connect] | Returns the hostname of the physical server.
get_id [Libvirt.Domain] | `get_id dom` returns the ID of the domain.
get_info [Libvirt.Volume] | Get information about the storage volume.
get_info [Libvirt.Pool] | Get information about the pool.
get_info [Libvirt.Domain] | Get information about a domain.
get_key [Libvirt.Volume] | Key of the volume.
get_last_conn_error [Libvirt.Virterror] | Get the last error at a global or connection level.
get_last_error [Libvirt.Virterror] |
get_max_memory [Libvirt.Domain] | Get the maximum memory allocation.
get_max_vcpus [Libvirt.Domain] | Returns the maximum number of vCPUs supported for this domain.
get_max_vcpus [Libvirt.Connect] | Returns the maximum number of virtual CPUs supported by a guest VM of a particular type.
get_name [Libvirt.Volume] | Name of the volume.
get_name [Libvirt.Pool] | Name of the pool.
get_name [Libvirt.Network] | Get network name.
get_name [Libvirt.Domain] | Get the domain name.
get_node_info [Libvirt.Connect] | Return information about the physical server.
get_os_type [Libvirt.Domain] | Get the operating system type.
get_path [Libvirt.Volume] | Path of the volume.
get_scheduler_parameters [Libvirt.Domain] | Get the array of scheduler parameters.
get_scheduler_type [Libvirt.Domain] | Get the scheduler type.
get_type [Libvirt.Connect] | Returns the name of the driver (hypervisor).
get_uri [Libvirt.Connect] | Returns the canonical connection URI.
get_uuid [Libvirt.Pool] | Get the UUID (as a packed byte array).
get_uuid [Libvirt.Network] | Get network packed UUID.
get_uuid [Libvirt.Domain] | Get the domain UUID (as a packed byte array).
get_uuid_string [Libvirt.Pool] | Get the UUID (as a printable string).
get_uuid_string [Libvirt.Network] | Get network UUID as a printable string.
get_uuid_string [Libvirt.Domain] | Get the domain UUID (as a printable string).
get_vcpus [Libvirt.Domain] | `get_vcpus dom maxinfo maplen` returns the pinning information for a domain.
get_version [Libvirt.Connect] | Returns the driver version `major * 1_000_000 + minor * 1000 + release`
get_version [Libvirt] | `get_version ()` returns the library version in the first part of the tuple, and `0` in the second part.
get_xml_desc [Libvirt.Volume] | Get the XML description.
get_xml_desc [Libvirt.Pool] | Get the XML description.
get_xml_desc [Libvirt.Network] | Get XML description of a network.
get_xml_desc [Libvirt.Domain] | Get the XML description of a domain.
I
interface_stats [Libvirt.Domain] | Returns network interface stats.
L
list_defined_domains [Libvirt.Connect] | `list_defined_domains conn max` returns the names of the inactive domains, up to a maximum of `max` entries.
list_defined_networks [Libvirt.Connect] | `list_defined_networks conn max` returns the names of the inactive networks, up to a maximum of `max` entries.
list_defined_pools [Libvirt.Connect] | Return list of storage pools.
list_domains [Libvirt.Connect] | `list_domains conn max` returns the running domain IDs, up to a maximum of `max` entries.
list_networks [Libvirt.Connect] | `list_networks conn max` returns the names of the networks, up to a maximum of `max` entries.
list_pools [Libvirt.Connect] | Return list of storage pools.
list_volumes [Libvirt.Pool] | Return list of storage volumes.
lookup_by_id [Libvirt.Domain] | Lookup a domain by ID.
lookup_by_key [Libvirt.Volume] |
lookup_by_name [Libvirt.Volume] |
lookup_by_name [Libvirt.Pool] |
lookup_by_name [Libvirt.Network] | Lookup a network by name.
lookup_by_name [Libvirt.Domain] | Lookup a domain by name.
lookup_by_path [Libvirt.Volume] | Look up a storage volume by name, key or path volume.
lookup_by_uuid [Libvirt.Pool] |
lookup_by_uuid [Libvirt.Network] | Lookup a network by (packed) UUID.
lookup_by_uuid [Libvirt.Domain] | Lookup a domain by UUID.
lookup_by_uuid_string [Libvirt.Pool] | Look up a storage pool by name, UUID or UUID string.
lookup_by_uuid_string [Libvirt.Network] | Lookup a network by UUID string.
lookup_by_uuid_string [Libvirt.Domain] | Lookup a domain by (string) UUID.
M
map_ignore_errors [Libvirt] | `map_ignore_errors f xs` calls function `f` for each element of `xs`.
max_peek [Libvirt.Domain] | Maximum size supported by the `Libvirt.Domain.block_peek` and `Libvirt.Domain.memory_peek` functions.
maxcpus_of_node_info [Libvirt.Connect] | Calculate the total number of CPUs supported (but not necessarily active) in the host.
memory_peek [Libvirt.Domain] | `memory_peek dom Virtual offset size` reads `size` bytes at `offset` in the domain's virtual memory.
migrate [Libvirt.Domain] | `migrate dom dconn flags ()` migrates a domain to a destination host described by `dconn`.
N
no_error [Libvirt.Virterror] | Creates an empty error message.
node_get_cells_free_memory [Libvirt.Connect] | `node_get_cells_free_memory conn start max` returns the amount of free memory on each NUMA cell in kilobytes.
node_get_free_memory [Libvirt.Connect] | `node_get_free_memory conn` returns the amount of free memory (not allocated to any guest) in the machine.
num_of_defined_domains [Libvirt.Connect] | Returns the number of inactive (shutdown) domains.
num_of_defined_networks [Libvirt.Connect] | Returns the number of inactive networks.
num_of_defined_pools [Libvirt.Connect] | Returns the number of storage pools.
num_of_domains [Libvirt.Connect] | Returns the number of running domains.
num_of_networks [Libvirt.Connect] | Returns the number of networks.
num_of_pools [Libvirt.Connect] | Returns the number of storage pools.
num_of_volumes [Libvirt.Pool] | Returns the number of storage volumes within the storage pool.
P
package [Libvirt_version] |
pin_vcpu [Libvirt.Domain] | `pin_vcpu dom vcpu bitmap` pins a domain vCPU to a bitmap of physical CPUs.
pool_of_volume [Libvirt.Volume] | Get the storage pool containing this volume.
R
reboot [Libvirt.Domain] | Reboot a domain.
refresh [Libvirt.Pool] | Refresh the list of volumes in the storage pool.
register_any [Libvirt.Event] | `register_any con ?dom callback` registers `callback` to receive notification of arbitrary domain events.
register_default_impl [Libvirt.Event] | Registers the default event loop based on poll().
remove_timeout [Libvirt.Event] | `remove_timeout con t` deregisters timeout callback `t`.
reset_last_conn_error [Libvirt.Virterror] | Reset the error at a global or connection level.
reset_last_error [Libvirt.Virterror] |
restore [Libvirt.Domain] | Restore a domain from a file.
resume [Libvirt.Domain] | Resume a domain.
run_default_impl [Libvirt.Event] | Runs one iteration of the event loop.
S
save [Libvirt.Domain] | Suspend a domain, then save it to the file.
set_autostart [Libvirt.Pool] | Set the autostart flag for the storage pool.
set_autostart [Libvirt.Network] | Set the autostart flag for a network.
set_autostart [Libvirt.Domain] | Set the autostart flag for a domain.
set_keep_alive [Libvirt.Connect] | `set_keep_alive conn interval count` starts sending keepalive messages after `interval` seconds of inactivity and consider the connection to be broken when no response is received after `count` keepalive messages.
set_max_memory [Libvirt.Domain] | Set the maximum memory allocation.
set_memory [Libvirt.Domain] | Set the normal memory allocation.
set_scheduler_parameters [Libvirt.Domain] | Set the array of scheduler parameters.
set_vcpus [Libvirt.Domain] | Change the number of vCPUs available to a domain.
shutdown [Libvirt.Domain] | Shutdown a domain.
string_of_code [Libvirt.Virterror] |
string_of_domain [Libvirt.Virterror] |
string_of_level [Libvirt.Virterror] |
suspend [Libvirt.Domain] | Suspend a domain.
T
to_string [Libvirt.Virterror] | Turn the exception into a printable string.
to_string [Libvirt.Event.PM_suspend_disk] |
to_string [Libvirt.Event.Balloon_change] |
to_string [Libvirt.Event.PM_suspend] |
to_string [Libvirt.Event.PM_wakeup] |
to_string [Libvirt.Event.Tray_change] |
to_string [Libvirt.Event.Disk_change] |
to_string [Libvirt.Event.Block_job] |
to_string [Libvirt.Event.Control_error] |
to_string [Libvirt.Event.Graphics] |
to_string [Libvirt.Event.Graphics_subject] |
to_string [Libvirt.Event.Graphics_address] |
to_string [Libvirt.Event.Io_error] |
to_string [Libvirt.Event.Watchdog] |
to_string [Libvirt.Event.Rtc_change] |
to_string [Libvirt.Event.Reboot] |
to_string [Libvirt.Event.Lifecycle] |
to_string [Libvirt.Event.PM_suspended] |
to_string [Libvirt.Event.Stopped] |
to_string [Libvirt.Event.Resumed] |
to_string [Libvirt.Event.Suspended] |
to_string [Libvirt.Event.Started] |
to_string [Libvirt.Event.Undefined] |
to_string [Libvirt.Event.Defined] |
U
undefine [Libvirt.Pool] | Undefine configuration of a storage pool.
undefine [Libvirt.Network] | Undefine configuration of a network.
undefine [Libvirt.Domain] | Undefine a domain - removes its configuration.
unuse_cpu [Libvirt.Connect] | `unuse_cpu cpumap cpu` marks `cpu` as not usable in `cpumap`.
use_cpu [Libvirt.Connect] | `use_cpu cpumap cpu` marks `cpu` as usable in `cpumap`.
uuid_length [Libvirt] | Length of packed UUIDs.
uuid_string_length [Libvirt] | Length of UUID strings.
V
version [Libvirt_version] | The name and version of the OCaml libvirt bindings.