libvirt-api.xml 117.0 KB
Newer Older
1
<?xml version="1.0" encoding="ISO-8859-1"?>
D
Daniel Veillard 已提交
2
<api name='libvirt'>
3
  <files>
4 5
    <file name='libvirt'>
     <summary>core interfaces for the libvirt library</summary>
6
     <description>Provides the interfaces of the libvirt library to handle virtualized domains </description>
7
     <author>Daniel Veillard &lt;veillard@redhat.com&gt; </author>
8
     <exports symbol='VIR_NODEINFO_MAXCPUS' type='macro'/>
9
     <exports symbol='LIBVIR_VERSION_NUMBER' type='macro'/>
10 11
     <exports symbol='VIR_USE_CPU' type='macro'/>
     <exports symbol='VIR_CPU_MAPLEN' type='macro'/>
12
     <exports symbol='VIR_UUID_BUFLEN' type='macro'/>
13 14
     <exports symbol='VIR_CPU_USABLE' type='macro'/>
     <exports symbol='VIR_COPY_CPUMAP' type='macro'/>
15
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_LENGTH' type='macro'/>
16
     <exports symbol='VIR_UUID_STRING_BUFLEN' type='macro'/>
17 18
     <exports symbol='VIR_GET_CPUMAP' type='macro'/>
     <exports symbol='VIR_UNUSE_CPU' type='macro'/>
19
     <exports symbol='VIR_STORAGE_POOL_BUILD_REPAIR' type='enum'/>
20 21 22
     <exports symbol='VIR_CRED_EXTERNAL' type='enum'/>
     <exports symbol='VIR_DOMAIN_SHUTDOWN' type='enum'/>
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_UINT' type='enum'/>
23
     <exports symbol='VIR_STORAGE_POOL_BUILDING' type='enum'/>
24 25
     <exports symbol='VIR_CRED_CNONCE' type='enum'/>
     <exports symbol='VIR_CRED_ECHOPROMPT' type='enum'/>
26
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_DOUBLE' type='enum'/>
27 28 29
     <exports symbol='VIR_STORAGE_VOL_BLOCK' type='enum'/>
     <exports symbol='VIR_STORAGE_POOL_RUNNING' type='enum'/>
     <exports symbol='VIR_STORAGE_POOL_BUILD_RESIZE' type='enum'/>
30 31 32 33 34
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_LLONG' type='enum'/>
     <exports symbol='VIR_CONNECT_RO' type='enum'/>
     <exports symbol='VIR_CRED_AUTHNAME' type='enum'/>
     <exports symbol='VIR_CRED_LANGUAGE' type='enum'/>
     <exports symbol='VIR_CRED_NOECHOPROMPT' type='enum'/>
35
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_BOOLEAN' type='enum'/>
36
     <exports symbol='VIR_MIGRATE_LIVE' type='enum'/>
37 38
     <exports symbol='VIR_CRED_USERNAME' type='enum'/>
     <exports symbol='VIR_VCPU_OFFLINE' type='enum'/>
39
     <exports symbol='VIR_MEMORY_VIRTUAL' type='enum'/>
40 41 42
     <exports symbol='VIR_DOMAIN_RUNNING' type='enum'/>
     <exports symbol='VIR_DOMAIN_BLOCKED' type='enum'/>
     <exports symbol='VIR_DOMAIN_SHUTOFF' type='enum'/>
43
     <exports symbol='VIR_STORAGE_POOL_BUILD_NEW' type='enum'/>
44
     <exports symbol='VIR_VCPU_BLOCKED' type='enum'/>
45 46
     <exports symbol='VIR_STORAGE_POOL_DELETE_NORMAL' type='enum'/>
     <exports symbol='VIR_STORAGE_VOL_DELETE_ZEROED' type='enum'/>
47
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_INT' type='enum'/>
48 49
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_ULLONG' type='enum'/>
     <exports symbol='VIR_CRED_REALM' type='enum'/>
50
     <exports symbol='VIR_STORAGE_VOL_FILE' type='enum'/>
51
     <exports symbol='VIR_VCPU_RUNNING' type='enum'/>
52
     <exports symbol='VIR_DOMAIN_PAUSED' type='enum'/>
53
     <exports symbol='VIR_STORAGE_POOL_DEGRADED' type='enum'/>
54
     <exports symbol='VIR_DOMAIN_CRASHED' type='enum'/>
55
     <exports symbol='VIR_DOMAIN_XML_INACTIVE' type='enum'/>
56
     <exports symbol='VIR_DOMAIN_NONE' type='enum'/>
57
     <exports symbol='VIR_DOMAIN_NOSTATE' type='enum'/>
58
     <exports symbol='VIR_CRED_PASSPHRASE' type='enum'/>
59 60
     <exports symbol='VIR_STORAGE_VOL_DELETE_NORMAL' type='enum'/>
     <exports symbol='VIR_STORAGE_POOL_DELETE_ZEROED' type='enum'/>
61
     <exports symbol='VIR_DOMAIN_XML_SECURE' type='enum'/>
62
     <exports symbol='VIR_STORAGE_POOL_INACTIVE' type='enum'/>
63
     <exports symbol='virDomainBlockStatsStruct' type='typedef'/>
64
     <exports symbol='virDomainMigrateFlags' type='typedef'/>
65 66
     <exports symbol='virNodeInfo' type='typedef'/>
     <exports symbol='virNetwork' type='typedef'/>
67 68 69 70
     <exports symbol='virDomainBlockStatsPtr' type='typedef'/>
     <exports symbol='virConnect' type='typedef'/>
     <exports symbol='virVcpuInfo' type='typedef'/>
     <exports symbol='virDomainInfo' type='typedef'/>
71 72 73
     <exports symbol='virStoragePoolDeleteFlags' type='typedef'/>
     <exports symbol='virStoragePool' type='typedef'/>
     <exports symbol='virStoragePoolPtr' type='typedef'/>
74
     <exports symbol='virDomainInterfaceStatsStruct' type='typedef'/>
75
     <exports symbol='virStoragePoolInfo' type='typedef'/>
76 77
     <exports symbol='virDomainState' type='typedef'/>
     <exports symbol='virDomain' type='typedef'/>
78
     <exports symbol='virDomainInterfaceStatsPtr' type='typedef'/>
79
     <exports symbol='virConnectAuthPtr' type='typedef'/>
80
     <exports symbol='virStorageVolInfo' type='typedef'/>
81
     <exports symbol='virSchedParameterType' type='typedef'/>
82
     <exports symbol='virConnectCredentialPtr' type='typedef'/>
83 84 85 86
     <exports symbol='virNodeInfoPtr' type='typedef'/>
     <exports symbol='virNetworkPtr' type='typedef'/>
     <exports symbol='virDomainInfoPtr' type='typedef'/>
     <exports symbol='virConnectPtr' type='typedef'/>
87 88
     <exports symbol='virStorageVol' type='typedef'/>
     <exports symbol='virStorageVolInfoPtr' type='typedef'/>
89
     <exports symbol='virSchedParameter' type='typedef'/>
90
     <exports symbol='virConnectFlags' type='typedef'/>
91
     <exports symbol='virDomainMemoryFlags' type='typedef'/>
92
     <exports symbol='virStorageVolPtr' type='typedef'/>
93
     <exports symbol='virVcpuState' type='typedef'/>
94
     <exports symbol='virStorageVolDeleteFlags' type='typedef'/>
95
     <exports symbol='virSchedParameterPtr' type='typedef'/>
96 97
     <exports symbol='virConnectAuth' type='typedef'/>
     <exports symbol='virConnectCredential' type='typedef'/>
98
     <exports symbol='virVcpuInfoPtr' type='typedef'/>
99
     <exports symbol='virStoragePoolBuildFlags' type='typedef'/>
100
     <exports symbol='virDomainXMLFlags' type='typedef'/>
101
     <exports symbol='virStorageVolType' type='typedef'/>
102
     <exports symbol='virDomainPtr' type='typedef'/>
103
     <exports symbol='virConnectCredentialType' type='typedef'/>
104 105
     <exports symbol='virStoragePoolState' type='typedef'/>
     <exports symbol='virStoragePoolInfoPtr' type='typedef'/>
106
     <exports symbol='virDomainCreateFlags' type='typedef'/>
107
     <exports symbol='_virDomainInfo' type='struct'/>
108
     <exports symbol='_virConnectAuth' type='struct'/>
109
     <exports symbol='_virVcpuInfo' type='struct'/>
110
     <exports symbol='_virDomainInterfaceStats' type='struct'/>
111
     <exports symbol='_virStoragePoolInfo' type='struct'/>
112
     <exports symbol='_virConnectCredential' type='struct'/>
113
     <exports symbol='_virStorageVolInfo' type='struct'/>
114 115
     <exports symbol='_virDomainBlockStats' type='struct'/>
     <exports symbol='_virNodeInfo' type='struct'/>
116 117
     <exports symbol='_virSchedParameter' type='struct'/>
     <exports symbol='virConnectAuthPtrDefault' type='variable'/>
118 119 120
     <exports symbol='virStoragePoolGetXMLDesc' type='function'/>
     <exports symbol='virStorageVolGetKey' type='function'/>
     <exports symbol='virConnectClose' type='function'/>
121 122
     <exports symbol='virDomainDefineXML' type='function'/>
     <exports symbol='virDomainShutdown' type='function'/>
123
     <exports symbol='virConnectListStoragePools' type='function'/>
124
     <exports symbol='virGetVersion' type='function'/>
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
     <exports symbol='virNodeGetCellsFreeMemory' type='function'/>
     <exports symbol='virStoragePoolSetAutostart' type='function'/>
     <exports symbol='virStorageVolCreateXML' type='function'/>
     <exports symbol='virDomainGetSchedulerParameters' type='function'/>
     <exports symbol='virDomainLookupByUUIDString' type='function'/>
     <exports symbol='virConnectNumOfDefinedNetworks' type='function'/>
     <exports symbol='virConnectNumOfDomains' type='function'/>
     <exports symbol='virNetworkGetUUID' type='function'/>
     <exports symbol='virStoragePoolGetConnect' type='function'/>
     <exports symbol='virConnectGetVersion' type='function'/>
     <exports symbol='virDomainFree' type='function'/>
     <exports symbol='virStoragePoolGetName' type='function'/>
     <exports symbol='virDomainSetAutostart' type='function'/>
     <exports symbol='virStoragePoolDefineXML' type='function'/>
     <exports symbol='virStorageVolLookupByPath' type='function'/>
     <exports symbol='virStorageVolLookupByName' type='function'/>
     <exports symbol='virDomainCreateLinux' type='function'/>
     <exports symbol='virDomainSetMaxMemory' type='function'/>
143
     <exports symbol='virInitialize' type='function'/>
144 145 146 147 148 149 150 151 152 153 154 155 156
     <exports symbol='virDomainMigrate' type='function'/>
     <exports symbol='virDomainSuspend' type='function'/>
     <exports symbol='virNetworkCreate' type='function'/>
     <exports symbol='virDomainDestroy' type='function'/>
     <exports symbol='virConnectNumOfNetworks' type='function'/>
     <exports symbol='virStoragePoolLookupByUUIDString' type='function'/>
     <exports symbol='virDomainGetXMLDesc' type='function'/>
     <exports symbol='virStoragePoolGetUUID' type='function'/>
     <exports symbol='virStorageVolGetInfo' type='function'/>
     <exports symbol='virNetworkGetName' type='function'/>
     <exports symbol='virNetworkDestroy' type='function'/>
     <exports symbol='virStoragePoolLookupByName' type='function'/>
     <exports symbol='virNetworkGetAutostart' type='function'/>
157
     <exports symbol='virNetworkGetBridgeName' type='function'/>
158 159
     <exports symbol='virStorageVolGetXMLDesc' type='function'/>
     <exports symbol='virDomainSetSchedulerParameters' type='function'/>
160
     <exports symbol='virConnectGetType' type='function'/>
161
     <exports symbol='virDomainSave' type='function'/>
162 163
     <exports symbol='virDomainCreate' type='function'/>
     <exports symbol='virConnectListDomains' type='function'/>
D
Daniel Veillard 已提交
164
     <exports symbol='virDomainCoreDump' type='function'/>
165
     <exports symbol='virDomainSetMemory' type='function'/>
166
     <exports symbol='virNodeGetInfo' type='function'/>
167
     <exports symbol='virNetworkSetAutostart' type='function'/>
D
Daniel Veillard 已提交
168
     <exports symbol='virDomainGetMaxMemory' type='function'/>
169
     <exports symbol='virStoragePoolFree' type='function'/>
170
     <exports symbol='virNetworkDefineXML' type='function'/>
171
     <exports symbol='virDomainBlockStats' type='function'/>
172
     <exports symbol='virConnectOpenAuth' type='function'/>
173
     <exports symbol='virStoragePoolDelete' type='function'/>
174
     <exports symbol='virDomainResume' type='function'/>
175 176
     <exports symbol='virStorageVolGetName' type='function'/>
     <exports symbol='virStoragePoolGetAutostart' type='function'/>
177
     <exports symbol='virDomainGetAutostart' type='function'/>
178
     <exports symbol='virStoragePoolListVolumes' type='function'/>
179
     <exports symbol='virConnectGetHostname' type='function'/>
180 181 182 183 184 185 186
     <exports symbol='virDomainGetName' type='function'/>
     <exports symbol='virNetworkGetXMLDesc' type='function'/>
     <exports symbol='virConnectNumOfStoragePools' type='function'/>
     <exports symbol='virDomainGetInfo' type='function'/>
     <exports symbol='virConnectListDefinedDomains' type='function'/>
     <exports symbol='virConnectGetCapabilities' type='function'/>
     <exports symbol='virDomainLookupByName' type='function'/>
187
     <exports symbol='virConnectFindStoragePoolSources' type='function'/>
188 189 190 191 192 193
     <exports symbol='virDomainPinVcpu' type='function'/>
     <exports symbol='virDomainRestore' type='function'/>
     <exports symbol='virStorageVolGetPath' type='function'/>
     <exports symbol='virNetworkLookupByUUIDString' type='function'/>
     <exports symbol='virDomainLookupByID' type='function'/>
     <exports symbol='virStorageVolFree' type='function'/>
194
     <exports symbol='virDomainMemoryPeek' type='function'/>
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
     <exports symbol='virNetworkLookupByUUID' type='function'/>
     <exports symbol='virConnectListDefinedNetworks' type='function'/>
     <exports symbol='virDomainGetUUID' type='function'/>
     <exports symbol='virNetworkCreateXML' type='function'/>
     <exports symbol='virDomainGetVcpus' type='function'/>
     <exports symbol='virStoragePoolCreateXML' type='function'/>
     <exports symbol='virStoragePoolGetInfo' type='function'/>
     <exports symbol='virStoragePoolRefresh' type='function'/>
     <exports symbol='virConnectNumOfDefinedDomains' type='function'/>
     <exports symbol='virStorageVolLookupByKey' type='function'/>
     <exports symbol='virDomainUndefine' type='function'/>
     <exports symbol='virDomainReboot' type='function'/>
     <exports symbol='virNetworkGetUUIDString' type='function'/>
     <exports symbol='virNetworkLookupByName' type='function'/>
     <exports symbol='virDomainGetMaxVcpus' type='function'/>
     <exports symbol='virDomainGetSchedulerType' type='function'/>
     <exports symbol='virDomainDetachDevice' type='function'/>
     <exports symbol='virStoragePoolNumOfVolumes' type='function'/>
     <exports symbol='virStoragePoolGetUUIDString' type='function'/>
     <exports symbol='virStoragePoolUndefine' type='function'/>
215
     <exports symbol='virConnectAuthCallbackPtr' type='function'/>
216
     <exports symbol='virDomainAttachDevice' type='function'/>
217
     <exports symbol='virConnectGetURI' type='function'/>
218
     <exports symbol='virConnectOpenReadOnly' type='function'/>
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
     <exports symbol='virNetworkFree' type='function'/>
     <exports symbol='virStoragePoolLookupByUUID' type='function'/>
     <exports symbol='virStorageVolDelete' type='function'/>
     <exports symbol='virNetworkUndefine' type='function'/>
     <exports symbol='virConnectListDefinedStoragePools' type='function'/>
     <exports symbol='virNetworkGetConnect' type='function'/>
     <exports symbol='virNodeGetFreeMemory' type='function'/>
     <exports symbol='virStorageVolGetConnect' type='function'/>
     <exports symbol='virStoragePoolDestroy' type='function'/>
     <exports symbol='virStoragePoolLookupByVolume' type='function'/>
     <exports symbol='virDomainLookupByUUID' type='function'/>
     <exports symbol='virDomainGetOSType' type='function'/>
     <exports symbol='virStoragePoolBuild' type='function'/>
     <exports symbol='virConnectGetMaxVcpus' type='function'/>
     <exports symbol='virDomainGetUUIDString' type='function'/>
     <exports symbol='virDomainGetConnect' type='function'/>
     <exports symbol='virConnectNumOfDefinedStoragePools' type='function'/>
     <exports symbol='virConnectOpen' type='function'/>
     <exports symbol='virStoragePoolCreate' type='function'/>
     <exports symbol='virDomainSetVcpus' type='function'/>
     <exports symbol='virDomainGetID' type='function'/>
240
     <exports symbol='virDomainBlockPeek' type='function'/>
241 242
     <exports symbol='virDomainInterfaceStats' type='function'/>
     <exports symbol='virConnectListNetworks' type='function'/>
243 244 245 246 247
    </file>
    <file name='virterror'>
     <summary>error handling interfaces for the libvirt library</summary>
     <description>Provides the interfaces of the libvirt library to handle errors raised while using the library. </description>
     <author>Daniel Veillard &lt;veillard@redhat.com&gt; </author>
248
     <exports symbol='VIR_ERR_XML_ERROR' type='enum'/>
249
     <exports symbol='VIR_ERR_RPC' type='enum'/>
250
     <exports symbol='VIR_ERR_SYSTEM_ERROR' type='enum'/>
251
     <exports symbol='VIR_FROM_TEST' type='enum'/>
252
     <exports symbol='VIR_ERR_WARNING' type='enum'/>
253
     <exports symbol='VIR_FROM_OPENVZ' type='enum'/>
254
     <exports symbol='VIR_ERR_NO_XEN' type='enum'/>
255
     <exports symbol='VIR_FROM_STATS_LINUX' type='enum'/>
256 257
     <exports symbol='VIR_ERR_INVALID_ARG' type='enum'/>
     <exports symbol='VIR_ERR_ERROR' type='enum'/>
258
     <exports symbol='VIR_ERR_NO_OS' type='enum'/>
259 260 261 262
     <exports symbol='VIR_ERR_NO_DEVICE' type='enum'/>
     <exports symbol='VIR_ERR_NO_MEMORY' type='enum'/>
     <exports symbol='VIR_FROM_SEXPR' type='enum'/>
     <exports symbol='VIR_FROM_RPC' type='enum'/>
263
     <exports symbol='VIR_ERR_INVALID_MAC' type='enum'/>
264
     <exports symbol='VIR_ERR_NO_STORAGE_VOL' type='enum'/>
265
     <exports symbol='VIR_FROM_NONE' type='enum'/>
266
     <exports symbol='VIR_ERR_DOM_EXIST' type='enum'/>
267 268 269
     <exports symbol='VIR_ERR_NO_XENSTORE' type='enum'/>
     <exports symbol='VIR_FROM_DOM' type='enum'/>
     <exports symbol='VIR_ERR_INVALID_DOMAIN' type='enum'/>
270
     <exports symbol='VIR_ERR_NO_STORAGE_POOL' type='enum'/>
271
     <exports symbol='VIR_FROM_CONF' type='enum'/>
272
     <exports symbol='VIR_ERR_INVALID_NETWORK' type='enum'/>
273
     <exports symbol='VIR_ERR_AUTH_FAILED' type='enum'/>
274
     <exports symbol='VIR_FROM_XML' type='enum'/>
275
     <exports symbol='VIR_ERR_OPERATION_DENIED' type='enum'/>
276
     <exports symbol='VIR_FROM_STORAGE' type='enum'/>
277
     <exports symbol='VIR_ERR_NO_KERNEL' type='enum'/>
278
     <exports symbol='VIR_ERR_GNUTLS_ERROR' type='enum'/>
279 280
     <exports symbol='VIR_ERR_POST_FAILED' type='enum'/>
     <exports symbol='VIR_ERR_OS_TYPE' type='enum'/>
D
Daniel Veillard 已提交
281
     <exports symbol='VIR_FROM_XENSTORE' type='enum'/>
282
     <exports symbol='VIR_WAR_NO_NETWORK' type='enum'/>
283 284 285
     <exports symbol='VIR_ERR_INVALID_CONN' type='enum'/>
     <exports symbol='VIR_ERR_NONE' type='enum'/>
     <exports symbol='VIR_ERR_OK' type='enum'/>
286
     <exports symbol='VIR_ERR_XML_DETAIL' type='enum'/>
287
     <exports symbol='VIR_FROM_NET' type='enum'/>
R
Richard W.M. Jones 已提交
288
     <exports symbol='VIR_FROM_XENXM' type='enum'/>
289 290 291 292 293
     <exports symbol='VIR_ERR_NO_NAME' type='enum'/>
     <exports symbol='VIR_ERR_NO_ROOT' type='enum'/>
     <exports symbol='VIR_ERR_OPERATION_FAILED' type='enum'/>
     <exports symbol='VIR_ERR_GET_FAILED' type='enum'/>
     <exports symbol='VIR_ERR_DRIVER_FULL' type='enum'/>
294
     <exports symbol='VIR_ERR_HTTP_ERROR' type='enum'/>
295
     <exports symbol='VIR_ERR_PARSE_FAILED' type='enum'/>
296
     <exports symbol='VIR_ERR_NO_SOURCE' type='enum'/>
297
     <exports symbol='VIR_FROM_DOMAIN' type='enum'/>
298
     <exports symbol='VIR_ERR_NO_TARGET' type='enum'/>
299
     <exports symbol='VIR_ERR_NETWORK_EXIST' type='enum'/>
300
     <exports symbol='VIR_WAR_NO_STORAGE' type='enum'/>
301
     <exports symbol='VIR_ERR_WRITE_FAILED' type='enum'/>
302
     <exports symbol='VIR_ERR_INTERNAL_ERROR' type='enum'/>
303
     <exports symbol='VIR_ERR_CONF_SYNTAX' type='enum'/>
304
     <exports symbol='VIR_ERR_INVALID_STORAGE_POOL' type='enum'/>
305
     <exports symbol='VIR_FROM_REMOTE' type='enum'/>
306
     <exports symbol='VIR_ERR_NO_SUPPORT' type='enum'/>
307
     <exports symbol='VIR_FROM_NETWORK' type='enum'/>
308
     <exports symbol='VIR_FROM_QEMU' type='enum'/>
309
     <exports symbol='VIR_FROM_XEND' type='enum'/>
310
     <exports symbol='VIR_ERR_INVALID_STORAGE_VOL' type='enum'/>
311
     <exports symbol='VIR_FROM_PROXY' type='enum'/>
312 313
     <exports symbol='VIR_ERR_NO_NETWORK' type='enum'/>
     <exports symbol='VIR_ERR_NO_DOMAIN' type='enum'/>
314
     <exports symbol='VIR_ERR_READ_FAILED' type='enum'/>
315
     <exports symbol='VIR_ERR_SEXPR_SERIAL' type='enum'/>
D
Daniel Veillard 已提交
316
     <exports symbol='VIR_FROM_LXC' type='enum'/>
317
     <exports symbol='VIR_FROM_XEN' type='enum'/>
318
     <exports symbol='VIR_ERR_OPEN_FAILED' type='enum'/>
319 320 321
     <exports symbol='VIR_ERR_XEN_CALL' type='enum'/>
     <exports symbol='VIR_ERR_UNKNOWN_HOST' type='enum'/>
     <exports symbol='VIR_ERR_NO_CONNECT' type='enum'/>
322
     <exports symbol='VIR_ERR_CALL_FAILED' type='enum'/>
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
     <exports symbol='virErrorPtr' type='typedef'/>
     <exports symbol='virErrorLevel' type='typedef'/>
     <exports symbol='virErrorDomain' type='typedef'/>
     <exports symbol='virErrorNumber' type='typedef'/>
     <exports symbol='virError' type='typedef'/>
     <exports symbol='_virError' type='struct'/>
     <exports symbol='virCopyLastError' type='function'/>
     <exports symbol='virConnSetErrorFunc' type='function'/>
     <exports symbol='virResetLastError' type='function'/>
     <exports symbol='virErrorFunc' type='function'/>
     <exports symbol='virResetError' type='function'/>
     <exports symbol='virConnGetLastError' type='function'/>
     <exports symbol='virDefaultErrorFunc' type='function'/>
     <exports symbol='virGetLastError' type='function'/>
     <exports symbol='virSetErrorFunc' type='function'/>
     <exports symbol='virConnCopyLastError' type='function'/>
     <exports symbol='virConnResetLastError' type='function'/>
    </file>
341 342
  </files>
  <symbols>
343 344 345
    <macro name='LIBVIR_VERSION_NUMBER' file='libvirt'>
      <info>Macro providing the version of the library as version * 1,000,000 + minor * 1000 + micro</info>
    </macro>
346
    <macro name='VIR_COPY_CPUMAP' file='libvirt'>
347
      <info>This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_COPY_CPUMAP macro extract the cpumap of the specified vcpu from cpumaps array and copy it into cpumap to be used later by virDomainPinVcpu() API.</info>
348 349 350 351 352 353
      <arg name='cpumaps' info='pointer to an array of cpumap (in 8-bit bytes) (IN)'/>
      <arg name='maplen' info='the length (in bytes) of one cpumap'/>
      <arg name='vcpu' info='the virtual CPU number'/>
      <arg name='cpumap' info='pointer to a cpumap (in 8-bit bytes) (OUT) This cpumap must be previously allocated by the caller (ie: malloc(maplen))'/>
    </macro>
    <macro name='VIR_CPU_MAPLEN' file='libvirt'>
354
      <info>This macro is to be used in conjunction with virDomainPinVcpu() API. It returns the length (in bytes) required to store the complete CPU map between a single virtual &amp; all physical CPUs of a domain.</info>
355
      <arg name='cpu' info='number of physical CPUs'/>
356 357
    </macro>
    <macro name='VIR_CPU_USABLE' file='libvirt'>
358
      <info>This macro is to be used in conjunction with virDomainGetVcpus() API. VIR_CPU_USABLE macro returns a non zero value (true) if the cpu is usable by the vcpu, and 0 otherwise.</info>
359 360 361 362 363
      <arg name='cpumaps' info='pointer to an array of cpumap (in 8-bit bytes) (IN)'/>
      <arg name='maplen' info='the length (in bytes) of one cpumap'/>
      <arg name='vcpu' info='the virtual CPU number'/>
      <arg name='cpu' info='the physical CPU number'/>
    </macro>
364 365 366
    <macro name='VIR_DOMAIN_SCHED_FIELD_LENGTH' file='libvirt'>
      <info>Macro providing the field length of virSchedParameter</info>
    </macro>
367
    <macro name='VIR_GET_CPUMAP' file='libvirt'>
368
      <info>This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_GET_CPUMAP macro returns a pointer to the cpumap of the specified vcpu from cpumaps array.</info>
369 370 371 372 373
      <arg name='cpumaps' info='pointer to an array of cpumap (in 8-bit bytes) (IN)'/>
      <arg name='maplen' info='the length (in bytes) of one cpumap'/>
      <arg name='vcpu' info='the virtual CPU number'/>
    </macro>
    <macro name='VIR_NODEINFO_MAXCPUS' file='libvirt'>
374
      <info>This macro is to calculate the total number of CPUs supported but not necessary active in the host.</info>
375 376 377
      <arg name='nodeinfo' info='virNodeInfo instance'/>
    </macro>
    <macro name='VIR_UNUSE_CPU' file='libvirt'>
378
      <info>This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro reset the bit (CPU not usable) of the related cpu in cpumap.</info>
379 380 381 382
      <arg name='cpumap' info='pointer to a bit map of real CPUs (in 8-bit bytes) (IN/OUT)'/>
      <arg name='cpu' info='the physical CPU number'/>
    </macro>
    <macro name='VIR_USE_CPU' file='libvirt'>
383
      <info>This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro set the bit (CPU usable) of the related cpu in cpumap.</info>
384 385 386
      <arg name='cpumap' info='pointer to a bit map of real CPUs (in 8-bit bytes) (IN/OUT)'/>
      <arg name='cpu' info='the physical CPU number'/>
    </macro>
387
    <macro name='VIR_UUID_BUFLEN' file='libvirt'>
388
      <info>This macro provides the length of the buffer required for virDomainGetUUID()</info>
389 390 391 392
    </macro>
    <macro name='VIR_UUID_STRING_BUFLEN' file='libvirt'>
      <info>This macro provides the length of the buffer required for virDomainGetUUIDString()</info>
    </macro>
393 394 395 396 397 398 399 400 401 402
    <enum name='VIR_CONNECT_RO' file='libvirt' value='1' type='virConnectFlags' info=' A readonly connection'/>
    <enum name='VIR_CRED_AUTHNAME' file='libvirt' value='2' type='virConnectCredentialType' info='Identify to authorize as'/>
    <enum name='VIR_CRED_CNONCE' file='libvirt' value='4' type='virConnectCredentialType' info='client supplies a nonce'/>
    <enum name='VIR_CRED_ECHOPROMPT' file='libvirt' value='6' type='virConnectCredentialType' info='Challenge response'/>
    <enum name='VIR_CRED_EXTERNAL' file='libvirt' value='9' type='virConnectCredentialType' info=' Externally managed credential More may be added - expect the unexpected'/>
    <enum name='VIR_CRED_LANGUAGE' file='libvirt' value='3' type='virConnectCredentialType' info='RFC 1766 languages, comma separated'/>
    <enum name='VIR_CRED_NOECHOPROMPT' file='libvirt' value='7' type='virConnectCredentialType' info='Challenge response'/>
    <enum name='VIR_CRED_PASSPHRASE' file='libvirt' value='5' type='virConnectCredentialType' info='Passphrase secret'/>
    <enum name='VIR_CRED_REALM' file='libvirt' value='8' type='virConnectCredentialType' info='Authentication realm'/>
    <enum name='VIR_CRED_USERNAME' file='libvirt' value='1' type='virConnectCredentialType' info='Identity to act as'/>
403 404 405 406 407 408
    <enum name='VIR_DOMAIN_BLOCKED' file='libvirt' value='2' type='virDomainState' info='the domain is blocked on resource'/>
    <enum name='VIR_DOMAIN_CRASHED' file='libvirt' value='6' type='virDomainState' info=' the domain is crashed'/>
    <enum name='VIR_DOMAIN_NONE' file='libvirt' value='0' type='virDomainCreateFlags'/>
    <enum name='VIR_DOMAIN_NOSTATE' file='libvirt' value='0' type='virDomainState' info='no state'/>
    <enum name='VIR_DOMAIN_PAUSED' file='libvirt' value='3' type='virDomainState' info='the domain is paused by user'/>
    <enum name='VIR_DOMAIN_RUNNING' file='libvirt' value='1' type='virDomainState' info='the domain is running'/>
409 410 411 412 413 414
    <enum name='VIR_DOMAIN_SCHED_FIELD_BOOLEAN' file='libvirt' value='6' type='virSchedParameterType' info=' boolean(character) case'/>
    <enum name='VIR_DOMAIN_SCHED_FIELD_DOUBLE' file='libvirt' value='5' type='virSchedParameterType' info='double case'/>
    <enum name='VIR_DOMAIN_SCHED_FIELD_INT' file='libvirt' value='1' type='virSchedParameterType' info='integer case'/>
    <enum name='VIR_DOMAIN_SCHED_FIELD_LLONG' file='libvirt' value='3' type='virSchedParameterType' info='long long case'/>
    <enum name='VIR_DOMAIN_SCHED_FIELD_UINT' file='libvirt' value='2' type='virSchedParameterType' info='unsigned integer case'/>
    <enum name='VIR_DOMAIN_SCHED_FIELD_ULLONG' file='libvirt' value='4' type='virSchedParameterType' info='unsigned long long case'/>
415 416
    <enum name='VIR_DOMAIN_SHUTDOWN' file='libvirt' value='4' type='virDomainState' info='the domain is being shut down'/>
    <enum name='VIR_DOMAIN_SHUTOFF' file='libvirt' value='5' type='virDomainState' info='the domain is shut off'/>
417 418
    <enum name='VIR_DOMAIN_XML_INACTIVE' file='libvirt' value='2' type='virDomainXMLFlags' info=' dump inactive domain information'/>
    <enum name='VIR_DOMAIN_XML_SECURE' file='libvirt' value='1' type='virDomainXMLFlags' info='dump security sensitive information too'/>
419
    <enum name='VIR_ERR_AUTH_FAILED' file='virterror' value='45' type='virErrorNumber' info='authentication failed'/>
420
    <enum name='VIR_ERR_CALL_FAILED' file='virterror' value='26' type='virErrorNumber' info='not supported by the drivers (DEPRECATED)'/>
421
    <enum name='VIR_ERR_CONF_SYNTAX' file='virterror' value='33' type='virErrorNumber' info='failed to parse the syntax of a conf file'/>
422
    <enum name='VIR_ERR_DOM_EXIST' file='virterror' value='28' type='virErrorNumber' info='the domain already exist'/>
423 424 425
    <enum name='VIR_ERR_DRIVER_FULL' file='virterror' value='25' type='virErrorNumber' info='too many drivers registered'/>
    <enum name='VIR_ERR_ERROR' file='virterror' value='2' type='virErrorLevel' info=' An error'/>
    <enum name='VIR_ERR_GET_FAILED' file='virterror' value='10' type='virErrorNumber' info='a HTTP GET command to failed'/>
426
    <enum name='VIR_ERR_GNUTLS_ERROR' file='virterror' value='40' type='virErrorNumber' info='error from a GNUTLS call'/>
427 428 429 430 431
    <enum name='VIR_ERR_HTTP_ERROR' file='virterror' value='12' type='virErrorNumber' info='unexpected HTTP error code'/>
    <enum name='VIR_ERR_INTERNAL_ERROR' file='virterror' value='1' type='virErrorNumber' info='internal error'/>
    <enum name='VIR_ERR_INVALID_ARG' file='virterror' value='8' type='virErrorNumber' info='invalid function argument'/>
    <enum name='VIR_ERR_INVALID_CONN' file='virterror' value='6' type='virErrorNumber' info='invalid connection object'/>
    <enum name='VIR_ERR_INVALID_DOMAIN' file='virterror' value='7' type='virErrorNumber' info='invalid domain object'/>
432
    <enum name='VIR_ERR_INVALID_MAC' file='virterror' value='44' type='virErrorNumber' info='invalid MAC address'/>
433
    <enum name='VIR_ERR_INVALID_NETWORK' file='virterror' value='36' type='virErrorNumber' info='invalid network object'/>
434 435
    <enum name='VIR_ERR_INVALID_STORAGE_POOL' file='virterror' value='46' type='virErrorNumber' info='invalid storage pool object'/>
    <enum name='VIR_ERR_INVALID_STORAGE_VOL' file='virterror' value='47' type='virErrorNumber' info='invalid storage vol object'/>
436
    <enum name='VIR_ERR_NETWORK_EXIST' file='virterror' value='37' type='virErrorNumber' info='the network already exist'/>
437 438 439
    <enum name='VIR_ERR_NONE' file='virterror' value='0' type='virErrorLevel'/>
    <enum name='VIR_ERR_NO_CONNECT' file='virterror' value='5' type='virErrorNumber' info='can&apos;t connect to hypervisor'/>
    <enum name='VIR_ERR_NO_DEVICE' file='virterror' value='23' type='virErrorNumber' info='missing domain devices information'/>
440
    <enum name='VIR_ERR_NO_DOMAIN' file='virterror' value='42' type='virErrorNumber' info='domain not found or unexpectedly disappeared'/>
441 442 443
    <enum name='VIR_ERR_NO_KERNEL' file='virterror' value='17' type='virErrorNumber' info='missing kernel information'/>
    <enum name='VIR_ERR_NO_MEMORY' file='virterror' value='2' type='virErrorNumber' info='memory allocation failure'/>
    <enum name='VIR_ERR_NO_NAME' file='virterror' value='21' type='virErrorNumber' info='missing domain name information'/>
444
    <enum name='VIR_ERR_NO_NETWORK' file='virterror' value='43' type='virErrorNumber' info='network not found'/>
445 446 447
    <enum name='VIR_ERR_NO_OS' file='virterror' value='22' type='virErrorNumber' info='missing domain OS information'/>
    <enum name='VIR_ERR_NO_ROOT' file='virterror' value='18' type='virErrorNumber' info='missing root device information'/>
    <enum name='VIR_ERR_NO_SOURCE' file='virterror' value='19' type='virErrorNumber' info='missing source device information'/>
448 449
    <enum name='VIR_ERR_NO_STORAGE_POOL' file='virterror' value='49' type='virErrorNumber' info='storage pool not found'/>
    <enum name='VIR_ERR_NO_STORAGE_VOL' file='virterror' value='50' type='virErrorNumber' info=' storage pool not found'/>
450
    <enum name='VIR_ERR_NO_SUPPORT' file='virterror' value='3' type='virErrorNumber' info='no support for this function'/>
451 452 453 454
    <enum name='VIR_ERR_NO_TARGET' file='virterror' value='20' type='virErrorNumber' info='missing target device information'/>
    <enum name='VIR_ERR_NO_XEN' file='virterror' value='14' type='virErrorNumber' info='could not open Xen hypervisor control'/>
    <enum name='VIR_ERR_NO_XENSTORE' file='virterror' value='24' type='virErrorNumber' info='could not open Xen Store control'/>
    <enum name='VIR_ERR_OK' file='virterror' value='0' type='virErrorNumber'/>
455 456
    <enum name='VIR_ERR_OPEN_FAILED' file='virterror' value='30' type='virErrorNumber' info='failed to open a conf file'/>
    <enum name='VIR_ERR_OPERATION_DENIED' file='virterror' value='29' type='virErrorNumber' info='operation forbidden on read-only connections'/>
457 458
    <enum name='VIR_ERR_OPERATION_FAILED' file='virterror' value='9' type='virErrorNumber' info='a command to hypervisor failed'/>
    <enum name='VIR_ERR_OS_TYPE' file='virterror' value='16' type='virErrorNumber' info='unknown OS type'/>
459
    <enum name='VIR_ERR_PARSE_FAILED' file='virterror' value='32' type='virErrorNumber' info='failed to parse a conf file'/>
460
    <enum name='VIR_ERR_POST_FAILED' file='virterror' value='11' type='virErrorNumber' info='a HTTP POST command to failed'/>
461
    <enum name='VIR_ERR_READ_FAILED' file='virterror' value='31' type='virErrorNumber' info='failed to read a conf file'/>
462
    <enum name='VIR_ERR_RPC' file='virterror' value='39' type='virErrorNumber' info='some sort of RPC error'/>
463
    <enum name='VIR_ERR_SEXPR_SERIAL' file='virterror' value='13' type='virErrorNumber' info='failure to serialize an S-Expr'/>
464
    <enum name='VIR_ERR_SYSTEM_ERROR' file='virterror' value='38' type='virErrorNumber' info='general system call failure'/>
465 466
    <enum name='VIR_ERR_UNKNOWN_HOST' file='virterror' value='4' type='virErrorNumber' info='could not resolve hostname'/>
    <enum name='VIR_ERR_WARNING' file='virterror' value='1' type='virErrorLevel' info='A simple warning'/>
467
    <enum name='VIR_ERR_WRITE_FAILED' file='virterror' value='34' type='virErrorNumber' info='failed to write a conf file'/>
468
    <enum name='VIR_ERR_XEN_CALL' file='virterror' value='15' type='virErrorNumber' info='failure doing an hypervisor call'/>
469
    <enum name='VIR_ERR_XML_DETAIL' file='virterror' value='35' type='virErrorNumber' info='detail of an XML error'/>
470
    <enum name='VIR_ERR_XML_ERROR' file='virterror' value='27' type='virErrorNumber' info='an XML description is not well formed or broken'/>
471
    <enum name='VIR_FROM_CONF' file='virterror' value='9' type='virErrorDomain' info='Error in the configuration file handling'/>
472
    <enum name='VIR_FROM_DOM' file='virterror' value='6' type='virErrorDomain' info='Error when operating on a domain'/>
473
    <enum name='VIR_FROM_DOMAIN' file='virterror' value='20' type='virErrorDomain' info=' Error from domain config'/>
D
Daniel Veillard 已提交
474
    <enum name='VIR_FROM_LXC' file='virterror' value='17' type='virErrorDomain' info='Error from Linux Container driver'/>
475
    <enum name='VIR_FROM_NET' file='virterror' value='11' type='virErrorDomain' info='Error when operating on a network'/>
476
    <enum name='VIR_FROM_NETWORK' file='virterror' value='19' type='virErrorDomain' info='Error from network config'/>
477
    <enum name='VIR_FROM_NONE' file='virterror' value='0' type='virErrorDomain'/>
R
Richard W.M. Jones 已提交
478
    <enum name='VIR_FROM_OPENVZ' file='virterror' value='14' type='virErrorDomain' info='Error from OpenVZ driver'/>
479
    <enum name='VIR_FROM_PROXY' file='virterror' value='8' type='virErrorDomain' info='Error in the proxy code'/>
480
    <enum name='VIR_FROM_QEMU' file='virterror' value='10' type='virErrorDomain' info='Error at the QEMU daemon'/>
481
    <enum name='VIR_FROM_REMOTE' file='virterror' value='13' type='virErrorDomain' info='Error from remote driver'/>
482
    <enum name='VIR_FROM_RPC' file='virterror' value='7' type='virErrorDomain' info='Error in the XML-RPC code'/>
483
    <enum name='VIR_FROM_SEXPR' file='virterror' value='4' type='virErrorDomain' info='Error in the S-Expression code'/>
484
    <enum name='VIR_FROM_STATS_LINUX' file='virterror' value='16' type='virErrorDomain' info='Error in the Linux Stats code'/>
485
    <enum name='VIR_FROM_STORAGE' file='virterror' value='18' type='virErrorDomain' info='Error from storage driver'/>
486
    <enum name='VIR_FROM_TEST' file='virterror' value='12' type='virErrorDomain' info='Error from test driver'/>
487 488 489
    <enum name='VIR_FROM_XEN' file='virterror' value='1' type='virErrorDomain' info='Error at Xen hypervisor layer'/>
    <enum name='VIR_FROM_XEND' file='virterror' value='2' type='virErrorDomain' info='Error at connection with xend daemon'/>
    <enum name='VIR_FROM_XENSTORE' file='virterror' value='3' type='virErrorDomain' info='Error at connection with xen store'/>
R
Richard W.M. Jones 已提交
490
    <enum name='VIR_FROM_XENXM' file='virterror' value='15' type='virErrorDomain' info='Error at Xen XM layer'/>
491
    <enum name='VIR_FROM_XML' file='virterror' value='5' type='virErrorDomain' info='Error in the XML code'/>
492
    <enum name='VIR_MEMORY_VIRTUAL' file='libvirt' value='1' type='virDomainMemoryFlags' info=' addresses are virtual addresses'/>
493
    <enum name='VIR_MIGRATE_LIVE' file='libvirt' value='1' type='virDomainMigrateFlags' info=' live migration'/>
494 495 496 497 498 499 500 501 502 503 504 505 506
    <enum name='VIR_STORAGE_POOL_BUILDING' file='libvirt' value='1' type='virStoragePoolState' info='Initializing pool, not available'/>
    <enum name='VIR_STORAGE_POOL_BUILD_NEW' file='libvirt' value='0' type='virStoragePoolBuildFlags' info='Regular build from scratch'/>
    <enum name='VIR_STORAGE_POOL_BUILD_REPAIR' file='libvirt' value='1' type='virStoragePoolBuildFlags' info='Repair / reinitialize'/>
    <enum name='VIR_STORAGE_POOL_BUILD_RESIZE' file='libvirt' value='2' type='virStoragePoolBuildFlags' info=' Extend existing pool'/>
    <enum name='VIR_STORAGE_POOL_DEGRADED' file='libvirt' value='3' type='virStoragePoolState' info=' Running degraded'/>
    <enum name='VIR_STORAGE_POOL_DELETE_NORMAL' file='libvirt' value='0' type='virStoragePoolDeleteFlags' info='Delete metadata only    (fast)'/>
    <enum name='VIR_STORAGE_POOL_DELETE_ZEROED' file='libvirt' value='1' type='virStoragePoolDeleteFlags' info=' Clear all data to zeros (slow)'/>
    <enum name='VIR_STORAGE_POOL_INACTIVE' file='libvirt' value='0' type='virStoragePoolState' info='Not running'/>
    <enum name='VIR_STORAGE_POOL_RUNNING' file='libvirt' value='2' type='virStoragePoolState' info='Running normally'/>
    <enum name='VIR_STORAGE_VOL_BLOCK' file='libvirt' value='1' type='virStorageVolType' info=' Block based volumes'/>
    <enum name='VIR_STORAGE_VOL_DELETE_NORMAL' file='libvirt' value='0' type='virStorageVolDeleteFlags' info='Delete metadata only    (fast)'/>
    <enum name='VIR_STORAGE_VOL_DELETE_ZEROED' file='libvirt' value='1' type='virStorageVolDeleteFlags' info=' Clear all data to zeros (slow)'/>
    <enum name='VIR_STORAGE_VOL_FILE' file='libvirt' value='0' type='virStorageVolType' info='Regular file based volumes'/>
507 508 509
    <enum name='VIR_VCPU_BLOCKED' file='libvirt' value='2' type='virVcpuState' info=' the virtual CPU is blocked on resource'/>
    <enum name='VIR_VCPU_OFFLINE' file='libvirt' value='0' type='virVcpuState' info='the virtual CPU is offline'/>
    <enum name='VIR_VCPU_RUNNING' file='libvirt' value='1' type='virVcpuState' info='the virtual CPU is running'/>
510
    <enum name='VIR_WAR_NO_NETWORK' file='virterror' value='41' type='virErrorNumber' info='failed to start network'/>
511
    <enum name='VIR_WAR_NO_STORAGE' file='virterror' value='48' type='virErrorNumber' info='failed to start storage'/>
512
    <struct name='virConnect' file='libvirt' type='struct _virConnect'/>
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
    <struct name='virConnectAuth' file='libvirt' type='struct _virConnectAuth'>
      <field name='credtype' type='int *' info=' List of supported virConnectCredentialType values'/>
      <field name='ncredtype' type='unsigned int' info=''/>
      <field name='cb' type='virConnectAuthCallbackPtr' info=' Callback used to collect credentials'/>
      <field name='cbdata' type='void *' info=''/>
    </struct>
    <typedef name='virConnectAuthPtr' file='libvirt' type='virConnectAuth *'/>
    <struct name='virConnectCredential' file='libvirt' type='struct _virConnectCredential'>
      <field name='type' type='int' info=' One of virConnectCredentialType constants'/>
      <field name='prompt' type='const char *' info=' Prompt to show to user'/>
      <field name='challenge' type='const char *' info=' Additional challenge to show'/>
      <field name='defresult' type='const char *' info=' Optional default result'/>
      <field name='result' type='char *' info=' Result to be filled with user response (or defresult)'/>
      <field name='resultlen' type='unsigned int' info=' Length of the result'/>
    </struct>
    <typedef name='virConnectCredentialPtr' file='libvirt' type='virConnectCredential *'/>
    <typedef name='virConnectCredentialType' file='libvirt' type='enum'/>
    <typedef name='virConnectFlags' file='libvirt' type='enum'/>
531
    <typedef name='virConnectPtr' file='libvirt' type='virConnect *'>
532
      <info>a virConnectPtr is pointer to a virConnect private structure, this is the type used to reference a connection to the Hypervisor in the API.</info>
533 534
    </typedef>
    <struct name='virDomain' file='libvirt' type='struct _virDomain'/>
535 536 537 538
    <typedef name='virDomainBlockStatsPtr' file='libvirt' type='virDomainBlockStatsStruct *'>
      <info>A pointer to a virDomainBlockStats structure</info>
    </typedef>
    <struct name='virDomainBlockStatsStruct' file='libvirt' type='struct _virDomainBlockStats'>
539 540 541
      <field name='rd_req' type='long long' info=' number of read requests'/>
      <field name='rd_bytes' type='long long' info=' number of read bytes'/>
      <field name='wr_req' type='long long' info=' number of write requests'/>
542
      <field name='wr_bytes' type='long long' info=' number of written bytes'/>
543 544
      <field name='errs' type='long long' info=' In Xen this returns the mysterious &apos;oo_req&apos;.'/>
    </struct>
545 546 547 548 549 550 551 552 553 554 555
    <typedef name='virDomainCreateFlags' file='libvirt' type='enum'/>
    <struct name='virDomainInfo' file='libvirt' type='struct _virDomainInfo'>
      <field name='state' type='unsigned char' info=' the running state, one of virDomainFlags'/>
      <field name='maxMem' type='unsigned long' info=' the maximum memory in KBytes allowed'/>
      <field name='memory' type='unsigned long' info=' the memory in KBytes used by the domain'/>
      <field name='nrVirtCpu' type='unsigned short' info=' the number of virtual CPUs for the domain'/>
      <field name='cpuTime' type='unsigned long long' info=' the CPU time used in nanoseconds'/>
    </struct>
    <typedef name='virDomainInfoPtr' file='libvirt' type='virDomainInfo *'>
      <info>a virDomainInfoPtr is a pointer to a virDomainInfo structure.</info>
    </typedef>
556
    <typedef name='virDomainInterfaceStatsPtr' file='libvirt' type='virDomainInterfaceStatsStruct *'>
557
      <info>A pointer to a virDomainInterfaceStats structure</info>
558 559 560 561 562 563 564 565 566 567 568
    </typedef>
    <struct name='virDomainInterfaceStatsStruct' file='libvirt' type='struct _virDomainInterfaceStats'>
      <field name='rx_bytes' type='long long' info=''/>
      <field name='rx_packets' type='long long' info=''/>
      <field name='rx_errs' type='long long' info=''/>
      <field name='rx_drop' type='long long' info=''/>
      <field name='tx_bytes' type='long long' info=''/>
      <field name='tx_packets' type='long long' info=''/>
      <field name='tx_errs' type='long long' info=''/>
      <field name='tx_drop' type='long long' info=''/>
    </struct>
569
    <typedef name='virDomainMemoryFlags' file='libvirt' type='enum'/>
570
    <typedef name='virDomainMigrateFlags' file='libvirt' type='enum'/>
571
    <typedef name='virDomainPtr' file='libvirt' type='virDomain *'>
572
      <info>a virDomainPtr is pointer to a virDomain private structure, this is the type used to reference a domain in the API.</info>
573 574
    </typedef>
    <typedef name='virDomainState' file='libvirt' type='enum'/>
575
    <typedef name='virDomainXMLFlags' file='libvirt' type='enum'/>
576 577 578 579 580
    <struct name='virError' file='virterror' type='struct _virError'>
      <field name='code' type='int' info=' The error code, a virErrorNumber'/>
      <field name='domain' type='int' info=' What part of the library raised this error'/>
      <field name='message' type='char *' info=' human-readable informative error message'/>
      <field name='level' type='virErrorLevel' info=' how consequent is the error'/>
581 582
      <field name='conn' type='virConnectPtr' info=' connection if available,
see note above'/>
583
      <field name='dom' type='virDomainPtr' info=' domain if available, see note above'/>
584 585 586 587 588
      <field name='str1' type='char *' info=' extra string information'/>
      <field name='str2' type='char *' info=' extra string information'/>
      <field name='str3' type='char *' info=' extra string information'/>
      <field name='int1' type='int' info=' extra number information'/>
      <field name='int2' type='int' info=' extra number information'/>
589
      <field name='net' type='virNetworkPtr' info=' network if available, see note above'/>
590 591 592 593 594
    </struct>
    <typedef name='virErrorDomain' file='virterror' type='enum'/>
    <typedef name='virErrorLevel' file='virterror' type='enum'/>
    <typedef name='virErrorNumber' file='virterror' type='enum'/>
    <typedef name='virErrorPtr' file='virterror' type='virError *'/>
595 596 597 598
    <struct name='virNetwork' file='libvirt' type='struct _virNetwork'/>
    <typedef name='virNetworkPtr' file='libvirt' type='virNetwork *'>
      <info>a virNetworkPtr is pointer to a virNetwork private structure, this is the type used to reference a virtual network in the API.</info>
    </typedef>
599 600 601 602 603 604 605 606 607 608 609 610 611
    <struct name='virNodeInfo' file='libvirt' type='struct _virNodeInfo'>
      <field name='model' type='charmodel[32]' info=' string indicating the CPU model'/>
      <field name='memory' type='unsigned long' info=' memory size in kilobytes'/>
      <field name='cpus' type='unsigned int' info=' the number of active CPUs'/>
      <field name='mhz' type='unsigned int' info=' expected CPU frequency'/>
      <field name='nodes' type='unsigned int' info=' the number of NUMA cell, 1 for uniform mem access'/>
      <field name='sockets' type='unsigned int' info=' number of CPU socket per node'/>
      <field name='cores' type='unsigned int' info=' number of core per socket'/>
      <field name='threads' type='unsigned int' info=' number of threads per core'/>
    </struct>
    <typedef name='virNodeInfoPtr' file='libvirt' type='virNodeInfo *'>
      <info>a virNodeInfoPtr is a pointer to a virNodeInfo structure.</info>
    </typedef>
612 613 614 615 616 617 618 619
    <struct name='virSchedParameter' file='libvirt' type='struct _virSchedParameter'>
      <field name='field' type='charfield[VIR_DOMAIN_SCHED_FIELD_LENGTH]' info=' parameter name'/>
      <field name='type' type='int' info=' parameter type'/>
    </struct>
    <typedef name='virSchedParameterPtr' file='libvirt' type='virSchedParameter *'>
      <info>a virSchedParameterPtr is a pointer to a virSchedParameter structure.</info>
    </typedef>
    <typedef name='virSchedParameterType' file='libvirt' type='enum'/>
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
    <struct name='virStoragePool' file='libvirt' type='struct _virStoragePool'/>
    <typedef name='virStoragePoolBuildFlags' file='libvirt' type='enum'/>
    <typedef name='virStoragePoolDeleteFlags' file='libvirt' type='enum'/>
    <struct name='virStoragePoolInfo' file='libvirt' type='struct _virStoragePoolInfo'>
      <field name='state' type='int' info=' virStoragePoolState flags'/>
      <field name='capacity' type='unsigned long long' info=' Logical size bytes'/>
      <field name='allocation' type='unsigned long long' info=' Current allocation bytes'/>
      <field name='available' type='unsigned long long' info=' Remaining free space bytes'/>
    </struct>
    <typedef name='virStoragePoolInfoPtr' file='libvirt' type='virStoragePoolInfo *'/>
    <typedef name='virStoragePoolPtr' file='libvirt' type='virStoragePool *'>
      <info>a virStoragePoolPtr is pointer to a virStoragePool private structure, this is the type used to reference a storage pool in the API.</info>
    </typedef>
    <typedef name='virStoragePoolState' file='libvirt' type='enum'/>
    <struct name='virStorageVol' file='libvirt' type='struct _virStorageVol'/>
    <typedef name='virStorageVolDeleteFlags' file='libvirt' type='enum'/>
    <struct name='virStorageVolInfo' file='libvirt' type='struct _virStorageVolInfo'>
      <field name='type' type='int' info=' virStorageVolType flags'/>
      <field name='capacity' type='unsigned long long' info=' Logical size bytes'/>
      <field name='allocation' type='unsigned long long' info=' Current allocation bytes'/>
    </struct>
    <typedef name='virStorageVolInfoPtr' file='libvirt' type='virStorageVolInfo *'/>
    <typedef name='virStorageVolPtr' file='libvirt' type='virStorageVol *'>
      <info>a virStorageVolPtr is pointer to a virStorageVol private structure, this is the type used to reference a storage volume in the API.</info>
    </typedef>
    <typedef name='virStorageVolType' file='libvirt' type='enum'/>
646 647 648 649 650 651 652 653
    <struct name='virVcpuInfo' file='libvirt' type='struct _virVcpuInfo'>
      <field name='number' type='unsigned int' info=' virtual CPU number'/>
      <field name='state' type='int' info=' value from virVcpuState'/>
      <field name='cpuTime' type='unsigned long long' info=' CPU time used, in nanoseconds'/>
      <field name='cpu' type='int' info=' real CPU number, or -1 if offline'/>
    </struct>
    <typedef name='virVcpuInfoPtr' file='libvirt' type='virVcpuInfo *'/>
    <typedef name='virVcpuState' file='libvirt' type='enum'/>
654
    <variable name='virConnectAuthPtrDefault' file='libvirt' type='virConnectAuthPtr'/>
655 656 657 658 659 660 661 662
    <function name='virConnCopyLastError' file='virterror' module='virterror'>
      <info>Copy the content of the last error caught on that connection One will need to free the result with virResetError()</info>
      <return type='int' info='0 if no error was found and the error code otherwise and -1 in case of parameter error.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='to' type='virErrorPtr' info='target to receive the copy'/>
    </function>
    <function name='virConnGetLastError' file='virterror' module='virterror'>
      <info>Provide a pointer to the last error caught on that connection Simpler but may not be suitable for multithreaded accesses, in which case use virConnCopyLastError()</info>
663
      <return type='virErrorPtr' info='a pointer to the last error or NULL if none occurred.'/>
664 665 666 667 668 669 670 671 672 673 674 675 676 677
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
    <function name='virConnResetLastError' file='virterror' module='virterror'>
      <info>Reset the last error caught on that connection</info>
      <return type='void'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
    <function name='virConnSetErrorFunc' file='virterror' module='virterror'>
      <info>Set a connection error handling function, if @handler is NULL it will reset to default which is to pass error back to the global library handler.</info>
      <return type='void'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='userData' type='void *' info='pointer to the user data provided in the handler callback'/>
      <arg name='handler' type='virErrorFunc' info='the function to get called in case of error or NULL'/>
    </function>
678 679 680 681 682 683 684
    <functype name='virConnectAuthCallbackPtr' file='libvirt' module='libvirt'>
      <info></info>
      <return type='int' info=''/>
      <arg name='cred' type='virConnectCredentialPtr' info=''/>
      <arg name='ncred' type='unsigned int' info=''/>
      <arg name='cbdata' type='void *' info=''/>
    </functype>
685 686 687 688 689
    <function name='virConnectClose' file='libvirt' module='libvirt'>
      <info>This function closes the connection to the Hypervisor. This should not be called if further interaction with the Hypervisor are needed especially if there is running domain which need further monitoring by the application.</info>
      <return type='int' info='0 in case of success or -1 in case of error.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
690 691 692 693 694 695 696 697
    <function name='virConnectFindStoragePoolSources' file='libvirt' module='libvirt'>
      <info>Talks to a storage backend and attempts to auto-discover the set of available storage pool sources. e.g. For iSCSI this would be a set of iSCSI targets. For NFS this would be a list of exported paths.  The srcSpec (optional for some storage pool types, e.g. local ones) is an instance of the storage pool&apos;s source element specifying where to look for the pools.  srcSpec is not required for some types (e.g., those querying local storage resources only)</info>
      <return type='char *' info='an xml document consisting of a SourceList element containing a source document appropriate to the given pool type for each discovered source.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='type' type='const char *' info='type of storage pool sources to discover'/>
      <arg name='srcSpec' type='const char *' info='XML document specifying discovery source'/>
      <arg name='flags' type='unsigned int' info='flags for discovery (unused, pass 0)'/>
    </function>
698 699
    <function name='virConnectGetCapabilities' file='libvirt' module='libvirt'>
      <info>Provides capabilities of the hypervisor / driver.</info>
700
      <return type='char *' info='NULL in case of error, or an XML string defining the capabilities. The client must free the returned string after use.'/>
701 702
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
703 704 705 706 707
    <function name='virConnectGetHostname' file='libvirt' module='libvirt'>
      <info>This returns the system hostname on which the hypervisor is running (the result of the gethostname(2) system call).  If we are connected to a remote system, then this returns the hostname of the remote system.</info>
      <return type='char *' info='the hostname which must be freed by the caller, or NULL if there was an error.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to a hypervisor connection'/>
    </function>
708
    <function name='virConnectGetMaxVcpus' file='libvirt' module='libvirt'>
709 710
      <info>Provides the maximum number of virtual CPUs supported for a guest VM of a specific type. The &apos;type&apos; parameter here corresponds to the &apos;type&apos; attribute in the &lt;domain&gt; element of the XML.</info>
      <return type='int' info='the maximum of virtual CPU or -1 in case of error.'/>
711 712 713
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='type' type='const char *' info='value of the &apos;type&apos; attribute in the &lt;domain&gt; element'/>
    </function>
714 715
    <function name='virConnectGetType' file='libvirt' module='libvirt'>
      <info>Get the name of the Hypervisor software used.</info>
716
      <return type='const char *' info='NULL in case of error, a static zero terminated string otherwise.  See also: http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html'/>
717 718
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
719 720 721 722 723
    <function name='virConnectGetURI' file='libvirt' module='libvirt'>
      <info>This returns the URI (name) of the hypervisor connection. Normally this is the same as or similar to the string passed to the virConnectOpen/virConnectOpenReadOnly call, but the driver may make the URI canonical.  If name == NULL was passed to virConnectOpen, then the driver will return a non-NULL URI which can be used to connect to the same hypervisor later.</info>
      <return type='char *' info='the URI string which must be freed by the caller, or NULL if there was an error.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to a hypervisor connection'/>
    </function>
724
    <function name='virConnectGetVersion' file='libvirt' module='libvirt'>
725
      <info>Get the version level of the Hypervisor running. This may work only with hypervisor call, i.e. with privileged access to the hypervisor, not with a Read-Only connection.</info>
726 727 728 729 730
      <return type='int' info='-1 in case of error, 0 otherwise. if the version can&apos;t be extracted by lack of capacities returns 0 and @hvVer is 0, otherwise @hvVer value is major * 1,000,000 + minor * 1,000 + release'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='hvVer' type='unsigned long *' info='return value for the version of the running hypervisor (OUT)'/>
    </function>
    <function name='virConnectListDefinedDomains' file='libvirt' module='libvirt'>
731
      <info>list the defined but inactive domains, stores the pointers to the names in @names</info>
732 733
      <return type='int' info='the number of names provided in the array or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
734
      <arg name='names' type='char ** const' info='pointer to an array to store the names'/>
735 736
      <arg name='maxnames' type='int' info='size of the array'/>
    </function>
737 738 739 740
    <function name='virConnectListDefinedNetworks' file='libvirt' module='libvirt'>
      <info>list the inactive networks, stores the pointers to the names in @names</info>
      <return type='int' info='the number of names provided in the array or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
741
      <arg name='names' type='char ** const' info='pointer to an array to store the names'/>
742 743
      <arg name='maxnames' type='int' info='size of the array'/>
    </function>
744 745 746 747 748 749 750
    <function name='virConnectListDefinedStoragePools' file='libvirt' module='libvirt'>
      <info>Provides the list of names of inactive storage pools upto maxnames. If there are more than maxnames, the remaining names will be silently ignored.</info>
      <return type='int' info='0 on success, -1 on error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='names' type='char ** const' info='array of char * to fill with pool names (allocated by caller)'/>
      <arg name='maxnames' type='int' info='size of the names array'/>
    </function>
751 752 753 754 755 756 757
    <function name='virConnectListDomains' file='libvirt' module='libvirt'>
      <info>Collect the list of active domains, and store their ID in @maxids</info>
      <return type='int' info='the number of domain found or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='ids' type='int *' info='array to collect the list of IDs of active domains'/>
      <arg name='maxids' type='int' info='size of @ids'/>
    </function>
758 759 760 761
    <function name='virConnectListNetworks' file='libvirt' module='libvirt'>
      <info>Collect the list of active networks, and store their names in @names</info>
      <return type='int' info='the number of networks found or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
762
      <arg name='names' type='char ** const' info='array to collect the list of names of active networks'/>
763 764
      <arg name='maxnames' type='int' info='size of @names'/>
    </function>
765 766 767 768 769 770 771
    <function name='virConnectListStoragePools' file='libvirt' module='libvirt'>
      <info>Provides the list of names of active storage pools upto maxnames. If there are more than maxnames, the remaining names will be silently ignored.</info>
      <return type='int' info='0 on success, -1 on error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='names' type='char ** const' info='array of char * to fill with pool names (allocated by caller)'/>
      <arg name='maxnames' type='int' info='size of the names array'/>
    </function>
772
    <function name='virConnectNumOfDefinedDomains' file='libvirt' module='libvirt'>
773
      <info>Provides the number of defined but inactive domains.</info>
774 775 776
      <return type='int' info='the number of domain found or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
777 778 779 780 781
    <function name='virConnectNumOfDefinedNetworks' file='libvirt' module='libvirt'>
      <info>Provides the number of inactive networks.</info>
      <return type='int' info='the number of networks found or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
782 783 784 785 786
    <function name='virConnectNumOfDefinedStoragePools' file='libvirt' module='libvirt'>
      <info>Provides the number of inactive storage pools</info>
      <return type='int' info='the number of pools found, or -1 on error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
    </function>
787 788 789 790 791
    <function name='virConnectNumOfDomains' file='libvirt' module='libvirt'>
      <info>Provides the number of active domains.</info>
      <return type='int' info='the number of domain found or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
792 793 794 795 796
    <function name='virConnectNumOfNetworks' file='libvirt' module='libvirt'>
      <info>Provides the number of active networks.</info>
      <return type='int' info='the number of network found or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
797 798 799 800 801
    <function name='virConnectNumOfStoragePools' file='libvirt' module='libvirt'>
      <info>Provides the number of active storage pools</info>
      <return type='int' info='the number of pools found, or -1 on error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
    </function>
802 803
    <function name='virConnectOpen' file='libvirt' module='libvirt'>
      <info>This function should be called first to get a connection to the Hypervisor and xen store</info>
804 805
      <return type='virConnectPtr' info='a pointer to the hypervisor connection or NULL in case of error  URIs are documented at http://libvirt.org/uri.html'/>
      <arg name='name' type='const char *' info='URI of the hypervisor'/>
806
    </function>
807
    <function name='virConnectOpenAuth' file='libvirt' module='libvirt'>
808
      <info>This function should be called first to get a connection to the Hypervisor. If necessary, authentication will be performed fetching credentials via the callback</info>
809 810 811 812 813
      <return type='virConnectPtr' info='a pointer to the hypervisor connection or NULL in case of error  URIs are documented at http://libvirt.org/uri.html'/>
      <arg name='name' type='const char *' info='URI of the hypervisor'/>
      <arg name='auth' type='virConnectAuthPtr' info='Authenticate callback parameters'/>
      <arg name='flags' type='int' info='Open flags'/>
    </function>
814
    <function name='virConnectOpenReadOnly' file='libvirt' module='libvirt'>
D
Daniel Veillard 已提交
815
      <info>This function should be called first to get a restricted connection to the library functionalities. The set of APIs usable are then restricted on the available methods to control the domains.</info>
816 817
      <return type='virConnectPtr' info='a pointer to the hypervisor connection or NULL in case of error  URIs are documented at http://libvirt.org/uri.html'/>
      <arg name='name' type='const char *' info='URI of the hypervisor'/>
818 819 820 821 822 823 824 825 826 827 828
    </function>
    <function name='virCopyLastError' file='virterror' module='virterror'>
      <info>Copy the content of the last error caught at the library level One will need to free the result with virResetError()</info>
      <return type='int' info='0 if no error was found and the error code otherwise and -1 in case of parameter error.'/>
      <arg name='to' type='virErrorPtr' info='target to receive the copy'/>
    </function>
    <function name='virDefaultErrorFunc' file='virterror' module='virterror'>
      <info>Default routine reporting an error to stderr.</info>
      <return type='void'/>
      <arg name='err' type='virErrorPtr' info='pointer to the error.'/>
    </function>
D
Daniel Veillard 已提交
829 830 831 832
    <function name='virDomainAttachDevice' file='libvirt' module='libvirt'>
      <info>Create a virtual device attachment to backend.</info>
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
833
      <arg name='xml' type='const char *' info='pointer to XML description of one device'/>
D
Daniel Veillard 已提交
834
    </function>
835 836 837 838 839 840 841 842 843 844
    <function name='virDomainBlockPeek' file='libvirt' module='libvirt'>
      <info>This function allows you to read the contents of a domain&apos;s disk device.  Typical uses for this are to determine if the domain has written a Master Boot Record (indicating that the domain has completed installation), or to try to work out the state of the domain&apos;s filesystems.  (Note that in the local case you might try to open the block device or file directly, but that won&apos;t work in the remote case, nor if you don&apos;t have sufficient permission. Hence the need for this call).  &apos;path&apos; must be a device or file corresponding to the domain. In other words it must be the precise string returned in a &lt;disk&gt;&lt;source dev=&apos;...&apos;/&gt;&lt;/disk&gt; from virDomainGetXMLDesc.  &apos;offset&apos; and &apos;size&apos; represent an area which must lie entirely within the device or file.  &apos;size&apos; may be 0 to test if the call would succeed.  &apos;buffer&apos; is the return buffer and must be at least &apos;size&apos; bytes.  NB. The remote driver imposes a 64K byte limit on &apos;size&apos;. For your program to be able to work reliably over a remote connection you should split large requests to &lt;= 65536 bytes.</info>
      <return type='int' info='0 in case of success or -1 in case of failure. really 64 bits'/>
      <arg name='dom' type='virDomainPtr' info='pointer to the domain object'/>
      <arg name='path' type='const char *' info='path to the block device'/>
      <arg name='offset' type='unsigned long long' info='offset within block device'/>
      <arg name='size' type='size_t' info='size to read'/>
      <arg name='buffer' type='void *' info='return buffer (must be at least size bytes)'/>
      <arg name='flags' type='unsigned int' info='unused, always pass 0'/>
    </function>
845 846 847 848 849 850 851 852
    <function name='virDomainBlockStats' file='libvirt' module='libvirt'>
      <info>This function returns block device (disk) stats for block devices attached to the domain.  The path parameter is the name of the block device.  Get this by calling virDomainGetXMLDesc and finding the &lt;target dev=&apos;...&apos;&gt; attribute within //domain/devices/disk.  (For example, &quot;xvda&quot;).  Domains may have more than one block device.  To get stats for each you should make multiple calls to this function.  Individual fields within the stats structure may be returned as -1, which indicates that the hypervisor does not support that particular statistic.</info>
      <return type='int' info='0 in case of success or -1 in case of failure.'/>
      <arg name='dom' type='virDomainPtr' info='pointer to the domain object'/>
      <arg name='path' type='const char *' info='path to the block device'/>
      <arg name='stats' type='virDomainBlockStatsPtr' info='block device stats (returned)'/>
      <arg name='size' type='size_t' info='size of stats structure'/>
    </function>
D
Daniel Veillard 已提交
853 854 855 856 857 858 859
    <function name='virDomainCoreDump' file='libvirt' module='libvirt'>
      <info>This method will dump the core of a domain on a given file for analysis. Note that for remote Xen Daemon the file path will be interpreted in the remote host.</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='to' type='const char *' info='path for the core file'/>
      <arg name='flags' type='int' info='extra flags, currently unused'/>
    </function>
860 861 862 863 864 865
    <function name='virDomainCreate' file='libvirt' module='libvirt'>
      <info>launch a defined domain. If the call succeed the domain moves from the defined to the running domains pools.</info>
      <return type='int' info='0 in case of success, -1 in case of error'/>
      <arg name='domain' type='virDomainPtr' info='pointer to a defined domain'/>
    </function>
    <function name='virDomainCreateLinux' file='libvirt' module='libvirt'>
866
      <info>Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires privileged access to the hypervisor. The domain is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted (see virDomainDefineXML() to define persistent domains).</info>
867 868
      <return type='virDomainPtr' info='a new domain object or NULL in case of failure'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
D
Daniel Veillard 已提交
869
      <arg name='xmlDesc' type='const char *' info='string containing an XML description of the domain'/>
870 871 872
      <arg name='flags' type='unsigned int' info='an optional set of virDomainFlags'/>
    </function>
    <function name='virDomainDefineXML' file='libvirt' module='libvirt'>
873
      <info>Define a domain, but does not start it. This definition is persistent, until explicitly undefined with virDomainUndefine().</info>
874 875 876 877 878
      <return type='virDomainPtr' info='NULL in case of error, a pointer to the domain otherwise'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='xml' type='const char *' info='the XML description for the domain, preferably in UTF-8'/>
    </function>
    <function name='virDomainDestroy' file='libvirt' module='libvirt'>
879
      <info>Destroy the domain object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. This does not free the associated virDomainPtr object. This function may require privileged access</info>
880 881 882
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
D
Daniel Veillard 已提交
883 884 885 886
    <function name='virDomainDetachDevice' file='libvirt' module='libvirt'>
      <info>Destroy a virtual device attachment to backend.</info>
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
887
      <arg name='xml' type='const char *' info='pointer to XML description of one device'/>
D
Daniel Veillard 已提交
888
    </function>
889 890 891 892 893
    <function name='virDomainFree' file='libvirt' module='libvirt'>
      <info>Free the domain object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
894
    <function name='virDomainGetAutostart' file='libvirt' module='libvirt'>
895 896
      <info>Provides a boolean value indicating whether the domain configured to be automatically started when the host machine boots.</info>
      <return type='int' info='-1 in case of error, 0 in case of success'/>
897
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
898
      <arg name='autostart' type='int *' info='the value returned'/>
899
    </function>
900
    <function name='virDomainGetConnect' file='libvirt' module='libvirt'>
901
      <info>Provides the connection pointer associated with a domain.  The reference counter on the connection is not increased by this call.  WARNING: When writing libvirt bindings in other languages, do not use this function.  Instead, store the connection and the domain object together.</info>
902
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
903 904
      <arg name='dom' type='virDomainPtr' info='pointer to a domain'/>
    </function>
905 906 907 908 909 910
    <function name='virDomainGetID' file='libvirt' module='libvirt'>
      <info>Get the hypervisor ID number for the domain</info>
      <return type='unsigned int' info='the domain ID number or (unsigned int) -1 in case of error'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
    <function name='virDomainGetInfo' file='libvirt' module='libvirt'>
911
      <info>Extract information about a domain. Note that if the connection used to get the domain is limited only a partial set of the information can be extracted.</info>
912 913 914 915 916 917 918 919 920
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='info' type='virDomainInfoPtr' info='pointer to a virDomainInfo structure allocated by the user'/>
    </function>
    <function name='virDomainGetMaxMemory' file='libvirt' module='libvirt'>
      <info>Retrieve the maximum amount of physical memory allocated to a domain. If domain is NULL, then this get the amount of memory reserved to Domain0 i.e. the domain where the application runs.</info>
      <return type='unsigned long' info='the memory size in kilobytes or 0 in case of error.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object or NULL'/>
    </function>
921
    <function name='virDomainGetMaxVcpus' file='libvirt' module='libvirt'>
922 923
      <info>Provides the maximum number of virtual CPUs supported for the guest VM. If the guest is inactive, this is basically the same as virConnectGetMaxVcpus. If the guest is running this will reflect the maximum number of virtual CPUs the guest was booted with.</info>
      <return type='int' info='the maximum of virtual CPU or -1 in case of error.'/>
924 925
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
    </function>
926 927 928 929 930 931 932 933 934 935
    <function name='virDomainGetName' file='libvirt' module='libvirt'>
      <info>Get the public name for that domain</info>
      <return type='const char *' info='a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the domain object.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
    <function name='virDomainGetOSType' file='libvirt' module='libvirt'>
      <info>Get the type of domain operation system.</info>
      <return type='char *' info='the new string or NULL in case of error, the string must be freed by the caller.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
936 937 938 939 940 941 942 943 944 945 946 947 948
    <function name='virDomainGetSchedulerParameters' file='libvirt' module='libvirt'>
      <info>Get the scheduler parameters, the @params array will be filled with the values.</info>
      <return type='int' info='-1 in case of error, 0 in case of success.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
      <arg name='params' type='virSchedParameterPtr' info='pointer to scheduler parameter object (return value)'/>
      <arg name='nparams' type='int *' info='pointer to number of scheduler parameter (this value should be same than the returned value nparams of virDomainGetSchedulerType)'/>
    </function>
    <function name='virDomainGetSchedulerType' file='libvirt' module='libvirt'>
      <info>Get the scheduler type.</info>
      <return type='char *' info='NULL in case of error. The caller must free the returned string.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
      <arg name='nparams' type='int *' info='number of scheduler parameters(return value)'/>
    </function>
949 950 951 952
    <function name='virDomainGetUUID' file='libvirt' module='libvirt'>
      <info>Get the UUID for a domain</info>
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
953
      <arg name='uuid' type='unsigned char *' info='pointer to a VIR_UUID_BUFLEN bytes array'/>
954 955 956 957 958
    </function>
    <function name='virDomainGetUUIDString' file='libvirt' module='libvirt'>
      <info>Get the UUID for a domain as string. For more information about UUID see RFC4122.</info>
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
959
      <arg name='buf' type='char *' info='pointer to a VIR_UUID_STRING_BUFLEN bytes array'/>
960
    </function>
961
    <function name='virDomainGetVcpus' file='libvirt' module='libvirt'>
D
Daniel Veillard 已提交
962
      <info>Extract information about virtual CPUs of domain, store it in info array and also in cpumaps if this pointer isn&apos;t NULL.</info>
963 964 965 966
      <return type='int' info='the number of info filled in case of success, -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object, or NULL for Domain0'/>
      <arg name='info' type='virVcpuInfoPtr' info='pointer to an array of virVcpuInfo structures (OUT)'/>
      <arg name='maxinfo' type='int' info='number of structures in info array'/>
D
Daniel Veillard 已提交
967
      <arg name='cpumaps' type='unsigned char *' info='pointer to an bit map of real CPUs for all vcpus of this domain (in 8-bit bytes) (OUT) If cpumaps is NULL, then no cpumap information is returned by the API. It&apos;s assumed there is &lt;maxinfo&gt; cpumap in cpumaps array. The memory allocated to cpumaps must be (maxinfo * maplen) bytes (ie: calloc(maxinfo, maplen)). One cpumap inside cpumaps has the format described in virDomainPinVcpu() API.'/>
968 969
      <arg name='maplen' type='int' info='number of bytes in one cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...).'/>
    </function>
970 971 972 973
    <function name='virDomainGetXMLDesc' file='libvirt' module='libvirt'>
      <info>Provide an XML description of the domain. The description may be reused later to relaunch the domain with virDomainCreateLinux().</info>
      <return type='char *' info='a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. the caller must free() the returned value.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
974
      <arg name='flags' type='int' info='an OR&apos;ed set of virDomainXMLFlags'/>
975
    </function>
976 977 978 979 980 981 982 983
    <function name='virDomainInterfaceStats' file='libvirt' module='libvirt'>
      <info>This function returns network interface stats for interfaces attached to the domain.  The path parameter is the name of the network interface.  Domains may have more than network interface.  To get stats for each you should make multiple calls to this function.  Individual fields within the stats structure may be returned as -1, which indicates that the hypervisor does not support that particular statistic.</info>
      <return type='int' info='0 in case of success or -1 in case of failure.'/>
      <arg name='dom' type='virDomainPtr' info='pointer to the domain object'/>
      <arg name='path' type='const char *' info='path to the interface'/>
      <arg name='stats' type='virDomainInterfaceStatsPtr' info='network interface stats (returned)'/>
      <arg name='size' type='size_t' info='size of stats structure'/>
    </function>
984
    <function name='virDomainLookupByID' file='libvirt' module='libvirt'>
985
      <info>Try to find a domain based on the hypervisor ID number Note that this won&apos;t work for inactive domains which have an ID of -1, in that case a lookup based on the Name or UUId need to be done instead.</info>
986
      <return type='virDomainPtr' info='a new domain object or NULL in case of failure.  If the domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.'/>
987 988 989 990 991
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='id' type='int' info='the domain ID number'/>
    </function>
    <function name='virDomainLookupByName' file='libvirt' module='libvirt'>
      <info>Try to lookup a domain on the given hypervisor based on its name.</info>
992
      <return type='virDomainPtr' info='a new domain object or NULL in case of failure.  If the domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.'/>
993 994 995 996 997
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='name' type='const char *' info='name for the domain'/>
    </function>
    <function name='virDomainLookupByUUID' file='libvirt' module='libvirt'>
      <info>Try to lookup a domain on the given hypervisor based on its UUID.</info>
998
      <return type='virDomainPtr' info='a new domain object or NULL in case of failure.  If the domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.'/>
999 1000 1001 1002 1003
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='uuid' type='const unsigned char *' info='the raw UUID for the domain'/>
    </function>
    <function name='virDomainLookupByUUIDString' file='libvirt' module='libvirt'>
      <info>Try to lookup a domain on the given hypervisor based on its UUID.</info>
1004
      <return type='virDomainPtr' info='a new domain object or NULL in case of failure.  If the domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.'/>
1005 1006 1007
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='uuidstr' type='const char *' info='the string UUID for the domain'/>
    </function>
1008 1009 1010 1011 1012 1013 1014 1015 1016
    <function name='virDomainMemoryPeek' file='libvirt' module='libvirt'>
      <info>This function allows you to read the contents of a domain&apos;s memory.  The memory which is read is controlled by the &apos;start&apos;, &apos;size&apos; and &apos;flags&apos; parameters.  If &apos;flags&apos; is VIR_MEMORY_VIRTUAL then the &apos;start&apos; and &apos;size&apos; parameters are interpreted as virtual memory addresses for whichever task happens to be running on the domain at the moment.  Although this sounds haphazard it is in fact what you want in order to read Linux kernel state, because it ensures that pointers in the kernel image can be interpreted coherently.  &apos;buffer&apos; is the return buffer and must be at least &apos;size&apos; bytes. &apos;size&apos; may be 0 to test if the call would succeed.  NB. The remote driver imposes a 64K byte limit on &apos;size&apos;. For your program to be able to work reliably over a remote connection you should split large requests to &lt;= 65536 bytes.</info>
      <return type='int' info='0 in case of success or -1 in case of failure. really 64 bits'/>
      <arg name='dom' type='virDomainPtr' info='pointer to the domain object'/>
      <arg name='start' type='unsigned long long' info='start of memory to peek'/>
      <arg name='size' type='size_t' info='size of memory to peek'/>
      <arg name='buffer' type='void *' info='return buffer (must be at least size bytes)'/>
      <arg name='flags' type='unsigned int' info='flags, see below'/>
    </function>
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
    <function name='virDomainMigrate' file='libvirt' module='libvirt'>
      <info>Migrate the domain object from its current host to the destination host given by dconn (a connection to the destination host).  Flags may be one of more of the following: VIR_MIGRATE_LIVE   Attempt a live migration.  If a hypervisor supports renaming domains during migration, then you may set the dname parameter to the new name (otherwise it keeps the same name).  If this is not supported by the hypervisor, dname must be NULL or else you will get an error.  Since typically the two hypervisors connect directly to each other in order to perform the migration, you may need to specify a path from the source to the destination.  This is the purpose of the uri parameter.  If uri is NULL, then libvirt will try to find the best method.  Uri may specify the hostname or IP address of the destination host as seen from the source.  Or uri may be a URI giving transport, hostname, user, port, etc. in the usual form.  Refer to driver documentation for the particular URIs supported.  The maximum bandwidth (in Mbps) that will be used to do migration can be specified with the bandwidth parameter.  If set to 0, libvirt will choose a suitable default.  Some hypervisors do not support this feature and will return an error if bandwidth is not 0.  To see which features are supported by the current hypervisor, see virConnectGetCapabilities, /capabilities/host/migration_features.  There are many limitations on migration imposed by the underlying technology - for example it may not be possible to migrate between different processors even with the same architecture, or between different types of hypervisor.</info>
      <return type='virDomainPtr' info='the new domain object if the migration was successful, or NULL in case of error.  Note that the new domain object exists in the scope of the destination connection (dconn).'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='dconn' type='virConnectPtr' info='destination host (a connection object)'/>
      <arg name='flags' type='unsigned long' info='flags'/>
      <arg name='dname' type='const char *' info='(optional) rename domain to this at destination'/>
      <arg name='uri' type='const char *' info='(optional) dest hostname/URI as seen from the source host'/>
      <arg name='bandwidth' type='unsigned long' info='(optional) specify migration bandwidth limit in Mbps'/>
    </function>
1027
    <function name='virDomainPinVcpu' file='libvirt' module='libvirt'>
1028
      <info>Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires privileged access to the hypervisor.</info>
1029 1030 1031 1032 1033 1034
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object, or NULL for Domain0'/>
      <arg name='vcpu' type='unsigned int' info='virtual CPU number'/>
      <arg name='cpumap' type='unsigned char *' info='pointer to a bit map of real CPUs (in 8-bit bytes) (IN) Each bit set to 1 means that corresponding CPU is usable. Bytes are stored in little-endian order: CPU0-7, 8-15... In each byte, lowest CPU number is least significant bit.'/>
      <arg name='maplen' type='int' info='number of bytes in cpumap, from 1 up to size of CPU map in underlying virtualization system (Xen...). If maplen &lt; size, missing bytes are set to zero. If maplen &gt; size, failure code is returned.'/>
    </function>
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
    <function name='virDomainReboot' file='libvirt' module='libvirt'>
      <info>Reboot a domain, the domain object is still usable there after but the domain OS is being stopped for a restart. Note that the guest OS may ignore the request.</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='flags' type='unsigned int' info='extra flags for the reboot operation, not used yet'/>
    </function>
    <function name='virDomainRestore' file='libvirt' module='libvirt'>
      <info>This method will restore a domain saved to disk by virDomainSave().</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='from' type='const char *' info='path to the'/>
    </function>
    <function name='virDomainResume' file='libvirt' module='libvirt'>
1048
      <info>Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires privileged access</info>
1049 1050 1051 1052 1053 1054 1055 1056 1057
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
    <function name='virDomainSave' file='libvirt' module='libvirt'>
      <info>This method will suspend a domain and save its memory contents to a file on disk. After the call, if successful, the domain is not listed as running anymore (this may be a problem). Use virDomainRestore() to restore a domain after saving.</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='to' type='const char *' info='path for the output file'/>
    </function>
1058 1059 1060 1061
    <function name='virDomainSetAutostart' file='libvirt' module='libvirt'>
      <info>Configure the domain to be automatically started when the host machine boots.</info>
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
1062
      <arg name='autostart' type='int' info='whether the domain should be automatically started 0 or 1'/>
1063
    </function>
1064
    <function name='virDomainSetMaxMemory' file='libvirt' module='libvirt'>
1065
      <info>Dynamically change the maximum amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function requires privileged access to the hypervisor.</info>
1066 1067 1068 1069 1070
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object or NULL'/>
      <arg name='memory' type='unsigned long' info='the memory size in kilobytes'/>
    </function>
    <function name='virDomainSetMemory' file='libvirt' module='libvirt'>
1071
      <info>Dynamically change the target amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function may requires privileged access to the hypervisor.</info>
1072 1073 1074 1075
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object or NULL'/>
      <arg name='memory' type='unsigned long' info='the memory size in kilobytes'/>
    </function>
1076 1077 1078 1079 1080 1081 1082
    <function name='virDomainSetSchedulerParameters' file='libvirt' module='libvirt'>
      <info>Change the scheduler parameters</info>
      <return type='int' info='-1 in case of error, 0 in case of success.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
      <arg name='params' type='virSchedParameterPtr' info='pointer to scheduler parameter objects'/>
      <arg name='nparams' type='int' info='number of scheduler parameter (this value should be same or less than the returned value nparams of virDomainGetSchedulerType)'/>
    </function>
1083
    <function name='virDomainSetVcpus' file='libvirt' module='libvirt'>
1084
      <info>Dynamically change the number of virtual CPUs used by the domain. Note that this call may fail if the underlying virtualization hypervisor does not support it or if growing the number is arbitrary limited. This function requires privileged access to the hypervisor.</info>
1085 1086 1087 1088
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object, or NULL for Domain0'/>
      <arg name='nvcpus' type='unsigned int' info='the new number of virtual CPUs for this domain'/>
    </function>
1089 1090 1091 1092 1093 1094
    <function name='virDomainShutdown' file='libvirt' module='libvirt'>
      <info>Shutdown a domain, the domain object is still usable there after but the domain OS is being stopped. Note that the guest OS may ignore the request.  TODO: should we add an option for reboot, knowing it may not be doable in the general case ?</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
    <function name='virDomainSuspend' file='libvirt' module='libvirt'>
1095
      <info>Suspends an active domain, the process is frozen without further access to CPU resources and I/O but the memory used by the domain at the hypervisor level will stay allocated. Use virDomainResume() to reactivate the domain. This function may requires privileged access.</info>
1096 1097 1098 1099
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
    <function name='virDomainUndefine' file='libvirt' module='libvirt'>
1100
      <info>Undefine a domain but does not stop it if it is running</info>
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
      <return type='int' info='0 in case of success, -1 in case of error'/>
      <arg name='domain' type='virDomainPtr' info='pointer to a defined domain'/>
    </function>
    <functype name='virErrorFunc' file='virterror' module='virterror'>
      <info>Signature of a function to use when there is an error raised by the library.</info>
      <return type='void'/>
      <arg name='userData' type='void *' info='user provided data for the error callback'/>
      <arg name='error' type='virErrorPtr' info='the error being raised.'/>
    </functype>
    <function name='virGetLastError' file='virterror' module='virterror'>
      <info>Provide a pointer to the last error caught at the library level Simpler but may not be suitable for multithreaded accesses, in which case use virCopyLastError()</info>
1112
      <return type='virErrorPtr' info='a pointer to the last error or NULL if none occurred.'/>
1113 1114
    </function>
    <function name='virGetVersion' file='libvirt' module='libvirt'>
D
Daniel Veillard 已提交
1115
      <info>Provides two information back, @libVer is the version of the library while @typeVer will be the version of the hypervisor type @type against which the library was compiled. If @type is NULL, &quot;Xen&quot; is assumed, if @type is unknown or not available, an error code will be returned and @typeVer will be 0.</info>
1116 1117 1118 1119 1120 1121 1122 1123 1124
      <return type='int' info='-1 in case of failure, 0 otherwise, and values for @libVer and @typeVer have the format major * 1,000,000 + minor * 1,000 + release.'/>
      <arg name='libVer' type='unsigned long *' info='return value for the library version (OUT)'/>
      <arg name='type' type='const char *' info='the type of connection/driver looked at'/>
      <arg name='typeVer' type='unsigned long *' info='return value for the version of the hypervisor (OUT)'/>
    </function>
    <function name='virInitialize' file='libvirt' module='libvirt'>
      <info>Initialize the library. It&apos;s better to call this routine at startup in multithreaded applications to avoid potential race when initializing the library.</info>
      <return type='int' info='0 in case of success, -1 in case of error'/>
    </function>
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
    <function name='virNetworkCreate' file='libvirt' module='libvirt'>
      <info>Create and start a defined network. If the call succeed the network moves from the defined to the running networks pools.</info>
      <return type='int' info='0 in case of success, -1 in case of error'/>
      <arg name='network' type='virNetworkPtr' info='pointer to a defined network'/>
    </function>
    <function name='virNetworkCreateXML' file='libvirt' module='libvirt'>
      <info>Create and start a new virtual network, based on an XML description similar to the one returned by virNetworkGetXMLDesc()</info>
      <return type='virNetworkPtr' info='a new network object or NULL in case of failure'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='xmlDesc' type='const char *' info='an XML description of the network'/>
    </function>
    <function name='virNetworkDefineXML' file='libvirt' module='libvirt'>
      <info>Define a network, but does not create it</info>
      <return type='virNetworkPtr' info='NULL in case of error, a pointer to the network otherwise'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='xml' type='const char *' info='the XML description for the network, preferably in UTF-8'/>
    </function>
    <function name='virNetworkDestroy' file='libvirt' module='libvirt'>
1143
      <info>Destroy the network object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. This does not free the associated virNetworkPtr object. This function may require privileged access</info>
1144 1145 1146 1147 1148 1149 1150 1151
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='network' type='virNetworkPtr' info='a network object'/>
    </function>
    <function name='virNetworkFree' file='libvirt' module='libvirt'>
      <info>Free the network object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='network' type='virNetworkPtr' info='a network object'/>
    </function>
1152
    <function name='virNetworkGetAutostart' file='libvirt' module='libvirt'>
1153 1154
      <info>Provides a boolean value indicating whether the network configured to be automatically started when the host machine boots.</info>
      <return type='int' info='-1 in case of error, 0 in case of success'/>
1155
      <arg name='network' type='virNetworkPtr' info='a network object'/>
1156
      <arg name='autostart' type='int *' info='the value returned'/>
1157
    </function>
1158
    <function name='virNetworkGetBridgeName' file='libvirt' module='libvirt'>
1159 1160
      <info>Provides a bridge interface name to which a domain may connect a network interface in order to join the network.</info>
      <return type='char *' info='a 0 terminated interface name, or NULL in case of error. the caller must free() the returned value.'/>
1161 1162
      <arg name='network' type='virNetworkPtr' info='a network object'/>
    </function>
1163
    <function name='virNetworkGetConnect' file='libvirt' module='libvirt'>
1164
      <info>Provides the connection pointer associated with a network.  The reference counter on the connection is not increased by this call.  WARNING: When writing libvirt bindings in other languages, do not use this function.  Instead, store the connection and the network object together.</info>
1165
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
1166 1167
      <arg name='net' type='virNetworkPtr' info='pointer to a network'/>
    </function>
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192
    <function name='virNetworkGetName' file='libvirt' module='libvirt'>
      <info>Get the public name for that network</info>
      <return type='const char *' info='a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the network object.'/>
      <arg name='network' type='virNetworkPtr' info='a network object'/>
    </function>
    <function name='virNetworkGetUUID' file='libvirt' module='libvirt'>
      <info>Get the UUID for a network</info>
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='network' type='virNetworkPtr' info='a network object'/>
      <arg name='uuid' type='unsigned char *' info='pointer to a VIR_UUID_BUFLEN bytes array'/>
    </function>
    <function name='virNetworkGetUUIDString' file='libvirt' module='libvirt'>
      <info>Get the UUID for a network as string. For more information about UUID see RFC4122.</info>
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='network' type='virNetworkPtr' info='a network object'/>
      <arg name='buf' type='char *' info='pointer to a VIR_UUID_STRING_BUFLEN bytes array'/>
    </function>
    <function name='virNetworkGetXMLDesc' file='libvirt' module='libvirt'>
      <info>Provide an XML description of the network. The description may be reused later to relaunch the network with virNetworkCreateXML().</info>
      <return type='char *' info='a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. the caller must free() the returned value.'/>
      <arg name='network' type='virNetworkPtr' info='a network object'/>
      <arg name='flags' type='int' info='and OR&apos;ed set of extraction flags, not used yet'/>
    </function>
    <function name='virNetworkLookupByName' file='libvirt' module='libvirt'>
      <info>Try to lookup a network on the given hypervisor based on its name.</info>
1193
      <return type='virNetworkPtr' info='a new network object or NULL in case of failure.  If the network cannot be found, then VIR_ERR_NO_NETWORK error is raised.'/>
1194 1195 1196 1197 1198
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='name' type='const char *' info='name for the network'/>
    </function>
    <function name='virNetworkLookupByUUID' file='libvirt' module='libvirt'>
      <info>Try to lookup a network on the given hypervisor based on its UUID.</info>
1199
      <return type='virNetworkPtr' info='a new network object or NULL in case of failure.  If the network cannot be found, then VIR_ERR_NO_NETWORK error is raised.'/>
1200 1201 1202 1203 1204
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='uuid' type='const unsigned char *' info='the raw UUID for the network'/>
    </function>
    <function name='virNetworkLookupByUUIDString' file='libvirt' module='libvirt'>
      <info>Try to lookup a network on the given hypervisor based on its UUID.</info>
1205
      <return type='virNetworkPtr' info='a new network object or NULL in case of failure.  If the network cannot be found, then VIR_ERR_NO_NETWORK error is raised.'/>
1206 1207 1208
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='uuidstr' type='const char *' info='the string UUID for the network'/>
    </function>
1209 1210 1211 1212
    <function name='virNetworkSetAutostart' file='libvirt' module='libvirt'>
      <info>Configure the network to be automatically started when the host machine boots.</info>
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='network' type='virNetworkPtr' info='a network object'/>
1213
      <arg name='autostart' type='int' info='whether the network should be automatically started 0 or 1'/>
1214
    </function>
1215 1216 1217 1218 1219
    <function name='virNetworkUndefine' file='libvirt' module='libvirt'>
      <info>Undefine a network but does not stop it if it is running</info>
      <return type='int' info='0 in case of success, -1 in case of error'/>
      <arg name='network' type='virNetworkPtr' info='pointer to a defined network'/>
    </function>
1220 1221 1222 1223 1224 1225 1226 1227
    <function name='virNodeGetCellsFreeMemory' file='libvirt' module='libvirt'>
      <info>This call returns the amount of free memory in one or more NUMA cells. The @freeMems array must be allocated by the caller and will be filled with the amount of free memory in kilobytes for each cell requested, starting with startCell (in freeMems[0]), up to either (startCell + maxCells), or the number of additional cells in the node, whichever is smaller.</info>
      <return type='int' info='the number of entries filled in freeMems, or -1 in case of error.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='freeMems' type='unsigned long long *' info='pointer to the array of unsigned long long'/>
      <arg name='startCell' type='int' info='index of first cell to return freeMems info on.'/>
      <arg name='maxCells' type='int' info='Maximum number of cells for which freeMems information can be returned.'/>
    </function>
1228
    <function name='virNodeGetFreeMemory' file='libvirt' module='libvirt'>
D
Daniel Veillard 已提交
1229
      <info>provides the free memory available on the Node</info>
1230 1231 1232
      <return type='unsigned long long' info='the available free memory in kilobytes or 0 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
    <function name='virNodeGetInfo' file='libvirt' module='libvirt'>
      <info>Extract hardware information about the node.</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='info' type='virNodeInfoPtr' info='pointer to a virNodeInfo structure allocated by the user'/>
    </function>
    <function name='virResetError' file='virterror' module='virterror'>
      <info>Reset the error being pointed to</info>
      <return type='void'/>
      <arg name='err' type='virErrorPtr' info='pointer to the virError to clean up'/>
    </function>
    <function name='virResetLastError' file='virterror' module='virterror'>
      <info>Reset the last error caught at the library level.</info>
      <return type='void'/>
    </function>
    <function name='virSetErrorFunc' file='virterror' module='virterror'>
      <info>Set a library global error handling function, if @handler is NULL, it will reset to default printing on stderr. The error raised there are those for which no handler at the connection level could caught.</info>
      <return type='void'/>
      <arg name='userData' type='void *' info='pointer to the user data provided in the handler callback'/>
      <arg name='handler' type='virErrorFunc' info='the function to get called in case of error or NULL'/>
    </function>
1254 1255 1256 1257
    <function name='virStoragePoolBuild' file='libvirt' module='libvirt'>
      <info>Build the underlying storage pool</info>
      <return type='int' info='0 on success, or -1 upon failure'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
1258
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
1259 1260 1261 1262 1263
    </function>
    <function name='virStoragePoolCreate' file='libvirt' module='libvirt'>
      <info>Starts an inactive storage pool</info>
      <return type='int' info='0 on success, or -1 if it could not be started'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
1264
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
1265 1266
    </function>
    <function name='virStoragePoolCreateXML' file='libvirt' module='libvirt'>
D
Daniel Veillard 已提交
1267
      <info>Create a new storage based on its XML description. The pool is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted</info>
1268 1269 1270
      <return type='virStoragePoolPtr' info='a virStoragePoolPtr object, or NULL if creation failed'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='xmlDesc' type='const char *' info='XML description for new pool'/>
1271
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
1272 1273
    </function>
    <function name='virStoragePoolDefineXML' file='libvirt' module='libvirt'>
D
Daniel Veillard 已提交
1274
      <info>Define a new inactive storage pool based on its XML description. The pool is persistent, until explicitly undefined.</info>
1275 1276 1277
      <return type='virStoragePoolPtr' info='a virStoragePoolPtr object, or NULL if creation failed'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='xml' type='const char *' info='XML description for new pool'/>
1278
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
    </function>
    <function name='virStoragePoolDelete' file='libvirt' module='libvirt'>
      <info>Delete the underlying pool resources. This is a non-recoverable operation. The virStoragePoolPtr object itself is not free&apos;d.</info>
      <return type='int' info='0 on success, or -1 if it could not be obliterate'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='flags' type='unsigned int' info='flags for obliteration process'/>
    </function>
    <function name='virStoragePoolDestroy' file='libvirt' module='libvirt'>
      <info>Destroy an active storage pool. This will deactivate the pool on the host, but keep any persistent config associated with it. If it has a persistent config it can later be restarted with virStoragePoolCreate(). This does not free the associated virStoragePoolPtr object.</info>
      <return type='int' info='0 on success, or -1 if it could not be destroyed'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
    </function>
    <function name='virStoragePoolFree' file='libvirt' module='libvirt'>
      <info>Free a storage pool object, releasing all memory associated with it. Does not change the state of the pool on the host.</info>
      <return type='int' info='0 on success, or -1 if it could not be free&apos;d.'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
    </function>
    <function name='virStoragePoolGetAutostart' file='libvirt' module='libvirt'>
      <info>Fetches the value of the autostart flag, which determines whether the pool is automatically started at boot time</info>
      <return type='int' info='0 on success, -1 on failure'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='autostart' type='int *' info='location in which to store autostart flag'/>
    </function>
    <function name='virStoragePoolGetConnect' file='libvirt' module='libvirt'>
      <info>Provides the connection pointer associated with a storage pool.  The reference counter on the connection is not increased by this call.  WARNING: When writing libvirt bindings in other languages, do not use this function.  Instead, store the connection and the pool object together.</info>
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
1305
      <arg name='pool' type='virStoragePoolPtr' info='pointer to a pool'/>
1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
    </function>
    <function name='virStoragePoolGetInfo' file='libvirt' module='libvirt'>
      <info>Get volatile information about the storage pool such as free space / usage summary</info>
      <return type='int' info='0 on success, or -1 on failure.'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='info' type='virStoragePoolInfoPtr' info='pointer at which to store info'/>
    </function>
    <function name='virStoragePoolGetName' file='libvirt' module='libvirt'>
      <info>Fetch the locally unique name of the storage pool</info>
      <return type='const char *' info='the name of the pool, or NULL on error'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
    </function>
    <function name='virStoragePoolGetUUID' file='libvirt' module='libvirt'>
      <info>Fetch the globally unique ID of the storage pool</info>
      <return type='int' info='0 on success, or -1 on error;'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='uuid' type='unsigned char *' info='buffer of VIR_UUID_BUFLEN bytes in size'/>
    </function>
    <function name='virStoragePoolGetUUIDString' file='libvirt' module='libvirt'>
      <info>Fetch the globally unique ID of the storage pool as a string</info>
      <return type='int' info='0 on success, or -1 on error;'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='buf' type='char *' info='buffer of VIR_UUID_STRING_BUFLEN bytes in size'/>
    </function>
    <function name='virStoragePoolGetXMLDesc' file='libvirt' module='libvirt'>
      <info>Fetch an XML document describing all aspects of the storage pool. This is suitable for later feeding back into the virStoragePoolCreateXML method.</info>
      <return type='char *' info='a XML document, or NULL on error'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
1334
      <arg name='flags' type='unsigned int' info='flags for XML format options (set of virDomainXMLFlags)'/>
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398
    </function>
    <function name='virStoragePoolListVolumes' file='libvirt' module='libvirt'>
      <info>Fetch list of storage volume names, limiting to at most maxnames.</info>
      <return type='int' info='the number of names fetched, or -1 on error'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='names' type='char ** const' info='array in which to storage volume names'/>
      <arg name='maxnames' type='int' info='size of names array'/>
    </function>
    <function name='virStoragePoolLookupByName' file='libvirt' module='libvirt'>
      <info>Fetch a storage pool based on its unique name</info>
      <return type='virStoragePoolPtr' info='a virStoragePoolPtr object, or NULL if no matching pool is found'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='name' type='const char *' info='name of pool to fetch'/>
    </function>
    <function name='virStoragePoolLookupByUUID' file='libvirt' module='libvirt'>
      <info>Fetch a storage pool based on its globally unique id</info>
      <return type='virStoragePoolPtr' info='a virStoragePoolPtr object, or NULL if no matching pool is found'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='uuid' type='const unsigned char *' info='globally unique id of pool to fetch'/>
    </function>
    <function name='virStoragePoolLookupByUUIDString' file='libvirt' module='libvirt'>
      <info>Fetch a storage pool based on its globally unique id</info>
      <return type='virStoragePoolPtr' info='a virStoragePoolPtr object, or NULL if no matching pool is found'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='uuidstr' type='const char *' info='globally unique id of pool to fetch'/>
    </function>
    <function name='virStoragePoolLookupByVolume' file='libvirt' module='libvirt'>
      <info>Fetch a storage pool which contains a particular volume</info>
      <return type='virStoragePoolPtr' info='a virStoragePoolPtr object, or NULL if no matching pool is found'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
    </function>
    <function name='virStoragePoolNumOfVolumes' file='libvirt' module='libvirt'>
      <info>Fetch the number of storage volumes within a pool</info>
      <return type='int' info='the number of storage pools, or -1 on failure'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
    </function>
    <function name='virStoragePoolRefresh' file='libvirt' module='libvirt'>
      <info>Request that the pool refresh its list of volumes. This may involve communicating with a remote server, and/or initializing new devices at the OS layer</info>
      <return type='int' info='0 if the volume list was refreshed, -1 on failure'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='flags' type='unsigned int' info='flags to control refresh behaviour (currently unused, use 0)'/>
    </function>
    <function name='virStoragePoolSetAutostart' file='libvirt' module='libvirt'>
      <info>Sets the autostart flag</info>
      <return type='int' info='0 on success, -1 on failure'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='autostart' type='int' info='new flag setting'/>
    </function>
    <function name='virStoragePoolUndefine' file='libvirt' module='libvirt'>
      <info>Undefine an inactive storage pool</info>
      <return type='int' info='a virStoragePoolPtr object, or NULL if creation failed'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
    </function>
    <function name='virStorageVolCreateXML' file='libvirt' module='libvirt'>
      <info>Create a storage volume within a pool based on an XML description. Not all pools support creation of volumes</info>
      <return type='virStorageVolPtr' info='the storage volume, or NULL on error'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='xmldesc' type='const char *' info='description of volume to create'/>
      <arg name='flags' type='unsigned int' info='flags for creation (unused, pass 0)'/>
    </function>
    <function name='virStorageVolDelete' file='libvirt' module='libvirt'>
      <info>Delete the storage volume from the pool</info>
      <return type='int' info='0 on success, or -1 on error'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
1399
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
1400 1401 1402 1403 1404 1405 1406 1407 1408
    </function>
    <function name='virStorageVolFree' file='libvirt' module='libvirt'>
      <info>Release the storage volume handle. The underlying storage volume contains to exist</info>
      <return type='int' info='0 on success, or -1 on error'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
    </function>
    <function name='virStorageVolGetConnect' file='libvirt' module='libvirt'>
      <info>Provides the connection pointer associated with a storage volume.  The reference counter on the connection is not increased by this call.  WARNING: When writing libvirt bindings in other languages, do not use this function.  Instead, store the connection and the volume object together.</info>
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
1409
      <arg name='vol' type='virStorageVolPtr' info='pointer to a pool'/>
1410 1411 1412 1413 1414 1415 1416 1417
    </function>
    <function name='virStorageVolGetInfo' file='libvirt' module='libvirt'>
      <info>Fetches volatile information about the storage volume such as its current allocation</info>
      <return type='int' info='0 on success, or -1 on failure'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
      <arg name='info' type='virStorageVolInfoPtr' info='pointer at which to store info'/>
    </function>
    <function name='virStorageVolGetKey' file='libvirt' module='libvirt'>
1418
      <info>Fetch the storage volume key. This is globally unique, so the same volume will have the same key no matter what host it is accessed from</info>
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455
      <return type='const char *' info='the volume key, or NULL on error'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
    </function>
    <function name='virStorageVolGetName' file='libvirt' module='libvirt'>
      <info>Fetch the storage volume name. This is unique within the scope of a pool</info>
      <return type='const char *' info='the volume name, or NULL on error'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
    </function>
    <function name='virStorageVolGetPath' file='libvirt' module='libvirt'>
      <info>Fetch the storage volume path. Depending on the pool configuration this is either persistent across hosts, or dynamically assigned at pool startup. Consult pool documentation for information on getting the persistent naming</info>
      <return type='char *' info='the storage volume path, or NULL on error'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
    </function>
    <function name='virStorageVolGetXMLDesc' file='libvirt' module='libvirt'>
      <info>Fetch an XML document describing all aspects of the storage volume</info>
      <return type='char *' info='the XML document, or NULL on error'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
      <arg name='flags' type='unsigned int' info='flags for XML generation (unused, pass 0)'/>
    </function>
    <function name='virStorageVolLookupByKey' file='libvirt' module='libvirt'>
      <info>Fetch a pointer to a storage volume based on its globally unique key</info>
      <return type='virStorageVolPtr' info='a storage volume, or NULL if not found / error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='key' type='const char *' info='globally unique key'/>
    </function>
    <function name='virStorageVolLookupByName' file='libvirt' module='libvirt'>
      <info>Fetch a pointer to a storage volume based on its name within a pool</info>
      <return type='virStorageVolPtr' info='a storage volume, or NULL if not found / error'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='name' type='const char *' info='name of storage volume'/>
    </function>
    <function name='virStorageVolLookupByPath' file='libvirt' module='libvirt'>
      <info>Fetch a pointer to a storage volume based on its locally (host) unique path</info>
      <return type='virStorageVolPtr' info='a storage volume, or NULL if not found / error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='path' type='const char *' info='locally unique path'/>
    </function>
1456 1457
  </symbols>
</api>