README

ruby-libvirt
============

Ruby bindings for libvirt (http://libvirt.org)

Usage
-----

In your ruby code, do a "require 'libvirt'"; to obtain a connection, use
'Libvirt::open' or 'Libvirt::open_read_only'. See tests/*.rb for more
examples.

Hacking
-------

On a Fedora machine, run
  yum install libvirt-devel ruby-devel rubygem-rake
and then
  rake build
  rake test

To run against the checkout, make sure you set RUBYLIB (assuming DIR is the
toplevel of your source checkout):

  export RUBYLIB=$dir/lib:$dir/ext/libvirt
  ruby -rlibvirt -e 'puts Libvirt::version[0]'

Notes
-----
As of June 24, 2011, the ruby-libvirt bindings support all of the libvirt
APIs up to libvirt commit hash 508de7eedb347b7369b97e1e08e6d30be590d80a
with the following exceptions:

- virConnectRef
- virDomainGetConnect
- virDomainRef
- virDomainOpenConsole
- virNetworkGetConnect
- virNetworkRef
- virInterfaceGetConnect
- virInterfaceRef
- virStoragePoolGetConnect
- virStoragePoolRef
- virStorageVolGetConnect
- virStorageVolRef
- virNodeDeviceRef
- virSecretGetConnect
- virSecretRef
- virStreamRef
- virNWFilterRef
- virEventRegisterDefaultImpl
- virEventRunDefaultImpl
- virDomainRestoreFlags
- virDomainGetControlInfo
- virDomainBlockStatsFlags
- VIR_DOMAIN_UNDEFINE_MANAGED_SAVE
- VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA
- virDomainUndefineFlags
- virDomainPinVcpuFlags
- virDomainGetVcpuPinInfo
- virDomainBlockJobAbort
- virDomainGetBlockJobInfo
- virDomainBlockJobSetSpeed
- virDomainBlockPull
- virDomainSendKey
- virEventAddHandle
- virEventUpdateHandle
- virEventRemoveHandle
- virEventAddTimeout
- virEventUpdateTimeout
- virEventRemoveTimeout