Index of values

add_timeout con ms cb registers cb as a timeout callback which will be called every ms milliseconds

Attach a device (described by the device XML) to a domain.

block_peek dom path offset size buf boff reads size bytes at offset in the domain's path block device.

Returns block device stats.

Build a storage pool.

close conn closes and frees the connection object in memory.

connect ~name () connects to the hypervisor with URI name.

connect_auth ~name auth connects to the hypervisor with URI name, using auth as authentication handler.

connect_auth_readonly ~name auth connects in read-only mode to the hypervisor with URI name, using auth as authentication handler.

connect_readonly ~name () connects in read-only mode to the hypervisor with URI name.

const conn turns a read/write secret into a read-only secret.

const conn turns a read/write storage volume into a read-only volume.

const conn turns a read/write storage pool into a read-only pool.

const network turns a read/write network handle into a read-only network handle.

const dom turns a read/write domain handle into a read-only domain handle.

const conn turns a read/write connection into a read-only connection.

Force a domain to core dump to the named file.

cpu_usable cpumaps maplen vcpu cpu checks returns true iff the cpu is usable by vcpu.

Calculate the length (in bytes) required to store the complete CPU map between a single virtual and all physical CPUs of a domain.

Start up a defined (inactive) storage pool.

Start up a defined (inactive) network.

Launch a defined (inactive) domain.

Create a storage volume.

Create a storage pool.

Create a network.

Create a new guest domain from the given XML.

Define a secret.

Define but don't activate a storage pool.

Define but don't activate a network.

Define a new domain (but don't start it up) from the XML.

Delete a storage volume.

Delete a storage pool.

deregister_any con id deregisters the previously registered callback with id id.

Destroy a storage pool.

Destroy a network.

Abruptly destroy a domain.

Detach a device (described by the device XML) from a domain.

Free a secret object in memory.

Free a storage volume object in memory.

Free a storage pool object in memory.

free network frees the network object in memory.

free domain frees the domain object in memory.

get_all_domain_stats conn stats flags allows you to read all stats across multiple/all domains in a single call.

get_auth_default () returns the default authentication handler of libvirt.

Get the autostart flag for the storage pool.

Get the autostart flag for a network.

Get the autostart flag for a domain.

Get bridge device name of a network.

Returns the hypervisor capabilities (as XML).

get_pcpu_stats dom returns the physical CPU stats for a domain.

get_domain_capabilities () returns the XML with the available capabilities of the emulator or libvirt for domains.

Get the active and/or inactive domains using the most efficient method available.

This gets the active and/or inactive domains and the domain info for each one using the most efficient method available.

Returns the hostname of the physical server.

get_id dom returns the ID of the domain.

Get information about the storage volume.

Get information about the pool.

Get information about a domain.

Key of the volume.

Get the last error at a global or connection level.

Get the maximum memory allocation.

Returns the maximum number of vCPUs supported for this domain.

Returns the maximum number of virtual CPUs supported by a guest VM of a particular type.

Name of the volume.

Name of the pool.

Get network name.

Get the domain name.

Return information about the physical server.

Get the operating system type.

Path of the volume.

Get the array of scheduler parameters.

Get the scheduler type.

Returns the name of the driver (hypervisor).

Returns the canonical connection URI.

Get the usage ID of the secret.

Get the usage type of the secret.

Get the UUID (as a packed byte array) of the secret.

Get the UUID (as a packed byte array).

Get network packed UUID.

Get the domain UUID (as a packed byte array).

Get the UUID (as a printable string) of the secret.

Get the UUID (as a printable string).

Get network UUID as a printable string.

Get the domain UUID (as a printable string).

Get the value of the secret.

get_vcpus dom maxinfo maplen returns the pinning information for a domain.

Returns the driver version major * 1_000_000 + minor * 1000 + release

get_version () returns the library version in the first part of the tuple, and 0 in the second part.

Get the XML description.

Get the XML description.

Get the XML description.

Get XML description of a network.

Get the XML description of a domain.

Get the XML description of a domain, with the possibility to specify flags.

Returns network interface stats.

list_defined_domains conn max returns the names of the inactive domains, up to a maximum of max entries.

list_defined_networks conn max returns the names of the inactive networks, up to a maximum of max entries.

Return list of storage pools.

list_domains conn max returns the running domain IDs, up to a maximum of max entries.

list_networks conn max returns the names of the networks, up to a maximum of max entries.

Return list of storage pools.

Returns the list of secrets.

Return list of storage volumes.

Lookup a domain by ID.

Lookup a network by name.

Lookup a domain by name.

Look up a storage volume by name, key or path volume.

Lookup a secret by usage type, and usage ID.

Lookup a secret by UUID.

Lookup a network by (packed) UUID.

Lookup a domain by UUID.

Lookup a secret by (string) UUID.

Look up a storage pool by name, UUID or UUID string.

Lookup a network by UUID string.

Lookup a domain by (string) UUID.

map_ignore_errors f xs calls function f for each element of xs.

Maximum size supported by the Libvirt.Domain.block_peek and Libvirt.Domain.memory_peek functions.

Calculate the total number of CPUs supported (but not necessarily active) in the host.

memory_peek dom Virtual offset size reads size bytes at offset in the domain's virtual memory.

migrate dom dconn flags () migrates a domain to a destination host described by dconn.

Creates an empty error message.

node_get_cells_free_memory conn start max returns the amount of free memory on each NUMA cell in kilobytes.

node_get_free_memory conn returns the amount of free memory (not allocated to any guest) in the machine.

Returns the number of inactive (shutdown) domains.

Returns the number of inactive networks.

Returns the number of storage pools.

Returns the number of running domains.

Returns the number of networks.

Returns the number of storage pools.

Returns the number of secrets.

Returns the number of storage volumes within the storage pool.

The name of the OCaml libvirt bindings.

pin_vcpu dom vcpu bitmap pins a domain vCPU to a bitmap of physical CPUs.

Get the storage pool containing this volume.

Reboot a domain.

Refresh the list of volumes in the storage pool.

register_any con ?dom callback registers callback to receive notification of arbitrary domain events.

Registers the default event loop based on poll().

remove_timeout con t deregisters timeout callback t.

Reset the error at a global or connection level.

Restore a domain from a file.

Resume a domain.

Runs one iteration of the event loop.

Suspend a domain, then save it to the file.

Set the autostart flag for the storage pool.

Set the autostart flag for a network.

Set the autostart flag for a domain.

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 the maximum memory allocation.

Set the normal memory allocation.

Set the array of scheduler parameters.

Set a new value for the secret.

Change the number of vCPUs available to a domain.

Shutdown a domain.

Suspend a domain.

Turn the exception into a printable string.

Undefine a secret.

Undefine configuration of a storage pool.

Undefine configuration of a network.

Undefine a domain - removes its configuration.

unuse_cpu cpumap cpu marks cpu as not usable in cpumap.

use_cpu cpumap cpu marks cpu as usable in cpumap.

Length of packed UUIDs.

Length of UUID strings.

The version of the OCaml libvirt bindings.