The C# libvirt bindings are a class library. They use a Microsoft Visual Studio project architecture, and have been tested with Windows .NET, and Mono, on both Linux and Windows.
Compiling them produces LibvirtBindings.dll, which can be added as a .NET reference to any .NET project needing access to libvirt.
These bindings depend upon the libvirt libraries being installed. In the .NET case, this is libvirt-0.dll, produced from compiling libvirt for windows.
The C# bindings source code is maintained in a git repository available on libvirt.org:
git clone git://libvirt.org/libvirt-csharp.git
They can also be browsed online:
http://libvirt.org/git/?p=libvirt-csharp.git;a=summary
The class library exposes the LibvirtBindings namespace. This namespace exposes all of the needed types (enum, struct), and 2 main classes, libVirt and libvirtError.
The libVirt class exposes all of the interfaces of the libvirt library for handling virtualized domains.
The libvirtError class exposes all of the interfaces of the libvirt library for handling errors raised while using the library.
The C# bindings are the work of Arnaud Champion <arnaud.champion AT devatom.fr>, based upon the previous work of Jaromír Červenka.
Windows testing is performed on Windows 7, with .NET 4, Visual Studio 2010, and MonoDevelop 2.4.
Linux testing is performed on Fedora 13 i686, with MonoDevelop 2.2.
Coverage of the libvirt types is:
| Type | Name | Binding? | Tested? | Sample Code? | Works? | Tested .Net/Windows Works? | Tested Mono/Windows Works? | Tested Mono/Linux Works? |
|---|---|---|---|---|---|---|---|---|
| enum | virCPUCompareResult | No | ||||||
| struct | virConnect | Yes, an IntPtr as the struct is not public | Yes | Yes | ||||
| struct | virConnectAuth | Yes | Yes | virConnectOpenAuth | Yes | Yes | Yes | Yes |
| struct | virConnectCredential | Yes | Yes | virConnectOpenAuth | Yes | Yes | Yes | Yes |
| enum | virConnectCredentialType | Yes | Yes | virConnectOpenAuth | Yes | Yes | Yes | Yes |
| enum | virConnectFlags | No | ||||||
| struct | virDomain | Yes, an IntPtr as the struct is not public | ||||||
| struct | virDomainBlockInfo | No | ||||||
| struct | virDomainBlockStatsInfo | No | ||||||
| enum | virDomainCoreDumpFlags | No | ||||||
| enum | virDomainCreateFlags | No | ||||||
| enum | virDomainDeviceModifyFlags | No | ||||||
| enum | virDomainEventDefinedDetailType | Yes | Yes | Yes | ||||
| struct | virDomainEventGraphicsAddress | No | ||||||
| enum | virDomainEventGraphicsAddressType | No | ||||||
| enum | virDomainEventGraphicsPhase | No | ||||||
| struct | virDomainEventGraphicsSubject | No | ||||||
| struct | virDomainEventGraphicsSubjectIdentity | No | ||||||
| enum | virDomainEventID | No | ||||||
| enum | virDomainEventIOErrorAction | No | ||||||
| enum | virDomainEventResumedDetailType | Yes | Yes | Yes | ||||
| enum | virDomainEventStartedDetailType | Yes | Yes | Yes | ||||
| enum | virDomainEventStoppedDetailType | Yes | Yes | Yes | ||||
| enum | virDomainEventSuspendedDetailType | Yes | Yes | Yes | ||||
| enum | virDomainEventType | Yes | Yes | Yes | ||||
| enum | virDomainEventUndefinedDetailType | Yes | Yes | Yes | ||||
| enum | virDomainEventWatchdogAction | No | ||||||
| struct | virDomainInfo | Yes | Yes | Yes | ||||
| struct | virDomainInterfaceStatsStruct | Yes | No | Maybe | ||||
| struct | virDomainJobInfo | No | ||||||
| enum | virDomainJobType | No | ||||||
| enum | virDomainMemoryFlags | No | ||||||
| struct | virDomainMemoryStatStruct | No | ||||||
| enum | virDomainMemoryStatTags | Yes | No | Maybe | ||||
| enum | virDomainMigrateFlags | No | ||||||
| struct | virDomainSnapshot | No | ||||||
| enum | virDomainSnapshotDeleteFlags | |||||||
| enum | virDomainState | Yes | Yes | Yes | ||||
| enum | virDomainXMLFlags | Yes | Yes | Yes | ||||
| enum | virEventHandleType | Yes | Yes | Yes | ||||
| struct | virInterface | Yes, an IntPtr as the struct is not public | ||||||
| enum | virInterfaceXMLFlags | No | ||||||
| struct | virNWFilter | No | ||||||
| struct | virNetwork | Yes, an IntPtr as the struct is not public | ||||||
| struct | virNodeDevice | Yes, an IntPtr as the struct is not public | ||||||
| struct | virNodeInfo | Yes | No | Maybe | ||||
| struct | virSchedParameter | No | ||||||
| enum | virSchedParameterType | No | ||||||
| struct | virSecret | No | ||||||
| enum | virSecretUsageType | No | ||||||
| struct | virSecurityLabel | No | ||||||
| struct | virSecurityModel | No | ||||||
| struct | virStoragePool | Yes, an IntPtr as the struct is not public | ||||||
| enum | virStoragePoolBuildFlags | Yes | No | Maybe | ||||
| enum | virStoragePoolDeleteFlags | Yes | No | Maybe | ||||
| struct | virStoragePoolInfo | Yes | Yes | Yes | ||||
| enum | virStoragePoolState | Yes | Yes | Yes | ||||
| struct | virStorageVol | Yes, an IntPtr as the struct is not public | ||||||
| enum | virStorageVolDeleteFlags | No | ||||||
| struct | virStorageVolInfo | Yes | Yes | Yes | ||||
| enum | virStorageVolType | Yes | Yes | Yes | ||||
| struct | virStream | No | ||||||
| enum | virStreamEventType | No | ||||||
| enum | virStreamFlags | No | ||||||
| struct | virVcpuInfo | No | ||||||
| enum | virVcpuState | No |
Coverage of the libvirt functions is:
| Name | Binding? | Type? | Tested? | Sample Code? | Working? | Tested .Net/Windows Works? | Tested Mono/Windows Works? | Tested Mono/Linux Works? |
|---|---|---|---|---|---|---|---|---|
| virConnectAuthCallbackPtr | Yes | delegate | Yes | virConnectOpenAuth | Yes | Yes | Yes | |
| virConnectBaselineCPU | No | function | ||||||
| virConnectClose | Yes | function | Yes | virConnectOpenAuth | Yes | Yes | Yes | |
| virConnectCompareCPU | No | function | ||||||
| virConnectDomainEventCallback | Yes | delegate | Yes | Yes | ||||
| virConnectDomainEventDeregister | No | function | ||||||
| virConnectDomainEventDeregisterAny | No | function | ||||||
| virConnectDomainEventGenericCallback | No | delegate | ||||||
| virConnectDomainEventGraphicsCallback | No | delegate | ||||||
| virConnectDomainEventIOErrorCallback | No | delegate | ||||||
| virConnectDomainEventIOErrorReasonCallback | No | delegate | ||||||
| virConnectDomainEventRTCChangeCallback | No | delegate | ||||||
| virConnectDomainEventRegister | Yes | function | Yes | Yes | ||||
| virConnectDomainEventRegisterAny | No | function | ||||||
| virConnectDomainEventWatchdogCallback | No | delegate | ||||||
| virConnectDomainXMLFromNative | No | function | ||||||
| virConnectDomainXMLToNative | No | function | ||||||
| virConnectFindStoragePoolSources | No | function | ||||||
| virConnectGetCapabilities | Yes | function | Yes | Yes | ||||
| virConnectGetHostname | Yes | function | Yes | |||||
| virConnectGetLibVersion | Yes | function | No | Maybe | ||||
| virConnectGetMaxVcpus | Yes | function | No | Maybe | ||||
| virConnectGetType | Yes | function | No | Maybe | ||||
| virConnectGetURI | Yes | function | Yes | Yes | ||||
| virConnectGetVersion | Yes | function | No | Maybe | ||||
| virConnectIsEncrypted | Yes | function | No | Maybe | ||||
| virConnectIsSecure | Yes | function | No | Maybe | ||||
| virConnectListDefinedDomains | Yes | function | Yes | virConnectOpenAuth | Yes | Yes | Yes | Yes |
| virConnectListDefinedInterfaces | Yes | function | Yes | Yes | ||||
| virConnectListDefinedNetworks | Yes | function | Yes | Yes | ||||
| virConnectListDefinedStoragePools | Yes | function | Yes | Yes | ||||
| virConnectListDomains | Yes | function | Yes | virConnectOpenAuth | Yes | Yes | Yes | Yes |
| virConnectListInterfaces | Yes | function | Yes | Yes, if the host handles the method | ||||
| virConnectListNWFilters | No | function | ||||||
| virConnectListNetworks | Yes | function | Yes | Yes | ||||
| virConnectListSecrets | Yes | function | No | Maybe | ||||
| virConnectListStoragePools | Yes | function | Yes | Yes | ||||
| virConnectNumOfDefinedDomains | Yes | function | Yes | virConnectOpenAuth | Yes | Yes | Yes | Yes |
| virConnectNumOfDefinedInterfaces | Yes | function | No | Maybe | ||||
| virConnectNumOfDefinedNetworks | Yes | function | Yes | Yes | ||||
| virConnectNumOfDefinedStoragePools | Yes | function | Yes | Yes | ||||
| virConnectNumOfDomains | Yes | function | Yes | virConnectOpenAuth | Yes | Yes | Yes | Yes |
| virConnectNumOfInterfaces | Yes | function | No | Maybe | ||||
| virConnectNumOfNWFilters | No | function | ||||||
| virConnectNumOfNetworks | Yes | function | Yes | Yes | ||||
| virConnectNumOfSecrets | Yes | function | No | Maybe | ||||
| virConnectNumOfStoragePools | Yes | function | Yes | Yes | ||||
| virConnectOpen | Yes | function | Yes | Yes | ||||
| virConnectOpenAuth | Yes | function | Yes | virConnectOpenAuth | Yes | Yes | Yes | Yes |
| virConnectOpenReadOnly | Yes | function | No | Maybe | ||||
| virConnectRef | Yes | function | No | Maybe | ||||
| virDomainAbortJob | No | function | ||||||
| virDomainAttachDevice | Yes | function | No | Maybe | ||||
| virDomainAttachDeviceFlags | Yes | function | No | Maybe | ||||
| virDomainBlockPeek | No | function | ||||||
| virDomainBlockStats | Yes | function | No | Maybe | ||||
| virDomainCoreDump | Yes | function | No | Maybe | ||||
| virDomainCreate | Yes | function | Yes | Yes | ||||
| virDomainCreateLinux | No | function | ||||||
| virDomainCreateWithFlags | No | function | ||||||
| virDomainCreateXML | Yes | function | No | Maybe | ||||
| virDomainDefineXML | Yes | function | Yes | Yes | ||||
| virDomainDestroy | Yes | function | Yes | Yes | ||||
| virDomainDetachDevice | Yes | function | No | Maybe | ||||
| virDomainDetachDeviceFlags | Yes | function | No | Maybe | ||||
| virDomainFree | Yes | function | Yes | Yes | ||||
| virDomainGetAutostart | Yes | function | No | Maybe | ||||
| virDomainGetBlockInfo | No | function | ||||||
| virDomainGetConnect | Yes | function | No | Maybe | ||||
| virDomainGetID | Yes | function | No | Maybe | ||||
| virDomainGetInfo | Yes | function | Yes | Yes | ||||
| virDomainGetJobInfo | No | function | ||||||
| virDomainGetMaxMemory | Yes | function | No | Maybe | ||||
| virDomainGetMaxVcpus | Yes | function | No | Maybe | ||||
| virDomainGetName | Yes | function | Yes | virConnectOpenAuth | Yes | Yes | Yes | Yes |
| virDomainGetOSType | Yes | function | No | Maybe | ||||
| virDomainGetSchedulerParameters | No | function | ||||||
| virDomainGetSchedulerType | No | function | ||||||
| virDomainGetSecurityLabel | No | function | ||||||
| virDomainGetUUID | Yes | function | No | Maybe | ||||
| virDomainGetUUIDString | Yes | function | No | Maybe | ||||
| virDomainGetVcpus | No | function | ||||||
| virDomainGetXMLDesc | Yes | function | Yes | Yes | ||||
| virDomainHasCurrentSnapshot | No | function | ||||||
| virDomainHasManagedSaveImage | No | function | ||||||
| virDomainInterfaceStats | No | function | ||||||
| virDomainIsActive | Yes | function | Yes | Yes | ||||
| virDomainIsPersistent | Yes | function | No | Maybe | ||||
| virDomainLookupByID | Yes | function | Yes | virConnectOpenAuth | Yes | Yes | Yes | Yes |
| virDomainLookupByName | Yes | function | Yes | Yes | ||||
| virDomainLookupByUUID | Yes | function | No | Maybe | ||||
| virDomainLookupByUUIDString | Yes | function | No | Maybe | ||||
| virDomainManagedSave | No | function | ||||||
| virDomainManagedSaveRemove | No | function | ||||||
| virDomainMemoryPeek | No | function | ||||||
| virDomainMemoryStats | No | function | ||||||
| virDomainMigrate | No | function | ||||||
| virDomainMigrateSetMaxDowntime | No | function | ||||||
| virDomainMigrateToURI | No | function | ||||||
| virDomainPinVcpu | No | function | ||||||
| virDomainReboot | Yes | function | Yes | Yes | ||||
| virDomainRef | Yes | function | No | Maybe | ||||
| virDomainRestore | Yes | function | No | Maybe | ||||
| virDomainResume | Yes | function | Yes | Yes | ||||
| virDomainRevertToSnapshot | No | function | ||||||
| virDomainSave | Yes | function | No | Maybe | ||||
| virDomainSetAutostart | Yes | function | No | Maybe | ||||
| virDomainSetMaxMemory | Yes | function | No | Maybe | ||||
| virDomainSetMemory | Yes | function | No | Maybe | ||||
| virDomainSetSchedulerParameters | No | function | ||||||
| virDomainSetVcpus | Yes | function | No | Maybe | ||||
| virDomainShutdown | Yes | function | Yes | Yes | ||||
| virDomainSnapshotCreateXML | No | function | ||||||
| virDomainSnapshotCurrent | No | function | ||||||
| virDomainSnapshotDelete | No | function | ||||||
| virDomainSnapshotFree | No | function | ||||||
| virDomainSnapshotGetXMLDesc | No | function | ||||||
| virDomainSnapshotListNames | No | function | ||||||
| virDomainSnapshotLookupByName | No | function | ||||||
| virDomainSnapshotNum | No | function | ||||||
| virDomainSuspend | Yes | function | Yes | Yes | ||||
| virDomainUndefine | Yes | function | Yes | Yes | ||||
| virDomainUpdateDeviceFlags | No | function | ||||||
| virEventAddHandleFunc | Yes | delegate | Yes | Yes | ||||
| virEventAddTimeoutFunc | Yes | delegate | Yes | Yes | ||||
| virEventHandleCallback | Yes | delegate | Yes | Yes | ||||
| virEventRegisterImpl | Yes | function | Yes | Yes | ||||
| virEventRemoveHandleFunc | Yes | delegate | Yes | Yes | ||||
| virEventRemoveTimeoutFunc | Yes | delegate | Yes | Yes | ||||
| virEventTimeoutCallback | Yes | delegate | Yes | Yes | ||||
| virEventUpdateHandleFunc | Yes | delegate | Yes | Yes | ||||
| virEventUpdateTimeoutFunc | Yes | delegate | Yes | Yes | ||||
| virFreeCallback | Yes | function | Yes | Yes | ||||
| virGetVersion | Yes | function | Yes | Yes | ||||
| virInitialize | Yes | function | Yes | Yes | ||||
| virInterfaceCreate | No | function | ||||||
| virInterfaceDefineXML | No | function | ||||||
| virInterfaceDestroy | No | function | ||||||
| virInterfaceFree | No | function | ||||||
| virInterfaceGetConnect | No | function | ||||||
| virInterfaceGetMACString | No | function | ||||||
| virInterfaceGetName | No | function | ||||||
| virInterfaceGetXMLDesc | No | function | ||||||
| virInterfaceIsActive | No | function | ||||||
| virInterfaceLookupByMACString | No | function | ||||||
| virInterfaceLookupByName | No | function | ||||||
| virInterfaceRef | No | function | ||||||
| virInterfaceUndefine | No | function | ||||||
| virNWFilterDefineXML | No | function | ||||||
| virNWFilterFree | No | function | ||||||
| virNWFilterGetName | No | function | ||||||
| virNWFilterGetUUID | No | function | ||||||
| virNWFilterGetUUIDString | No | function | ||||||
| virNWFilterGetXMLDesc | No | function | ||||||
| virNWFilterLookupByName | No | function | ||||||
| virNWFilterLookupByUUID | No | function | ||||||
| virNWFilterLookupByUUIDString | No | function | ||||||
| virNWFilterRef | No | function | ||||||
| virNWFilterUndefine | No | function | ||||||
| virNetworkCreate | Yes | function | Yes | Yes | ||||
| virNetworkCreateXML | Yes | function | No | Maybe | ||||
| virNetworkDefineXML | Yes | function | Yes | Yes | ||||
| virNetworkDestroy | Yes | function | Yes | Yes | ||||
| virNetworkFree | Yes | function | Yes | Yes | ||||
| virNetworkGetAutostart | Yes | function | No | Maybe | ||||
| virNetworkGetBridgeName | Yes | function | No | Maybe | ||||
| virNetworkGetConnect | Yes | function | No | Maybe | ||||
| virNetworkGetName | Yes | function | No | Maybe | ||||
| virNetworkGetUUID | No | function | ||||||
| virNetworkGetUUIDString | Yes | function | Yes | Yes | ||||
| virNetworkGetXMLDesc | Yes | function | Yes | Yes | ||||
| virNetworkIsActive | Yes | function | Yes | Yes | ||||
| virNetworkIsPersistent | Yes | function | Yes | Yes | ||||
| virNetworkLookupByName | Yes | function | Yes | Yes | ||||
| virNetworkLookupByUUID | Yes | function | No | Maybe | ||||
| virNetworkLookupByUUIDString | Yes | function | No | Maybe | ||||
| virNetworkRef | Yes | function | No | Maybe | ||||
| virNetworkSetAutostart | Yes | function | Yes | Yes | ||||
| virNetworkUndefine | Yes | function | Yes | Yes | ||||
| virNodeDeviceCreateXML | No | function | ||||||
| virNodeDeviceDestroy | No | function | ||||||
| virNodeDeviceDettach | No | function | ||||||
| virNodeDeviceFree | No | function | ||||||
| virNodeDeviceGetName | No | function | ||||||
| virNodeDeviceGetParent | No | function | ||||||
| virNodeDeviceGetXMLDesc | Yes | function | Yes | Yes | ||||
| virNodeDeviceListCaps | No | function | ||||||
| virNodeDeviceLookupByName | Yes | function | Yes | Yes | ||||
| virNodeDeviceNumOfCaps | No | function | ||||||
| virNodeDeviceReAttach | No | function | ||||||
| virNodeDeviceRef | No | function | ||||||
| virNodeDeviceReset | No | function | ||||||
| virNodeGetCellsFreeMemory | No | function | ||||||
| virNodeGetFreeMemory | Yes | function | No | Maybe | ||||
| virNodeGetInfo | Yes | function | No | Maybe | ||||
| virNodeGetSecurityModel | No | function | ||||||
| virNodeListDevices | Yes | function | Yes | Yes | ||||
| virNodeNumOfDevices | Yes | function | Yes | Yes | ||||
| virSecretDefineXML | No | function | ||||||
| virSecretFree | No | function | ||||||
| virSecretGetConnect | No | function | ||||||
| virSecretGetUUID | No | function | ||||||
| virSecretGetUUIDString | No | function | ||||||
| virSecretGetUsageID | No | function | ||||||
| virSecretGetUsageType | No | function | ||||||
| virSecretGetValue | No | function | ||||||
| virSecretGetXMLDesc | No | function | ||||||
| virSecretLookupByUUID | No | function | ||||||
| virSecretLookupByUUIDString | No | function | ||||||
| virSecretLookupByUsage | No | function | ||||||
| virSecretRef | No | function | ||||||
| virSecretSetValue | No | function | ||||||
| virSecretUndefine | No | function | ||||||
| virStoragePoolBuild | Yes | function | No | Maybe | ||||
| virStoragePoolCreate | Yes | function | Yes | Yes | ||||
| virStoragePoolCreateXML | Yes | function | No | Maybe | ||||
| virStoragePoolDefineXML | Yes | function | Yes | Yes | ||||
| virStoragePoolDelete | Yes | function | No | Maybe | ||||
| virStoragePoolDestroy | Yes | function | Yes | Yes | ||||
| virStoragePoolFree | Yes | function | Yes | Yes | ||||
| virStoragePoolGetAutostart | Yes | function | No | Maybe | ||||
| virStoragePoolGetConnect | Yes | function | No | Maybe | ||||
| virStoragePoolGetInfo | Yes | function | Yes | Yes | ||||
| virStoragePoolGetName | Yes | function | Yes | Yes | ||||
| virStoragePoolGetUUID | Yes | function | No | Maybe | ||||
| virStoragePoolGetUUIDString | Yes | function | Yes | Yes | ||||
| virStoragePoolGetXMLDesc | Yes | function | Yes | Yes | ||||
| virStoragePoolIsActive | Yes | function | Yes | Yes | ||||
| virStoragePoolIsPersistent | Yes | function | Yes | Yes | ||||
| virStoragePoolListVolumes | Yes | function | Yes | Yes | ||||
| virStoragePoolLookupByName | Yes | function | Yes | Yes | ||||
| virStoragePoolLookupByUUID | Yes | function | No | Maybe | ||||
| virStoragePoolLookupByUUIDString | Yes | function | No | Maybe | ||||
| virStoragePoolLookupByVolume | Yes | function | No | Maybe | ||||
| virStoragePoolNumOfVolumes | Yes | function | Yes | Yes | ||||
| virStoragePoolRef | Yes | function | No | Maybe | ||||
| virStoragePoolRefresh | Yes | function | No | Maybe | ||||
| virStoragePoolSetAutostart | Yes | function | Yes | Yes | ||||
| virStoragePoolUndefine | Yes | function | Yes | Yes | ||||
| virStorageVolCreateXML | Yes | function | Yes | Yes | ||||
| virStorageVolCreateXMLFrom | Yes | function | No | Maybe | ||||
| virStorageVolDelete | Yes | function | Yes | Yes | ||||
| virStorageVolFree | Yes | function | No | Maybe | ||||
| virStorageVolGetConnect | Yes | function | No | Maybe | ||||
| virStorageVolGetInfo | Yes | function | Yes | Yes | ||||
| virStorageVolGetKey | Yes | function | Yes | Yes | ||||
| virStorageVolGetName | Yes | function | Yes | Yes | ||||
| virStorageVolGetPath | Yes | function | Yes | Yes | ||||
| virStorageVolGetXMLDesc | Yes | function | Yes | Yes | ||||
| virStorageVolLookupByKey | Yes | function | Yes | Yes | ||||
| virStorageVolLookupByName | Yes | function | Yes | Yes | ||||
| virStorageVolLookupByPath | Yes | function | Yes | Yes | ||||
| virStorageVolRef | Yes | function | No | No | ||||
| virStorageVolWipe | No | function | ||||||
| virStreamAbort | No | function | ||||||
| virStreamEventAddCallback | No | function | ||||||
| virStreamEventCallback | No | delegate | ||||||
| virStreamEventRemoveCallback | No | function | ||||||
| virStreamEventUpdateCallback | No | function | ||||||
| virStreamFinish | No | function | ||||||
| virStreamFree | No | function | ||||||
| virStreamNew | No | function | ||||||
| virStreamRecv | No | function | ||||||
| virStreamRecvAll | No | function | ||||||
| virStreamRef | No | function | ||||||
| virStreamSend | No | function | ||||||
| virStreamSendAll | No | function | ||||||
| virStreamSinkFunc | No | delegate | ||||||
| virStreamSourceFunc | No | delegate |