libvirt-api.xml 179.2 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
     <exports symbol='VIR_USE_CPU' type='macro'/>
11
     <exports symbol='VIR_SECURITY_DOI_BUFLEN' type='macro'/>
12
     <exports symbol='VIR_CPU_MAPLEN' type='macro'/>
13
     <exports symbol='VIR_SECURITY_LABEL_BUFLEN' type='macro'/>
14 15
     <exports symbol='VIR_CPU_USABLE' type='macro'/>
     <exports symbol='VIR_COPY_CPUMAP' type='macro'/>
16
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_LENGTH' type='macro'/>
17
     <exports symbol='VIR_SECURITY_MODEL_BUFLEN' type='macro'/>
18
     <exports symbol='VIR_UUID_STRING_BUFLEN' type='macro'/>
19
     <exports symbol='VIR_GET_CPUMAP' type='macro'/>
20
     <exports symbol='VIR_UUID_BUFLEN' type='macro'/>
21
     <exports symbol='VIR_UNUSE_CPU' type='macro'/>
22
     <exports symbol='VIR_DOMAIN_EVENT_DEFINED' type='enum'/>
23
     <exports symbol='VIR_CRED_EXTERNAL' type='enum'/>
24
     <exports symbol='VIR_DOMAIN_EVENT_STOPPED_CRASHED' type='enum'/>
25
     <exports symbol='VIR_EVENT_HANDLE_READABLE' type='enum'/>
26 27
     <exports symbol='VIR_DOMAIN_SHUTDOWN' type='enum'/>
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_UINT' type='enum'/>
28
     <exports symbol='VIR_STORAGE_POOL_BUILDING' type='enum'/>
29 30
     <exports symbol='VIR_CRED_CNONCE' type='enum'/>
     <exports symbol='VIR_CRED_ECHOPROMPT' type='enum'/>
31
     <exports symbol='VIR_DOMAIN_EVENT_STARTED_BOOTED' type='enum'/>
32 33
     <exports symbol='VIR_DOMAIN_EVENT_RESUMED' type='enum'/>
     <exports symbol='VIR_VCPU_OFFLINE' type='enum'/>
34
     <exports symbol='VIR_STORAGE_VOL_DELETE_NORMAL' type='enum'/>
35 36
     <exports symbol='VIR_STORAGE_POOL_RUNNING' type='enum'/>
     <exports symbol='VIR_STORAGE_POOL_BUILD_RESIZE' type='enum'/>
37
     <exports symbol='VIR_DOMAIN_EVENT_STOPPED_FAILED' type='enum'/>
38
     <exports symbol='VIR_CONNECT_RO' type='enum'/>
39
     <exports symbol='VIR_DOMAIN_EVENT_STOPPED' type='enum'/>
40
     <exports symbol='VIR_CRED_AUTHNAME' type='enum'/>
41
     <exports symbol='VIR_STORAGE_POOL_BUILD_REPAIR' type='enum'/>
42 43
     <exports symbol='VIR_CRED_LANGUAGE' type='enum'/>
     <exports symbol='VIR_CRED_NOECHOPROMPT' type='enum'/>
44
     <exports symbol='VIR_DOMAIN_EVENT_UNDEFINED' type='enum'/>
45
     <exports symbol='VIR_MIGRATE_LIVE' type='enum'/>
46 47
     <exports symbol='VIR_DOMAIN_EVENT_STOPPED_DESTROYED' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_DEFINED_ADDED' type='enum'/>
D
Daniel P. Berrange 已提交
48
     <exports symbol='VIR_SECRET_USAGE_TYPE_NONE' type='enum'/>
49
     <exports symbol='VIR_DOMAIN_EVENT_STARTED_MIGRATED' type='enum'/>
50
     <exports symbol='VIR_VCPU_BLOCKED' type='enum'/>
51
     <exports symbol='VIR_MEMORY_VIRTUAL' type='enum'/>
52 53
     <exports symbol='VIR_CRED_USERNAME' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_RESUMED_UNPAUSED' type='enum'/>
54
     <exports symbol='VIR_DOMAIN_RUNNING' type='enum'/>
D
Daniel Veillard 已提交
55
     <exports symbol='VIR_STORAGE_VOL_DELETE_ZEROED' type='enum'/>
56 57
     <exports symbol='VIR_EVENT_HANDLE_ERROR' type='enum'/>
     <exports symbol='VIR_DOMAIN_NOSTATE' type='enum'/>
58
     <exports symbol='VIR_DOMAIN_SHUTOFF' type='enum'/>
59 60
     <exports symbol='VIR_STORAGE_POOL_DELETE_ZEROED' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_STARTED_RESTORED' type='enum'/>
61
     <exports symbol='VIR_EVENT_HANDLE_WRITABLE' type='enum'/>
62 63
     <exports symbol='VIR_STORAGE_POOL_BUILD_NEW' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_SUSPENDED_PAUSED' type='enum'/>
64
     <exports symbol='VIR_STORAGE_POOL_DELETE_NORMAL' type='enum'/>
D
Daniel Veillard 已提交
65
     <exports symbol='VIR_MEMORY_PHYSICAL' type='enum'/>
66
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_INT' type='enum'/>
67
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_ULLONG' type='enum'/>
68
     <exports symbol='VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN' type='enum'/>
69
     <exports symbol='VIR_CRED_REALM' type='enum'/>
70
     <exports symbol='VIR_DOMAIN_EVENT_STARTED' type='enum'/>
71
     <exports symbol='VIR_STORAGE_VOL_FILE' type='enum'/>
D
Daniel P. Berrange 已提交
72
     <exports symbol='VIR_SECRET_USAGE_TYPE_VOLUME' type='enum'/>
73
     <exports symbol='VIR_EVENT_HANDLE_HANGUP' type='enum'/>
74
     <exports symbol='VIR_DOMAIN_PAUSED' type='enum'/>
75
     <exports symbol='VIR_STORAGE_POOL_DEGRADED' type='enum'/>
76 77
     <exports symbol='VIR_DOMAIN_EVENT_DEFINED_UPDATED' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_SUSPENDED_MIGRATED' type='enum'/>
78
     <exports symbol='VIR_DOMAIN_CRASHED' type='enum'/>
79
     <exports symbol='VIR_VCPU_RUNNING' type='enum'/>
80 81 82
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_DOUBLE' type='enum'/>
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_LLONG' type='enum'/>
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_BOOLEAN' type='enum'/>
83
     <exports symbol='VIR_DOMAIN_XML_INACTIVE' type='enum'/>
84
     <exports symbol='VIR_STORAGE_VOL_BLOCK' type='enum'/>
85
     <exports symbol='VIR_DOMAIN_NONE' type='enum'/>
86 87
     <exports symbol='VIR_DOMAIN_EVENT_UNDEFINED_REMOVED' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_RESUMED_MIGRATED' type='enum'/>
88
     <exports symbol='VIR_DOMAIN_BLOCKED' type='enum'/>
89 90 91 92
     <exports symbol='VIR_CRED_PASSPHRASE' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_STOPPED_SAVED' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_STOPPED_MIGRATED' type='enum'/>
     <exports symbol='VIR_STORAGE_POOL_INACTIVE' type='enum'/>
93
     <exports symbol='VIR_DOMAIN_XML_SECURE' type='enum'/>
94
     <exports symbol='VIR_DOMAIN_EVENT_SUSPENDED' type='enum'/>
95
     <exports symbol='virDomainBlockStatsStruct' type='typedef'/>
96
     <exports symbol='virDomainMigrateFlags' type='typedef'/>
97 98
     <exports symbol='virNodeInfo' type='typedef'/>
     <exports symbol='virNetwork' type='typedef'/>
99
     <exports symbol='virDomainEventResumedDetailType' type='typedef'/>
100 101
     <exports symbol='virDomainBlockStatsPtr' type='typedef'/>
     <exports symbol='virConnect' type='typedef'/>
102
     <exports symbol='virSecretPtr' type='typedef'/>
103
     <exports symbol='virDomainEventStartedDetailType' type='typedef'/>
104
     <exports symbol='virDomainInfo' type='typedef'/>
105
     <exports symbol='virStoragePoolDeleteFlags' type='typedef'/>
106
     <exports symbol='virEventHandleType' type='typedef'/>
107
     <exports symbol='virStoragePool' type='typedef'/>
108
     <exports symbol='virDomainEventType' type='typedef'/>
109
     <exports symbol='virDomainInterfaceStatsStruct' type='typedef'/>
110
     <exports symbol='virStoragePoolInfo' type='typedef'/>
111
     <exports symbol='virSecret' type='typedef'/>
112 113
     <exports symbol='virDomainState' type='typedef'/>
     <exports symbol='virDomain' type='typedef'/>
114
     <exports symbol='virDomainInterfaceStatsPtr' type='typedef'/>
115
     <exports symbol='virConnectAuthPtr' type='typedef'/>
116
     <exports symbol='virStorageVolInfo' type='typedef'/>
117
     <exports symbol='virSchedParameterType' type='typedef'/>
118
     <exports symbol='virSecurityLabel' type='typedef'/>
D
Daniel P. Berrange 已提交
119
     <exports symbol='virStorageVolInfoPtr' type='typedef'/>
120
     <exports symbol='virConnectCredentialPtr' type='typedef'/>
121
     <exports symbol='virStoragePoolPtr' type='typedef'/>
122 123 124
     <exports symbol='virNodeInfoPtr' type='typedef'/>
     <exports symbol='virNetworkPtr' type='typedef'/>
     <exports symbol='virDomainInfoPtr' type='typedef'/>
D
Daniel P. Berrange 已提交
125
     <exports symbol='virNodeDevice' type='typedef'/>
126
     <exports symbol='virConnectPtr' type='typedef'/>
127
     <exports symbol='virStorageVol' type='typedef'/>
D
Daniel P. Berrange 已提交
128
     <exports symbol='virNodeDevicePtr' type='typedef'/>
129
     <exports symbol='virInterface' type='typedef'/>
130
     <exports symbol='virSchedParameter' type='typedef'/>
131
     <exports symbol='virConnectFlags' type='typedef'/>
132
     <exports symbol='virDomainEventDefinedDetailType' type='typedef'/>
133
     <exports symbol='virInterfacePtr' type='typedef'/>
134
     <exports symbol='virDomainMemoryFlags' type='typedef'/>
135
     <exports symbol='virDomainEventStoppedDetailType' type='typedef'/>
136
     <exports symbol='virStorageVolPtr' type='typedef'/>
137
     <exports symbol='virVcpuState' type='typedef'/>
138
     <exports symbol='virStorageVolDeleteFlags' type='typedef'/>
139
     <exports symbol='virVcpuInfo' type='typedef'/>
140
     <exports symbol='virSchedParameterPtr' type='typedef'/>
141 142
     <exports symbol='virConnectAuth' type='typedef'/>
     <exports symbol='virConnectCredential' type='typedef'/>
143
     <exports symbol='virSecurityModelPtr' type='typedef'/>
144
     <exports symbol='virDomainEventSuspendedDetailType' type='typedef'/>
145
     <exports symbol='virVcpuInfoPtr' type='typedef'/>
146
     <exports symbol='virStoragePoolBuildFlags' type='typedef'/>
147
     <exports symbol='virDomainXMLFlags' type='typedef'/>
148
     <exports symbol='virStorageVolType' type='typedef'/>
149
     <exports symbol='virDomainEventUndefinedDetailType' type='typedef'/>
150
     <exports symbol='virDomainPtr' type='typedef'/>
151
     <exports symbol='virConnectCredentialType' type='typedef'/>
152 153
     <exports symbol='virStoragePoolState' type='typedef'/>
     <exports symbol='virStoragePoolInfoPtr' type='typedef'/>
154
     <exports symbol='virDomainCreateFlags' type='typedef'/>
155 156
     <exports symbol='virSecurityLabelPtr' type='typedef'/>
     <exports symbol='virSecurityModel' type='typedef'/>
D
Daniel P. Berrange 已提交
157
     <exports symbol='virSecretUsageType' type='typedef'/>
158
     <exports symbol='_virDomainInfo' type='struct'/>
159
     <exports symbol='_virConnectAuth' type='struct'/>
160
     <exports symbol='_virVcpuInfo' type='struct'/>
161
     <exports symbol='_virDomainInterfaceStats' type='struct'/>
162
     <exports symbol='_virStoragePoolInfo' type='struct'/>
163
     <exports symbol='_virConnectCredential' type='struct'/>
164
     <exports symbol='_virSecurityLabel' type='struct'/>
165
     <exports symbol='_virStorageVolInfo' type='struct'/>
166
     <exports symbol='_virSecurityModel' type='struct'/>
167 168
     <exports symbol='_virDomainBlockStats' type='struct'/>
     <exports symbol='_virNodeInfo' type='struct'/>
169 170
     <exports symbol='_virSchedParameter' type='struct'/>
     <exports symbol='virConnectAuthPtrDefault' type='variable'/>
171
     <exports symbol='virStoragePoolGetXMLDesc' type='function'/>
172
     <exports symbol='virSecretGetUUIDString' type='function'/>
173
     <exports symbol='virStorageVolGetKey' type='function'/>
174
     <exports symbol='virEventUpdateTimeoutFunc' type='function'/>
175
     <exports symbol='virDomainUndefine' type='function'/>
176 177
     <exports symbol='virDomainDefineXML' type='function'/>
     <exports symbol='virDomainShutdown' type='function'/>
178
     <exports symbol='virConnectListDefinedInterfaces' type='function'/>
179
     <exports symbol='virGetVersion' type='function'/>
180
     <exports symbol='virNodeGetCellsFreeMemory' type='function'/>
181
     <exports symbol='virInitialize' type='function'/>
D
Daniel P. Berrange 已提交
182
     <exports symbol='virNodeDeviceGetName' type='function'/>
183
     <exports symbol='virConnectNumOfSecrets' type='function'/>
184
     <exports symbol='virStoragePoolSetAutostart' type='function'/>
185
     <exports symbol='virConnectDomainXMLFromNative' type='function'/>
186 187
     <exports symbol='virNodeDeviceDettach' type='function'/>
     <exports symbol='virDomainGetSecurityLabel' type='function'/>
188
     <exports symbol='virConnectDomainEventDeregister' type='function'/>
189 190 191
     <exports symbol='virDomainGetSchedulerParameters' type='function'/>
     <exports symbol='virDomainLookupByUUIDString' type='function'/>
     <exports symbol='virConnectNumOfDefinedNetworks' type='function'/>
192
     <exports symbol='virConnectListStoragePools' type='function'/>
193
     <exports symbol='virNetworkGetUUID' type='function'/>
194
     <exports symbol='virInterfaceGetXMLDesc' type='function'/>
195 196 197
     <exports symbol='virStoragePoolGetConnect' type='function'/>
     <exports symbol='virConnectGetVersion' type='function'/>
     <exports symbol='virDomainFree' type='function'/>
198
     <exports symbol='virStorageVolRef' type='function'/>
199 200 201 202 203
     <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'/>
204
     <exports symbol='virNetworkCreate' type='function'/>
D
Daniel P. Berrange 已提交
205
     <exports symbol='virSecretLookupByUUID' type='function'/>
206
     <exports symbol='virDomainSetMaxMemory' type='function'/>
207
     <exports symbol='virEventRegisterImpl' type='function'/>
208
     <exports symbol='virInterfaceDefineXML' type='function'/>
209 210
     <exports symbol='virDomainMigrate' type='function'/>
     <exports symbol='virDomainSuspend' type='function'/>
211
     <exports symbol='virDomainCreateLinux' type='function'/>
D
Daniel P. Berrange 已提交
212
     <exports symbol='virNodeDeviceGetXMLDesc' type='function'/>
213
     <exports symbol='virEventUpdateHandleFunc' type='function'/>
214 215 216
     <exports symbol='virDomainDestroy' type='function'/>
     <exports symbol='virConnectNumOfNetworks' type='function'/>
     <exports symbol='virStoragePoolLookupByUUIDString' type='function'/>
217
     <exports symbol='virSecretGetConnect' type='function'/>
218
     <exports symbol='virInterfaceCreate' type='function'/>
219
     <exports symbol='virDomainGetXMLDesc' type='function'/>
D
Daniel P. Berrange 已提交
220
     <exports symbol='virSecretLookupByUsage' type='function'/>
221
     <exports symbol='virStoragePoolGetUUID' type='function'/>
D
Daniel P. Berrange 已提交
222
     <exports symbol='virNodeDeviceFree' type='function'/>
D
Daniel P. Berrange 已提交
223
     <exports symbol='virSecretGetUsageType' type='function'/>
224
     <exports symbol='virDomainGetInfo' type='function'/>
225
     <exports symbol='virNodeDeviceCreateXML' type='function'/>
226 227
     <exports symbol='virNetworkDestroy' type='function'/>
     <exports symbol='virStoragePoolLookupByName' type='function'/>
D
Daniel P. Berrange 已提交
228
     <exports symbol='virStoragePoolCreateXML' type='function'/>
229
     <exports symbol='virNetworkGetAutostart' type='function'/>
230
     <exports symbol='virNetworkGetBridgeName' type='function'/>
231
     <exports symbol='virStorageVolGetXMLDesc' type='function'/>
232
     <exports symbol='virConnectDomainXMLToNative' type='function'/>
233
     <exports symbol='virDomainSetSchedulerParameters' type='function'/>
234
     <exports symbol='virConnectGetType' type='function'/>
235
     <exports symbol='virStorageVolCreateXML' type='function'/>
236
     <exports symbol='virDomainSave' type='function'/>
237 238
     <exports symbol='virDomainCreate' type='function'/>
     <exports symbol='virConnectListDomains' type='function'/>
D
Daniel Veillard 已提交
239
     <exports symbol='virDomainCoreDump' type='function'/>
240
     <exports symbol='virDomainSetMemory' type='function'/>
241
     <exports symbol='virInterfaceGetName' type='function'/>
242
     <exports symbol='virStoragePoolCreate' type='function'/>
243
     <exports symbol='virNodeGetInfo' type='function'/>
244
     <exports symbol='virNetworkSetAutostart' type='function'/>
245
     <exports symbol='virSecretLookupByUUIDString' type='function'/>
D
Daniel Veillard 已提交
246
     <exports symbol='virDomainGetMaxMemory' type='function'/>
247
     <exports symbol='virStoragePoolFree' type='function'/>
D
Daniel Veillard 已提交
248
     <exports symbol='virConnectNumOfDefinedInterfaces' type='function'/>
D
Daniel P. Berrange 已提交
249
     <exports symbol='virFreeCallback' type='function'/>
250
     <exports symbol='virNetworkDefineXML' type='function'/>
D
Daniel P. Berrange 已提交
251
     <exports symbol='virNodeDeviceListCaps' type='function'/>
252
     <exports symbol='virDomainBlockStats' type='function'/>
253
     <exports symbol='virConnectOpenAuth' type='function'/>
254
     <exports symbol='virStoragePoolDelete' type='function'/>
255
     <exports symbol='virDomainResume' type='function'/>
256 257
     <exports symbol='virStorageVolGetName' type='function'/>
     <exports symbol='virStoragePoolGetAutostart' type='function'/>
258
     <exports symbol='virDomainGetAutostart' type='function'/>
259
     <exports symbol='virStoragePoolListVolumes' type='function'/>
260
     <exports symbol='virConnectGetHostname' type='function'/>
261
     <exports symbol='virEventRemoveTimeoutFunc' type='function'/>
D
Daniel P. Berrange 已提交
262
     <exports symbol='virStorageVolGetInfo' type='function'/>
263
     <exports symbol='virDomainGetName' type='function'/>
264
     <exports symbol='virStoragePoolRef' type='function'/>
265 266
     <exports symbol='virNetworkGetXMLDesc' type='function'/>
     <exports symbol='virConnectNumOfStoragePools' type='function'/>
267
     <exports symbol='virInterfaceGetConnect' type='function'/>
D
Daniel P. Berrange 已提交
268
     <exports symbol='virStoragePoolNumOfVolumes' type='function'/>
269
     <exports symbol='virNetworkGetName' type='function'/>
270
     <exports symbol='virSecretGetXMLDesc' type='function'/>
271 272 273
     <exports symbol='virConnectListDefinedDomains' type='function'/>
     <exports symbol='virConnectGetCapabilities' type='function'/>
     <exports symbol='virDomainLookupByName' type='function'/>
274
     <exports symbol='virConnectFindStoragePoolSources' type='function'/>
275
     <exports symbol='virStorageVolFree' type='function'/>
276
     <exports symbol='virDomainPinVcpu' type='function'/>
277
     <exports symbol='virNodeGetSecurityModel' type='function'/>
278
     <exports symbol='virDomainRestore' type='function'/>
D
Daniel P. Berrange 已提交
279
     <exports symbol='virSecretGetUUID' type='function'/>
D
Daniel Veillard 已提交
280
     <exports symbol='virNodeDeviceDestroy' type='function'/>
281 282
     <exports symbol='virStorageVolGetPath' type='function'/>
     <exports symbol='virNetworkLookupByUUIDString' type='function'/>
283
     <exports symbol='virConnectDomainEventCallback' type='function'/>
284
     <exports symbol='virDomainLookupByID' type='function'/>
285
     <exports symbol='virStorageVolDelete' type='function'/>
286
     <exports symbol='virSecretUndefine' type='function'/>
287
     <exports symbol='virConnectListInterfaces' type='function'/>
288
     <exports symbol='virDomainMemoryPeek' type='function'/>
289 290
     <exports symbol='virNetworkLookupByUUID' type='function'/>
     <exports symbol='virConnectListDefinedNetworks' type='function'/>
291
     <exports symbol='virConnectRef' type='function'/>
292 293
     <exports symbol='virDomainGetUUID' type='function'/>
     <exports symbol='virNetworkCreateXML' type='function'/>
D
Daniel Veillard 已提交
294
     <exports symbol='virNetworkUndefine' type='function'/>
295
     <exports symbol='virConnectDomainEventRegister' type='function'/>
296
     <exports symbol='virDomainGetVcpus' type='function'/>
D
Daniel P. Berrange 已提交
297
     <exports symbol='virNodeDeviceLookupByName' type='function'/>
298
     <exports symbol='virStoragePoolGetInfo' type='function'/>
299
     <exports symbol='virEventRemoveHandleFunc' type='function'/>
300 301
     <exports symbol='virInterfaceRef' type='function'/>
     <exports symbol='virInterfaceGetMACString' type='function'/>
D
Daniel Veillard 已提交
302
     <exports symbol='virConnectNumOfDomains' type='function'/>
303 304
     <exports symbol='virStoragePoolRefresh' type='function'/>
     <exports symbol='virConnectNumOfDefinedDomains' type='function'/>
305
     <exports symbol='virStorageVolCreateXMLFrom' type='function'/>
306
     <exports symbol='virConnectClose' type='function'/>
307 308 309 310
     <exports symbol='virDomainReboot' type='function'/>
     <exports symbol='virNetworkGetUUIDString' type='function'/>
     <exports symbol='virNetworkLookupByName' type='function'/>
     <exports symbol='virDomainGetMaxVcpus' type='function'/>
311
     <exports symbol='virEventHandleCallback' type='function'/>
312
     <exports symbol='virDomainGetSchedulerType' type='function'/>
313
     <exports symbol='virNodeDeviceReset' type='function'/>
314
     <exports symbol='virDomainDetachDevice' type='function'/>
D
Daniel P. Berrange 已提交
315
     <exports symbol='virSecretGetUsageID' type='function'/>
316
     <exports symbol='virStoragePoolGetUUIDString' type='function'/>
317
     <exports symbol='virNodeDeviceReAttach' type='function'/>
318
     <exports symbol='virStoragePoolUndefine' type='function'/>
319
     <exports symbol='virConnectAuthCallbackPtr' type='function'/>
320
     <exports symbol='virDomainAttachDevice' type='function'/>
321
     <exports symbol='virConnectGetURI' type='function'/>
322
     <exports symbol='virConnectOpenReadOnly' type='function'/>
323
     <exports symbol='virSecretDefineXML' type='function'/>
324 325
     <exports symbol='virNetworkFree' type='function'/>
     <exports symbol='virStoragePoolLookupByUUID' type='function'/>
326
     <exports symbol='virEventAddHandleFunc' type='function'/>
D
Daniel Veillard 已提交
327
     <exports symbol='virNetworkRef' type='function'/>
328
     <exports symbol='virConnectListDefinedStoragePools' type='function'/>
329
     <exports symbol='virEventTimeoutCallback' type='function'/>
330
     <exports symbol='virInterfaceFree' type='function'/>
D
Daniel P. Berrange 已提交
331
     <exports symbol='virNodeDeviceNumOfCaps' type='function'/>
332
     <exports symbol='virInterfaceLookupByMACString' type='function'/>
333 334
     <exports symbol='virNetworkGetConnect' type='function'/>
     <exports symbol='virNodeGetFreeMemory' type='function'/>
335
     <exports symbol='virInterfaceDestroy' type='function'/>
336
     <exports symbol='virSecretSetValue' type='function'/>
337
     <exports symbol='virStorageVolGetConnect' type='function'/>
D
Daniel P. Berrange 已提交
338
     <exports symbol='virNodeNumOfDevices' type='function'/>
339 340 341 342 343 344 345 346 347
     <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'/>
348
     <exports symbol='virSecretFree' type='function'/>
349
     <exports symbol='virNodeListDevices' type='function'/>
D
Daniel P. Berrange 已提交
350
     <exports symbol='virNodeDeviceGetParent' type='function'/>
351
     <exports symbol='virConnectOpen' type='function'/>
352
     <exports symbol='virDomainCreateXML' type='function'/>
353
     <exports symbol='virNodeDeviceRef' type='function'/>
354
     <exports symbol='virInterfaceUndefine' type='function'/>
355
     <exports symbol='virDomainSetVcpus' type='function'/>
356
     <exports symbol='virDomainRef' type='function'/>
357
     <exports symbol='virConnectListSecrets' type='function'/>
358
     <exports symbol='virConnectNumOfInterfaces' type='function'/>
359
     <exports symbol='virDomainGetID' type='function'/>
360
     <exports symbol='virSecretRef' type='function'/>
361
     <exports symbol='virDomainBlockPeek' type='function'/>
362
     <exports symbol='virEventAddTimeoutFunc' type='function'/>
363
     <exports symbol='virInterfaceLookupByName' type='function'/>
364 365
     <exports symbol='virDomainInterfaceStats' type='function'/>
     <exports symbol='virConnectListNetworks' type='function'/>
366
     <exports symbol='virSecretGetValue' type='function'/>
367
     <exports symbol='virStorageVolLookupByKey' type='function'/>
368 369 370 371 372 373
    </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>
     <exports symbol='VIR_ERR_NO_XEN' type='enum'/>
374
     <exports symbol='VIR_FROM_ONE' type='enum'/>
375
     <exports symbol='VIR_FROM_NETWORK' type='enum'/>
D
Daniel P. Berrange 已提交
376
     <exports symbol='VIR_ERR_NO_NODE_DEVICE' type='enum'/>
377
     <exports symbol='VIR_ERR_NO_MEMORY' type='enum'/>
D
Daniel P. Berrange 已提交
378
     <exports symbol='VIR_WAR_NO_NODE' type='enum'/>
379
     <exports symbol='VIR_ERR_NO_STORAGE_VOL' type='enum'/>
380
     <exports symbol='VIR_FROM_XML' type='enum'/>
381
     <exports symbol='VIR_FROM_CONF' type='enum'/>
382
     <exports symbol='VIR_ERR_INVALID_NETWORK' type='enum'/>
383
     <exports symbol='VIR_ERR_PARSE_FAILED' type='enum'/>
384 385
     <exports symbol='VIR_ERR_POST_FAILED' type='enum'/>
     <exports symbol='VIR_ERR_INVALID_CONN' type='enum'/>
386
     <exports symbol='VIR_ERR_GET_FAILED' type='enum'/>
D
Daniel P. Berrange 已提交
387
     <exports symbol='VIR_FROM_XEN' type='enum'/>
388 389
     <exports symbol='VIR_ERR_NO_SOURCE' type='enum'/>
     <exports symbol='VIR_ERR_NETWORK_EXIST' type='enum'/>
390
     <exports symbol='VIR_ERR_NONE' type='enum'/>
391 392 393 394 395 396
     <exports symbol='VIR_FROM_REMOTE' type='enum'/>
     <exports symbol='VIR_FROM_XEN_INOTIFY' type='enum'/>
     <exports symbol='VIR_ERR_NO_NETWORK' type='enum'/>
     <exports symbol='VIR_ERR_READ_FAILED' type='enum'/>
     <exports symbol='VIR_FROM_INTERFACE' type='enum'/>
     <exports symbol='VIR_ERR_NO_CONNECT' type='enum'/>
D
Daniel Veillard 已提交
397
     <exports symbol='VIR_FROM_ESX' type='enum'/>
398 399
     <exports symbol='VIR_FROM_VBOX' type='enum'/>
     <exports symbol='VIR_FROM_TEST' type='enum'/>
D
Daniel Veillard 已提交
400
     <exports symbol='VIR_ERR_MULTIPLE_INTERFACES' type='enum'/>
401 402 403 404 405 406 407 408 409
     <exports symbol='VIR_ERR_NO_DEVICE' type='enum'/>
     <exports symbol='VIR_FROM_SEXPR' type='enum'/>
     <exports symbol='VIR_ERR_INVALID_MAC' type='enum'/>
     <exports symbol='VIR_ERR_HTTP_ERROR' type='enum'/>
     <exports symbol='VIR_ERR_NO_XENSTORE' type='enum'/>
     <exports symbol='VIR_FROM_XEND' type='enum'/>
     <exports symbol='VIR_FROM_STATS_LINUX' type='enum'/>
     <exports symbol='VIR_FROM_OPENVZ' type='enum'/>
     <exports symbol='VIR_ERR_OS_TYPE' type='enum'/>
410
     <exports symbol='VIR_WAR_NO_SECRET' type='enum'/>
411 412
     <exports symbol='VIR_WAR_NO_NETWORK' type='enum'/>
     <exports symbol='VIR_FROM_UML' type='enum'/>
413 414 415
     <exports symbol='VIR_ERR_NO_NAME' type='enum'/>
     <exports symbol='VIR_ERR_NO_ROOT' type='enum'/>
     <exports symbol='VIR_ERR_OPERATION_FAILED' type='enum'/>
D
Daniel P. Berrange 已提交
416
     <exports symbol='VIR_FROM_NODEDEV' type='enum'/>
417
     <exports symbol='VIR_ERR_NO_TARGET' type='enum'/>
418
     <exports symbol='VIR_FROM_SECURITY' type='enum'/>
419
     <exports symbol='VIR_ERR_CONF_SYNTAX' type='enum'/>
420
     <exports symbol='VIR_ERR_NO_SUPPORT' type='enum'/>
421
     <exports symbol='VIR_ERR_NO_SECURITY_MODEL' type='enum'/>
D
Daniel Veillard 已提交
422
     <exports symbol='VIR_FROM_PHYP' type='enum'/>
423 424 425 426 427 428 429 430 431 432 433 434 435 436
     <exports symbol='VIR_ERR_SEXPR_SERIAL' type='enum'/>
     <exports symbol='VIR_FROM_XENSTORE' type='enum'/>
     <exports symbol='VIR_ERR_OPEN_FAILED' type='enum'/>
     <exports symbol='VIR_ERR_NO_OS' type='enum'/>
     <exports symbol='VIR_FROM_RPC' type='enum'/>
     <exports symbol='VIR_FROM_NONE' type='enum'/>
     <exports symbol='VIR_FROM_DOM' type='enum'/>
     <exports symbol='VIR_ERR_INVALID_DOMAIN' type='enum'/>
     <exports symbol='VIR_ERR_OPERATION_INVALID' type='enum'/>
     <exports symbol='VIR_WAR_NO_STORAGE' type='enum'/>
     <exports symbol='VIR_ERR_GNUTLS_ERROR' type='enum'/>
     <exports symbol='VIR_ERR_XML_ERROR' type='enum'/>
     <exports symbol='VIR_ERR_OK' type='enum'/>
     <exports symbol='VIR_FROM_STORAGE' type='enum'/>
437
     <exports symbol='VIR_FROM_PROXY' type='enum'/>
438 439
     <exports symbol='VIR_ERR_DRIVER_FULL' type='enum'/>
     <exports symbol='VIR_FROM_DOMAIN' type='enum'/>
440
     <exports symbol='VIR_ERR_INVALID_SECRET' type='enum'/>
441 442
     <exports symbol='VIR_ERR_OPERATION_DENIED' type='enum'/>
     <exports symbol='VIR_ERR_INVALID_STORAGE_POOL' type='enum'/>
443
     <exports symbol='VIR_FROM_SECRET' type='enum'/>
444
     <exports symbol='VIR_ERR_NO_DOMAIN' type='enum'/>
D
Daniel P. Berrange 已提交
445
     <exports symbol='VIR_ERR_INVALID_INTERFACE' type='enum'/>
446 447 448
     <exports symbol='VIR_ERR_RPC' type='enum'/>
     <exports symbol='VIR_ERR_WARNING' type='enum'/>
     <exports symbol='VIR_ERR_INVALID_ARG' type='enum'/>
D
Daniel Veillard 已提交
449
     <exports symbol='VIR_ERR_CALL_FAILED' type='enum'/>
450
     <exports symbol='VIR_ERR_ERROR' type='enum'/>
D
Daniel P. Berrange 已提交
451
     <exports symbol='VIR_ERR_NO_SECRET' type='enum'/>
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
     <exports symbol='VIR_WAR_NO_INTERFACE' type='enum'/>
     <exports symbol='VIR_ERR_DOM_EXIST' type='enum'/>
     <exports symbol='VIR_FROM_LXC' type='enum'/>
     <exports symbol='VIR_ERR_NO_STORAGE_POOL' type='enum'/>
     <exports symbol='VIR_ERR_NO_KERNEL' type='enum'/>
     <exports symbol='VIR_ERR_NO_INTERFACE' type='enum'/>
     <exports symbol='VIR_ERR_XML_DETAIL' type='enum'/>
     <exports symbol='VIR_FROM_NET' type='enum'/>
     <exports symbol='VIR_ERR_AUTH_FAILED' type='enum'/>
     <exports symbol='VIR_ERR_INVALID_NODE_DEVICE' type='enum'/>
     <exports symbol='VIR_ERR_SYSTEM_ERROR' type='enum'/>
     <exports symbol='VIR_FROM_QEMU' type='enum'/>
     <exports symbol='VIR_ERR_WRITE_FAILED' type='enum'/>
     <exports symbol='VIR_ERR_INTERNAL_ERROR' type='enum'/>
     <exports symbol='VIR_FROM_XENXM' type='enum'/>
     <exports symbol='VIR_ERR_INVALID_STORAGE_VOL' type='enum'/>
468 469 470 471 472 473 474 475
     <exports symbol='VIR_ERR_XEN_CALL' type='enum'/>
     <exports symbol='VIR_ERR_UNKNOWN_HOST' type='enum'/>
     <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'/>
476
     <exports symbol='virFreeError' type='function'/>
477 478 479 480 481 482 483 484 485 486 487
     <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'/>
488
     <exports symbol='virSaveLastError' type='function'/>
489
    </file>
490 491
  </files>
  <symbols>
492
    <macro name='LIBVIR_VERSION_NUMBER' file='libvirt'>
493
      <info><![CDATA[Macro providing the version of the library as version * 1,000,000 + minor * 1000 + micro]]></info>
494
    </macro>
495
    <macro name='VIR_COPY_CPUMAP' file='libvirt'>
496
      <info><![CDATA[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>
497 498 499 500 501 502
      <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'>
503
      <info><![CDATA[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 & all physical CPUs of a domain.]]></info>
504
      <arg name='cpu' info='number of physical CPUs'/>
505 506
    </macro>
    <macro name='VIR_CPU_USABLE' file='libvirt'>
507
      <info><![CDATA[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>
508 509 510 511 512
      <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>
513
    <macro name='VIR_DOMAIN_SCHED_FIELD_LENGTH' file='libvirt'>
514
      <info><![CDATA[Macro providing the field length of virSchedParameter]]></info>
515
    </macro>
516
    <macro name='VIR_GET_CPUMAP' file='libvirt'>
517
      <info><![CDATA[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>
518 519 520 521 522
      <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'>
523
      <info><![CDATA[This macro is to calculate the total number of CPUs supported but not necessary active in the host.]]></info>
524 525
      <arg name='nodeinfo' info='virNodeInfo instance'/>
    </macro>
526
    <macro name='VIR_SECURITY_DOI_BUFLEN' file='libvirt'>
527
      <info><![CDATA[Macro providing the maximum length of the virSecurityModel doi string.]]></info>
528 529
    </macro>
    <macro name='VIR_SECURITY_LABEL_BUFLEN' file='libvirt'>
530
      <info><![CDATA[Macro providing the maximum length of the virSecurityLabel label string. Note that this value is based on that used by Labeled NFS.]]></info>
531 532
    </macro>
    <macro name='VIR_SECURITY_MODEL_BUFLEN' file='libvirt'>
533
      <info><![CDATA[Macro providing the maximum length of the virSecurityModel model string.]]></info>
534
    </macro>
535
    <macro name='VIR_UNUSE_CPU' file='libvirt'>
536
      <info><![CDATA[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>
537 538 539 540
      <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'>
541
      <info><![CDATA[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>
542 543 544
      <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>
545
    <macro name='VIR_UUID_BUFLEN' file='libvirt'>
546
      <info><![CDATA[This macro provides the length of the buffer required for virDomainGetUUID()]]></info>
547 548
    </macro>
    <macro name='VIR_UUID_STRING_BUFLEN' file='libvirt'>
549
      <info><![CDATA[This macro provides the length of the buffer required for virDomainGetUUIDString()]]></info>
550
    </macro>
551 552 553 554 555 556 557 558 559 560
    <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'/>
561 562
    <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'/>
563 564 565
    <enum name='VIR_DOMAIN_EVENT_DEFINED' file='libvirt' value='0' type='virDomainEventType'/>
    <enum name='VIR_DOMAIN_EVENT_DEFINED_ADDED' file='libvirt' value='0' type='virDomainEventDefinedDetailType' info='Newly created config file'/>
    <enum name='VIR_DOMAIN_EVENT_DEFINED_UPDATED' file='libvirt' value='1' type='virDomainEventDefinedDetailType' info=' Changed config file'/>
566
    <enum name='VIR_DOMAIN_EVENT_RESUMED' file='libvirt' value='4' type='virDomainEventType'/>
567 568
    <enum name='VIR_DOMAIN_EVENT_RESUMED_MIGRATED' file='libvirt' value='1' type='virDomainEventResumedDetailType' info=' Resumed for completion of migration'/>
    <enum name='VIR_DOMAIN_EVENT_RESUMED_UNPAUSED' file='libvirt' value='0' type='virDomainEventResumedDetailType' info='Normal resume due to admin unpause'/>
569
    <enum name='VIR_DOMAIN_EVENT_STARTED' file='libvirt' value='2' type='virDomainEventType'/>
570 571 572
    <enum name='VIR_DOMAIN_EVENT_STARTED_BOOTED' file='libvirt' value='0' type='virDomainEventStartedDetailType' info='Normal startup from boot'/>
    <enum name='VIR_DOMAIN_EVENT_STARTED_MIGRATED' file='libvirt' value='1' type='virDomainEventStartedDetailType' info='Incoming migration from another host'/>
    <enum name='VIR_DOMAIN_EVENT_STARTED_RESTORED' file='libvirt' value='2' type='virDomainEventStartedDetailType' info=' Restored from a state file'/>
573
    <enum name='VIR_DOMAIN_EVENT_STOPPED' file='libvirt' value='5' type='virDomainEventType'/>
574 575 576 577 578 579
    <enum name='VIR_DOMAIN_EVENT_STOPPED_CRASHED' file='libvirt' value='2' type='virDomainEventStoppedDetailType' info='Guest crashed'/>
    <enum name='VIR_DOMAIN_EVENT_STOPPED_DESTROYED' file='libvirt' value='1' type='virDomainEventStoppedDetailType' info='Forced poweroff from host'/>
    <enum name='VIR_DOMAIN_EVENT_STOPPED_FAILED' file='libvirt' value='5' type='virDomainEventStoppedDetailType' info=' Host emulator/mgmt failed'/>
    <enum name='VIR_DOMAIN_EVENT_STOPPED_MIGRATED' file='libvirt' value='3' type='virDomainEventStoppedDetailType' info='Migrated off to another host'/>
    <enum name='VIR_DOMAIN_EVENT_STOPPED_SAVED' file='libvirt' value='4' type='virDomainEventStoppedDetailType' info='Saved to a state file'/>
    <enum name='VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN' file='libvirt' value='0' type='virDomainEventStoppedDetailType' info='Normal shutdown'/>
580
    <enum name='VIR_DOMAIN_EVENT_SUSPENDED' file='libvirt' value='3' type='virDomainEventType'/>
581 582 583 584
    <enum name='VIR_DOMAIN_EVENT_SUSPENDED_MIGRATED' file='libvirt' value='1' type='virDomainEventSuspendedDetailType' info=' Suspended for offline migration'/>
    <enum name='VIR_DOMAIN_EVENT_SUSPENDED_PAUSED' file='libvirt' value='0' type='virDomainEventSuspendedDetailType' info='Normal suspend due to admin pause'/>
    <enum name='VIR_DOMAIN_EVENT_UNDEFINED' file='libvirt' value='1' type='virDomainEventType'/>
    <enum name='VIR_DOMAIN_EVENT_UNDEFINED_REMOVED' file='libvirt' value='0' type='virDomainEventUndefinedDetailType' info=' Deleted the config file'/>
585 586 587 588
    <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'/>
589 590 591 592 593 594
    <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'/>
595 596
    <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'/>
597 598
    <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'/>
599
    <enum name='VIR_ERR_AUTH_FAILED' file='virterror' value='45' type='virErrorNumber' info='authentication failed'/>
600
    <enum name='VIR_ERR_CALL_FAILED' file='virterror' value='26' type='virErrorNumber' info='not supported by the drivers (DEPRECATED)'/>
601
    <enum name='VIR_ERR_CONF_SYNTAX' file='virterror' value='33' type='virErrorNumber' info='failed to parse the syntax of a conf file'/>
602
    <enum name='VIR_ERR_DOM_EXIST' file='virterror' value='28' type='virErrorNumber' info='the domain already exist'/>
603 604 605
    <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'/>
606
    <enum name='VIR_ERR_GNUTLS_ERROR' file='virterror' value='40' type='virErrorNumber' info='error from a GNUTLS call'/>
607 608 609 610 611
    <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'/>
D
Daniel Veillard 已提交
612
    <enum name='VIR_ERR_INVALID_INTERFACE' file='virterror' value='58' type='virErrorNumber' info='invalid interface object'/>
613
    <enum name='VIR_ERR_INVALID_MAC' file='virterror' value='44' type='virErrorNumber' info='invalid MAC address'/>
614
    <enum name='VIR_ERR_INVALID_NETWORK' file='virterror' value='36' type='virErrorNumber' info='invalid network object'/>
D
Daniel P. Berrange 已提交
615
    <enum name='VIR_ERR_INVALID_NODE_DEVICE' file='virterror' value='52' type='virErrorNumber' info='invalid node device object'/>
D
Daniel P. Berrange 已提交
616
    <enum name='VIR_ERR_INVALID_SECRET' file='virterror' value='61' type='virErrorNumber' info='invalid secret'/>
617 618
    <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'/>
619
    <enum name='VIR_ERR_MULTIPLE_INTERFACES' file='virterror' value='59' type='virErrorNumber' info='more than one matching interface found'/>
620
    <enum name='VIR_ERR_NETWORK_EXIST' file='virterror' value='37' type='virErrorNumber' info='the network already exist'/>
621 622 623
    <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'/>
624
    <enum name='VIR_ERR_NO_DOMAIN' file='virterror' value='42' type='virErrorNumber' info='domain not found or unexpectedly disappeared'/>
625
    <enum name='VIR_ERR_NO_INTERFACE' file='virterror' value='57' type='virErrorNumber' info='interface driver not running'/>
626 627 628
    <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'/>
629
    <enum name='VIR_ERR_NO_NETWORK' file='virterror' value='43' type='virErrorNumber' info='network not found'/>
630
    <enum name='VIR_ERR_NO_NODE_DEVICE' file='virterror' value='53' type='virErrorNumber' info='node device not found'/>
631 632
    <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'/>
D
Daniel P. Berrange 已提交
633
    <enum name='VIR_ERR_NO_SECRET' file='virterror' value='62' type='virErrorNumber' info=' secret not found'/>
634
    <enum name='VIR_ERR_NO_SECURITY_MODEL' file='virterror' value='54' type='virErrorNumber' info='security model not found'/>
635
    <enum name='VIR_ERR_NO_SOURCE' file='virterror' value='19' type='virErrorNumber' info='missing source device information'/>
636
    <enum name='VIR_ERR_NO_STORAGE_POOL' file='virterror' value='49' type='virErrorNumber' info='storage pool not found'/>
D
Daniel P. Berrange 已提交
637
    <enum name='VIR_ERR_NO_STORAGE_VOL' file='virterror' value='50' type='virErrorNumber' info='storage pool not found'/>
638
    <enum name='VIR_ERR_NO_SUPPORT' file='virterror' value='3' type='virErrorNumber' info='no support for this function'/>
639 640 641 642
    <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'/>
643 644
    <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'/>
645
    <enum name='VIR_ERR_OPERATION_FAILED' file='virterror' value='9' type='virErrorNumber' info='a command to hypervisor failed'/>
646
    <enum name='VIR_ERR_OPERATION_INVALID' file='virterror' value='55' type='virErrorNumber' info='operation is not applicable at this time'/>
647
    <enum name='VIR_ERR_OS_TYPE' file='virterror' value='16' type='virErrorNumber' info='unknown OS type'/>
648
    <enum name='VIR_ERR_PARSE_FAILED' file='virterror' value='32' type='virErrorNumber' info='failed to parse a conf file'/>
649
    <enum name='VIR_ERR_POST_FAILED' file='virterror' value='11' type='virErrorNumber' info='a HTTP POST command to failed'/>
650
    <enum name='VIR_ERR_READ_FAILED' file='virterror' value='31' type='virErrorNumber' info='failed to read a conf file'/>
651
    <enum name='VIR_ERR_RPC' file='virterror' value='39' type='virErrorNumber' info='some sort of RPC error'/>
652
    <enum name='VIR_ERR_SEXPR_SERIAL' file='virterror' value='13' type='virErrorNumber' info='failure to serialize an S-Expr'/>
653
    <enum name='VIR_ERR_SYSTEM_ERROR' file='virterror' value='38' type='virErrorNumber' info='general system call failure'/>
654 655
    <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'/>
656
    <enum name='VIR_ERR_WRITE_FAILED' file='virterror' value='34' type='virErrorNumber' info='failed to write a conf file'/>
657
    <enum name='VIR_ERR_XEN_CALL' file='virterror' value='15' type='virErrorNumber' info='failure doing an hypervisor call'/>
658
    <enum name='VIR_ERR_XML_DETAIL' file='virterror' value='35' type='virErrorNumber' info='detail of an XML error'/>
659
    <enum name='VIR_ERR_XML_ERROR' file='virterror' value='27' type='virErrorNumber' info='an XML description is not well formed or broken'/>
660 661 662 663
    <enum name='VIR_EVENT_HANDLE_ERROR' file='libvirt' value='4' type='virEventHandleType'/>
    <enum name='VIR_EVENT_HANDLE_HANGUP' file='libvirt' value='8' type='virEventHandleType'/>
    <enum name='VIR_EVENT_HANDLE_READABLE' file='libvirt' value='1' type='virEventHandleType'/>
    <enum name='VIR_EVENT_HANDLE_WRITABLE' file='libvirt' value='2' type='virEventHandleType'/>
664
    <enum name='VIR_FROM_CONF' file='virterror' value='9' type='virErrorDomain' info='Error in the configuration file handling'/>
665
    <enum name='VIR_FROM_DOM' file='virterror' value='6' type='virErrorDomain' info='Error when operating on a domain'/>
D
Daniel P. Berrange 已提交
666
    <enum name='VIR_FROM_DOMAIN' file='virterror' value='20' type='virErrorDomain' info='Error from domain config'/>
D
Daniel Veillard 已提交
667
    <enum name='VIR_FROM_ESX' file='virterror' value='28' type='virErrorDomain' info='Error from ESX driver'/>
668
    <enum name='VIR_FROM_INTERFACE' file='virterror' value='26' type='virErrorDomain' info='Error when operating on an interface'/>
D
Daniel Veillard 已提交
669
    <enum name='VIR_FROM_LXC' file='virterror' value='17' type='virErrorDomain' info='Error from Linux Container driver'/>
670
    <enum name='VIR_FROM_NET' file='virterror' value='11' type='virErrorDomain' info='Error when operating on a network'/>
671
    <enum name='VIR_FROM_NETWORK' file='virterror' value='19' type='virErrorDomain' info='Error from network config'/>
D
Daniel Veillard 已提交
672
    <enum name='VIR_FROM_NODEDEV' file='virterror' value='22' type='virErrorDomain' info='Error from node device monitor'/>
673
    <enum name='VIR_FROM_NONE' file='virterror' value='0' type='virErrorDomain'/>
D
Daniel Veillard 已提交
674
    <enum name='VIR_FROM_ONE' file='virterror' value='27' type='virErrorDomain' info='Error from OpenNebula driver'/>
R
Richard W.M. Jones 已提交
675
    <enum name='VIR_FROM_OPENVZ' file='virterror' value='14' type='virErrorDomain' info='Error from OpenVZ driver'/>
676
    <enum name='VIR_FROM_PHYP' file='virterror' value='29' type='virErrorDomain' info='Error from IBM power hypervisor'/>
677
    <enum name='VIR_FROM_PROXY' file='virterror' value='8' type='virErrorDomain' info='Error in the proxy code'/>
678
    <enum name='VIR_FROM_QEMU' file='virterror' value='10' type='virErrorDomain' info='Error at the QEMU daemon'/>
679
    <enum name='VIR_FROM_REMOTE' file='virterror' value='13' type='virErrorDomain' info='Error from remote driver'/>
680
    <enum name='VIR_FROM_RPC' file='virterror' value='7' type='virErrorDomain' info='Error in the XML-RPC code'/>
681
    <enum name='VIR_FROM_SECRET' file='virterror' value='30' type='virErrorDomain' info=' Error from secret storage'/>
682
    <enum name='VIR_FROM_SECURITY' file='virterror' value='24' type='virErrorDomain' info='Error from security framework'/>
683
    <enum name='VIR_FROM_SEXPR' file='virterror' value='4' type='virErrorDomain' info='Error in the S-Expression code'/>
684
    <enum name='VIR_FROM_STATS_LINUX' file='virterror' value='16' type='virErrorDomain' info='Error in the Linux Stats code'/>
685
    <enum name='VIR_FROM_STORAGE' file='virterror' value='18' type='virErrorDomain' info='Error from storage driver'/>
686
    <enum name='VIR_FROM_TEST' file='virterror' value='12' type='virErrorDomain' info='Error from test driver'/>
D
Daniel P. Berrange 已提交
687
    <enum name='VIR_FROM_UML' file='virterror' value='21' type='virErrorDomain' info='Error at the UML driver'/>
688
    <enum name='VIR_FROM_VBOX' file='virterror' value='25' type='virErrorDomain' info='Error from VirtualBox driver'/>
689 690 691
    <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 已提交
692
    <enum name='VIR_FROM_XENXM' file='virterror' value='15' type='virErrorDomain' info='Error at Xen XM layer'/>
693
    <enum name='VIR_FROM_XEN_INOTIFY' file='virterror' value='23' type='virErrorDomain' info='Error from xen inotify layer'/>
694
    <enum name='VIR_FROM_XML' file='virterror' value='5' type='virErrorDomain' info='Error in the XML code'/>
D
Daniel Veillard 已提交
695 696
    <enum name='VIR_MEMORY_PHYSICAL' file='libvirt' value='2' type='virDomainMemoryFlags' info=' addresses are physical addresses'/>
    <enum name='VIR_MEMORY_VIRTUAL' file='libvirt' value='1' type='virDomainMemoryFlags' info='addresses are virtual addresses'/>
697
    <enum name='VIR_MIGRATE_LIVE' file='libvirt' value='1' type='virDomainMigrateFlags' info=' live migration'/>
D
Daniel P. Berrange 已提交
698 699
    <enum name='VIR_SECRET_USAGE_TYPE_NONE' file='libvirt' value='0' type='virSecretUsageType'/>
    <enum name='VIR_SECRET_USAGE_TYPE_VOLUME' file='libvirt' value='1' type='virSecretUsageType' info=' Expect more owner types later...'/>
700 701 702 703 704 705 706 707 708 709 710 711 712
    <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'/>
713 714 715
    <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'/>
716
    <enum name='VIR_WAR_NO_INTERFACE' file='virterror' value='56' type='virErrorNumber' info='failed to start interface driver'/>
717
    <enum name='VIR_WAR_NO_NETWORK' file='virterror' value='41' type='virErrorNumber' info='failed to start network'/>
D
Daniel P. Berrange 已提交
718
    <enum name='VIR_WAR_NO_NODE' file='virterror' value='51' type='virErrorNumber' info='failed to start node driver'/>
719
    <enum name='VIR_WAR_NO_SECRET' file='virterror' value='60' type='virErrorNumber' info='failed to start secret storage'/>
720
    <enum name='VIR_WAR_NO_STORAGE' file='virterror' value='48' type='virErrorNumber' info='failed to start storage'/>
721
    <struct name='virConnect' file='libvirt' type='struct _virConnect'/>
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
    <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'/>
740
    <typedef name='virConnectPtr' file='libvirt' type='virConnect *'>
741
      <info><![CDATA[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>
742 743
    </typedef>
    <struct name='virDomain' file='libvirt' type='struct _virDomain'/>
744
    <typedef name='virDomainBlockStatsPtr' file='libvirt' type='virDomainBlockStatsStruct *'>
745
      <info><![CDATA[A pointer to a virDomainBlockStats structure]]></info>
746 747
    </typedef>
    <struct name='virDomainBlockStatsStruct' file='libvirt' type='struct _virDomainBlockStats'>
748 749 750
      <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'/>
751
      <field name='wr_bytes' type='long long' info=' number of written bytes'/>
752 753
      <field name='errs' type='long long' info=' In Xen this returns the mysterious &apos;oo_req&apos;.'/>
    </struct>
754
    <typedef name='virDomainCreateFlags' file='libvirt' type='enum'/>
755 756 757 758 759
    <typedef name='virDomainEventDefinedDetailType' file='libvirt' type='enum'/>
    <typedef name='virDomainEventResumedDetailType' file='libvirt' type='enum'/>
    <typedef name='virDomainEventStartedDetailType' file='libvirt' type='enum'/>
    <typedef name='virDomainEventStoppedDetailType' file='libvirt' type='enum'/>
    <typedef name='virDomainEventSuspendedDetailType' file='libvirt' type='enum'/>
760
    <typedef name='virDomainEventType' file='libvirt' type='enum'/>
761
    <typedef name='virDomainEventUndefinedDetailType' file='libvirt' type='enum'/>
762
    <struct name='virDomainInfo' file='libvirt' type='struct _virDomainInfo'>
763
      <field name='state' type='unsigned char' info=' the running state, one of virDomainState'/>
764 765 766 767 768 769
      <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 *'>
770
      <info><![CDATA[a virDomainInfoPtr is a pointer to a virDomainInfo structure.]]></info>
771
    </typedef>
772
    <typedef name='virDomainInterfaceStatsPtr' file='libvirt' type='virDomainInterfaceStatsStruct *'>
773
      <info><![CDATA[A pointer to a virDomainInterfaceStats structure]]></info>
774 775 776 777 778 779 780 781 782 783 784
    </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>
785
    <typedef name='virDomainMemoryFlags' file='libvirt' type='enum'/>
786
    <typedef name='virDomainMigrateFlags' file='libvirt' type='enum'/>
787
    <typedef name='virDomainPtr' file='libvirt' type='virDomain *'>
788
      <info><![CDATA[a virDomainPtr is pointer to a virDomain private structure, this is the type used to reference a domain in the API.]]></info>
789 790
    </typedef>
    <typedef name='virDomainState' file='libvirt' type='enum'/>
791
    <typedef name='virDomainXMLFlags' file='libvirt' type='enum'/>
792 793 794 795 796
    <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'/>
797 798 799
      <field name='conn' type='virConnectPtr' info=' connection if available, deprecated
see note above'/>
      <field name='dom' type='virDomainPtr' info=' domain if available, deprecated
800
see note above'/>
801 802 803 804 805
      <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'/>
806 807
      <field name='net' type='virNetworkPtr' info=' network if available, deprecated
see note above'/>
808 809 810 811 812
    </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 *'/>
813
    <typedef name='virEventHandleType' file='libvirt' type='enum'/>
814 815
    <struct name='virInterface' file='libvirt' type='struct _virInterface'/>
    <typedef name='virInterfacePtr' file='libvirt' type='virInterface *'>
816
      <info><![CDATA[a virInterfacePtr is pointer to a virInterface private structure, this is the type used to reference a virtual interface in the API.]]></info>
817
    </typedef>
818 819
    <struct name='virNetwork' file='libvirt' type='struct _virNetwork'/>
    <typedef name='virNetworkPtr' file='libvirt' type='virNetwork *'>
820
      <info><![CDATA[a virNetworkPtr is pointer to a virNetwork private structure, this is the type used to reference a virtual network in the API.]]></info>
821
    </typedef>
D
Daniel P. Berrange 已提交
822 823
    <struct name='virNodeDevice' file='libvirt' type='struct _virNodeDevice'/>
    <typedef name='virNodeDevicePtr' file='libvirt' type='virNodeDevice *'>
824
      <info><![CDATA[A virNodeDevicePtr is a pointer to a virNodeDevice structure.  Get one via virNodeDeviceLookupByKey, virNodeDeviceLookupByName, or virNodeDeviceCreate.  Be sure to Call virNodeDeviceFree when done using a virNodeDevicePtr obtained from any of the above functions to avoid leaking memory.]]></info>
D
Daniel P. Berrange 已提交
825
    </typedef>
826 827 828 829 830 831 832 833 834 835 836
    <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 *'>
837
      <info><![CDATA[a virNodeInfoPtr is a pointer to a virNodeInfo structure.]]></info>
838
    </typedef>
839 840 841 842 843
    <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 *'>
844
      <info><![CDATA[a virSchedParameterPtr is a pointer to a virSchedParameter structure.]]></info>
845 846
    </typedef>
    <typedef name='virSchedParameterType' file='libvirt' type='enum'/>
847 848
    <struct name='virSecret' file='libvirt' type='struct _virSecret'/>
    <typedef name='virSecretPtr' file='libvirt' type='virSecret *'/>
D
Daniel P. Berrange 已提交
849
    <typedef name='virSecretUsageType' file='libvirt' type='enum'/>
850 851
    <struct name='virSecurityLabel' file='libvirt' type='struct _virSecurityLabel'/>
    <typedef name='virSecurityLabelPtr' file='libvirt' type='virSecurityLabel *'>
852
      <info><![CDATA[a virSecurityLabelPtr is a pointer to a virSecurityLabel.]]></info>
853 854 855
    </typedef>
    <struct name='virSecurityModel' file='libvirt' type='struct _virSecurityModel'/>
    <typedef name='virSecurityModelPtr' file='libvirt' type='virSecurityModel *'>
856
      <info><![CDATA[a virSecurityModelPtr is a pointer to a virSecurityModel.]]></info>
857
    </typedef>
858 859 860 861 862 863 864 865 866 867 868
    <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 *'>
869
      <info><![CDATA[a virStoragePoolPtr is pointer to a virStoragePool private structure, this is the type used to reference a storage pool in the API.]]></info>
870 871 872 873 874 875 876 877 878 879 880
    </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 *'>
881
      <info><![CDATA[a virStorageVolPtr is pointer to a virStorageVol private structure, this is the type used to reference a storage volume in the API.]]></info>
882 883
    </typedef>
    <typedef name='virStorageVolType' file='libvirt' type='enum'/>
884 885 886 887 888 889 890 891
    <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'/>
892
    <variable name='virConnectAuthPtrDefault' file='libvirt' type='virConnectAuthPtr'/>
893
    <function name='virConnCopyLastError' file='virterror' module='virterror'>
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
      <info><![CDATA[Copy the content of the last error caught on that connection

This method is not protected against access from multiple
threads. In a multi-threaded application, always use the
global virGetLastError() API which is backed by thread
local storage.

If the connection object was discovered to be invalid by
an API call, then the error will be reported against the
global error object.

Since 0.6.0, all errors reported in the per-connection object
are also duplicated in the global error object. As such an
application can always use virGetLastError(). This method
remains for backwards compatability.

One will need to free the result with virResetError()]]></info>
911 912 913 914 915
      <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'>
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
      <info><![CDATA[Provide a pointer to the last error caught on that connection

This method is not protected against access from multiple
threads. In a multi-threaded application, always use the
global virGetLastError() API which is backed by thread
local storage.

If the connection object was discovered to be invalid by
an API call, then the error will be reported against the
global error object.

Since 0.6.0, all errors reported in the per-connection object
are also duplicated in the global error object. As such an
application can always use virGetLastError(). This method
remains for backwards compatability.]]></info>
931
      <return type='virErrorPtr' info='a pointer to the last error or NULL if none occurred.'/>
932 933 934
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
    <function name='virConnResetLastError' file='virterror' module='virterror'>
935 936 937 938
      <info><![CDATA[The error object is kept in thread local storage, so separate
threads can safely access this concurrently.

Reset the last error caught on that connection]]></info>
939 940 941 942
      <return type='void'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
    <function name='virConnSetErrorFunc' file='virterror' module='virterror'>
943 944 945
      <info><![CDATA[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>
946 947 948 949 950
      <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>
951
    <functype name='virConnectAuthCallbackPtr' file='libvirt' module='libvirt'>
952
      <info><![CDATA[]]></info>
953 954 955 956 957
      <return type='int' info=''/>
      <arg name='cred' type='virConnectCredentialPtr' info=''/>
      <arg name='ncred' type='unsigned int' info=''/>
      <arg name='cbdata' type='void *' info=''/>
    </functype>
958
    <function name='virConnectClose' file='libvirt' module='libvirt'>
959 960 961 962
      <info><![CDATA[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>
963 964 965
      <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>
966
    <functype name='virConnectDomainEventCallback' file='libvirt' module='libvirt'>
967
      <info><![CDATA[A callback function to be registered, and called when a domain event occurs]]></info>
968 969 970 971
      <return type='int' info=''/>
      <arg name='conn' type='virConnectPtr' info='virConnect connection'/>
      <arg name='dom' type='virDomainPtr' info='The domain on which the event occured'/>
      <arg name='event' type='int' info='The specfic virDomainEventType which occured'/>
972
      <arg name='detail' type='int' info='event specific detail information'/>
973 974 975
      <arg name='opaque' type='void *' info='opaque user data'/>
    </functype>
    <function name='virConnectDomainEventDeregister' file='libvirt' module='libvirt'>
976 977 978
      <info><![CDATA[Removes a Domain Event Callback.
De-registering for a domain callback will disable
delivery of this event type]]></info>
979 980 981 982 983
      <return type='int' info='0 on success, -1 on failure'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the connection'/>
      <arg name='cb' type='virConnectDomainEventCallback' info='callback to the function handling domain events'/>
    </function>
    <function name='virConnectDomainEventRegister' file='libvirt' module='libvirt'>
984 985 986 987 988 989
      <info><![CDATA[Adds a Domain Event Callback.
Registering for a domain callback will enable delivery of the events

The virDomainPtr object handle passed into the callback upon delivery
of an event is only valid for the duration of execution of the callback.
If the callback wishes to keep the domain object after the callback]]></info>
990
      <return type='int' info='it shall take a reference to it, by calling virDomainRef. The reference can be released once the object is no longer required by calling virDomainFree.  Returns 0 on success, -1 on failure'/>
991 992 993
      <arg name='conn' type='virConnectPtr' info='pointer to the connection'/>
      <arg name='cb' type='virConnectDomainEventCallback' info='callback to the function handling domain events'/>
      <arg name='opaque' type='void *' info='opaque data to pass on to the callback'/>
D
Daniel Veillard 已提交
994
      <arg name='freecb' type='virFreeCallback' info='optional function to deallocate opaque when not used anymore'/>
995
    </function>
996
    <function name='virConnectDomainXMLFromNative' file='libvirt' module='libvirt'>
997 998 999
      <info><![CDATA[Reads native configuration data  describing a domain, and
generates libvirt domain XML. The format of the native
data is hypervisor dependant.]]></info>
1000 1001 1002 1003 1004 1005 1006
      <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='conn' type='virConnectPtr' info='a connection object'/>
      <arg name='nativeFormat' type='const char *' info='configuration format importing from'/>
      <arg name='nativeConfig' type='const char *' info='the configuration data to import'/>
      <arg name='flags' type='unsigned int' info='currently unused, pass 0'/>
    </function>
    <function name='virConnectDomainXMLToNative' file='libvirt' module='libvirt'>
1007 1008 1009
      <info><![CDATA[Reads a domain XML configuration document, and generates
generates a native configuration file describing the domain.
The format of the native data is hypervisor dependant.]]></info>
1010 1011 1012 1013 1014 1015
      <return type='char *' info='a 0 terminated UTF-8 encoded native config datafile, or NULL in case of error. the caller must free() the returned value.'/>
      <arg name='conn' type='virConnectPtr' info='a connection object'/>
      <arg name='nativeFormat' type='const char *' info='configuration format exporting to'/>
      <arg name='domainXml' type='const char *' info='the domain configuration to export'/>
      <arg name='flags' type='unsigned int' info='currently unused, pass 0'/>
    </function>
1016
    <function name='virConnectFindStoragePoolSources' file='libvirt' module='libvirt'>
1017 1018 1019 1020 1021 1022 1023 1024 1025
      <info><![CDATA[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'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>
1026 1027 1028 1029 1030 1031
      <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>
1032
    <function name='virConnectGetCapabilities' file='libvirt' module='libvirt'>
1033
      <info><![CDATA[Provides capabilities of the hypervisor / driver.]]></info>
1034
      <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.'/>
1035 1036
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
1037
    <function name='virConnectGetHostname' file='libvirt' module='libvirt'>
1038 1039 1040 1041
      <info><![CDATA[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>
1042 1043 1044
      <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>
1045
    <function name='virConnectGetMaxVcpus' file='libvirt' module='libvirt'>
1046 1047 1048
      <info><![CDATA[Provides the maximum number of virtual CPUs supported for a guest VM of a
specific type. The 'type' parameter here corresponds to the 'type'
attribute in the <domain> element of the XML.]]></info>
1049
      <return type='int' info='the maximum of virtual CPU or -1 in case of error.'/>
1050 1051 1052
      <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>
1053
    <function name='virConnectGetType' file='libvirt' module='libvirt'>
1054
      <info><![CDATA[Get the name of the Hypervisor software used.]]></info>
1055
      <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'/>
1056 1057
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
1058
    <function name='virConnectGetURI' file='libvirt' module='libvirt'>
1059 1060 1061 1062 1063 1064 1065
      <info><![CDATA[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>
1066 1067 1068
      <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>
1069
    <function name='virConnectGetVersion' file='libvirt' module='libvirt'>
1070 1071 1072
      <info><![CDATA[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>
1073 1074 1075 1076 1077
      <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'>
1078 1079
      <info><![CDATA[list the defined but inactive domains, stores the pointers to the names
in @names]]></info>
1080 1081
      <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'/>
1082
      <arg name='names' type='char ** const' info='pointer to an array to store the names'/>
1083 1084
      <arg name='maxnames' type='int' info='size of the array'/>
    </function>
D
Daniel Veillard 已提交
1085
    <function name='virConnectListDefinedInterfaces' file='libvirt' module='libvirt'>
1086 1087
      <info><![CDATA[Collect the list of defined (inactive) physical host interfaces,
and store their names in @names.]]></info>
D
Daniel Veillard 已提交
1088 1089 1090 1091 1092
      <return type='int' info='the number of interfaces found or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='names' type='char ** const' info='array to collect the list of names of interfaces'/>
      <arg name='maxnames' type='int' info='size of @names'/>
    </function>
1093
    <function name='virConnectListDefinedNetworks' file='libvirt' module='libvirt'>
1094
      <info><![CDATA[list the inactive networks, stores the pointers to the names in @names]]></info>
1095 1096
      <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'/>
1097
      <arg name='names' type='char ** const' info='pointer to an array to store the names'/>
1098 1099
      <arg name='maxnames' type='int' info='size of the array'/>
    </function>
1100
    <function name='virConnectListDefinedStoragePools' file='libvirt' module='libvirt'>
1101 1102 1103
      <info><![CDATA[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>
1104 1105 1106 1107 1108
      <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>
1109
    <function name='virConnectListDomains' file='libvirt' module='libvirt'>
1110
      <info><![CDATA[Collect the list of active domains, and store their ID in @maxids]]></info>
1111 1112 1113 1114 1115
      <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>
1116
    <function name='virConnectListInterfaces' file='libvirt' module='libvirt'>
1117 1118
      <info><![CDATA[Collect the list of active physical host interfaces,
and store their names in @names]]></info>
1119 1120 1121 1122 1123
      <return type='int' info='the number of interfaces found or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='names' type='char ** const' info='array to collect the list of names of interfaces'/>
      <arg name='maxnames' type='int' info='size of @names'/>
    </function>
1124
    <function name='virConnectListNetworks' file='libvirt' module='libvirt'>
1125
      <info><![CDATA[Collect the list of active networks, and store their names in @names]]></info>
1126 1127
      <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'/>
1128
      <arg name='names' type='char ** const' info='array to collect the list of names of active networks'/>
1129 1130
      <arg name='maxnames' type='int' info='size of @names'/>
    </function>
1131
    <function name='virConnectListSecrets' file='libvirt' module='libvirt'>
1132
      <info><![CDATA[List UUIDs of defined secrets, store pointers to names in uuids.]]></info>
1133 1134 1135 1136 1137
      <return type='int' info='the number of UUIDs provided in the array, or -1 on failure.'/>
      <arg name='conn' type='virConnectPtr' info='virConnect connection'/>
      <arg name='uuids' type='char **' info='Pointer to an array to store the UUIDs'/>
      <arg name='maxuuids' type='int' info='size of the array.'/>
    </function>
1138
    <function name='virConnectListStoragePools' file='libvirt' module='libvirt'>
1139 1140 1141
      <info><![CDATA[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>
1142 1143 1144 1145 1146
      <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>
1147
    <function name='virConnectNumOfDefinedDomains' file='libvirt' module='libvirt'>
1148
      <info><![CDATA[Provides the number of defined but inactive domains.]]></info>
1149 1150 1151
      <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>
D
Daniel Veillard 已提交
1152
    <function name='virConnectNumOfDefinedInterfaces' file='libvirt' module='libvirt'>
1153
      <info><![CDATA[Provides the number of defined (inactive) interfaces on the physical host.]]></info>
D
Daniel Veillard 已提交
1154 1155 1156
      <return type='int' info='the number of defined interface found or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
1157
    <function name='virConnectNumOfDefinedNetworks' file='libvirt' module='libvirt'>
1158
      <info><![CDATA[Provides the number of inactive networks.]]></info>
1159 1160 1161
      <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>
1162
    <function name='virConnectNumOfDefinedStoragePools' file='libvirt' module='libvirt'>
1163
      <info><![CDATA[Provides the number of inactive storage pools]]></info>
1164 1165 1166
      <return type='int' info='the number of pools found, or -1 on error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
    </function>
1167
    <function name='virConnectNumOfDomains' file='libvirt' module='libvirt'>
1168
      <info><![CDATA[Provides the number of active domains.]]></info>
1169 1170 1171
      <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>
1172
    <function name='virConnectNumOfInterfaces' file='libvirt' module='libvirt'>
1173
      <info><![CDATA[Provides the number of active interfaces on the physical host.]]></info>
D
Daniel Veillard 已提交
1174
      <return type='int' info='the number of active interfaces found or -1 in case of error'/>
1175 1176
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
1177
    <function name='virConnectNumOfNetworks' file='libvirt' module='libvirt'>
1178
      <info><![CDATA[Provides the number of active networks.]]></info>
1179 1180 1181
      <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>
1182
    <function name='virConnectNumOfSecrets' file='libvirt' module='libvirt'>
1183
      <info><![CDATA[Fetch number of currently defined secrets.]]></info>
1184 1185 1186
      <return type='int' info='the number currently defined secrets.'/>
      <arg name='conn' type='virConnectPtr' info='virConnect connection'/>
    </function>
1187
    <function name='virConnectNumOfStoragePools' file='libvirt' module='libvirt'>
1188
      <info><![CDATA[Provides the number of active storage pools]]></info>
1189 1190 1191
      <return type='int' info='the number of pools found, or -1 on error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
    </function>
1192
    <function name='virConnectOpen' file='libvirt' module='libvirt'>
1193 1194
      <info><![CDATA[This function should be called first to get a connection to the
Hypervisor and xen store]]></info>
D
Daniel Veillard 已提交
1195
      <return type='virConnectPtr' info='a pointer to the hypervisor connection or NULL in case of error  If @name is NULL then probing will be done to determine a suitable default driver to activate. This involves trying each hypervisor in turn until one successfully opens. If the LIBVIRT_DEFAULT_URI environment variable is set, then it will be used in preference to probing for a driver.  If connecting to an unprivileged hypervisor driver which requires the libvirtd daemon to be active, it will automatically be launched if not already running. This can be prevented by setting the environment variable LIBVIRT_AUTOSTART=0  URIs are documented at http://libvirt.org/uri.html'/>
1196
      <arg name='name' type='const char *' info='URI of the hypervisor'/>
1197
    </function>
1198
    <function name='virConnectOpenAuth' file='libvirt' module='libvirt'>
1199 1200 1201 1202 1203 1204
      <info><![CDATA[This function should be called first to get a connection to the
Hypervisor. If necessary, authentication will be performed fetching
credentials via the callback

See virConnectOpen for notes about environment variables which can
have an effect on opening drivers]]></info>
1205 1206 1207 1208 1209
      <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>
1210
    <function name='virConnectOpenReadOnly' file='libvirt' module='libvirt'>
1211 1212 1213 1214 1215 1216
      <info><![CDATA[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.

See virConnectOpen for notes about environment variables which can
have an effect on opening drivers]]></info>
1217 1218
      <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'/>
1219
    </function>
1220
    <function name='virConnectRef' file='libvirt' module='libvirt'>
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230
      <info><![CDATA[Increment the reference count on the connection. For each
additional call to this method, there shall be a corresponding
call to virConnectClose to release the reference count, once
the caller no longer needs the reference to this object.

This method is typically useful for applications where multiple
threads are using a connection, and it is required that the
connection remain open until all threads have finished using
it. ie, each new thread using a connection would increment
the reference count.]]></info>
D
Daniel Veillard 已提交
1231
      <return type='int' info='0 in case of success, -1 in case of failure'/>
1232 1233
      <arg name='conn' type='virConnectPtr' info='the connection to hold a reference on'/>
    </function>
1234
    <function name='virCopyLastError' file='virterror' module='virterror'>
1235 1236 1237 1238 1239 1240
      <info><![CDATA[Copy the content of the last error caught at the library level

The error object is kept in thread local storage, so separate
threads can safely access this concurrently.

One will need to free the result with virResetError()]]></info>
1241 1242 1243 1244
      <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'>
1245
      <info><![CDATA[Default routine reporting an error to stderr.]]></info>
1246 1247 1248
      <return type='void'/>
      <arg name='err' type='virErrorPtr' info='pointer to the error.'/>
    </function>
D
Daniel Veillard 已提交
1249
    <function name='virDomainAttachDevice' file='libvirt' module='libvirt'>
1250
      <info><![CDATA[Create a virtual device attachment to backend.]]></info>
D
Daniel Veillard 已提交
1251 1252
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
1253
      <arg name='xml' type='const char *' info='pointer to XML description of one device'/>
D
Daniel Veillard 已提交
1254
    </function>
1255
    <function name='virDomainBlockPeek' file='libvirt' module='libvirt'>
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282
      <info><![CDATA[This function allows you to read the contents of a domain'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's filesystems.

(Note that in the local case you might try to open the
block device or file directly, but that won't work in the
remote case, nor if you don't have sufficient permission.
Hence the need for this call).

'path' must be a device or file corresponding to the domain.
In other words it must be the precise string returned in
a <disk><source dev='...'/></disk> from
virDomainGetXMLDesc.

'offset' and 'size' represent an area which must lie entirely
within the device or file.  'size' may be 0 to test if the
call would succeed.

'buffer' is the return buffer and must be at least 'size' bytes.

NB. The remote driver imposes a 64K byte limit on 'size'.
For your program to be able to work reliably over a remote
connection you should split large requests to <= 65536 bytes.]]></info>
1283 1284 1285 1286 1287 1288 1289 1290
      <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>
1291
    <function name='virDomainBlockStats' file='libvirt' module='libvirt'>
1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
      <info><![CDATA[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 <target dev='...'>
attribute within //domain/devices/disk.  (For example, "xvda").

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>
1305 1306 1307 1308 1309 1310
      <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 已提交
1311
    <function name='virDomainCoreDump' file='libvirt' module='libvirt'>
1312 1313 1314
      <info><![CDATA[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>
D
Daniel Veillard 已提交
1315 1316 1317 1318 1319
      <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>
1320
    <function name='virDomainCreate' file='libvirt' module='libvirt'>
1321 1322
      <info><![CDATA[launch a defined domain. If the call succeed the domain moves from the
defined to the running domains pools.]]></info>
1323 1324 1325 1326
      <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'>
1327 1328 1329
      <info><![CDATA[Deprecated after 0.4.6.
Renamed to virDomainCreateXML() providing identical functionality.
This existing name will left indefinitely for API compatability.]]></info>
1330 1331 1332 1333 1334 1335
      <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'/>
      <arg name='xmlDesc' type='const char *' info='string containing an XML description of the domain'/>
      <arg name='flags' type='unsigned int' info='callers should always pass 0'/>
    </function>
    <function name='virDomainCreateXML' file='libvirt' module='libvirt'>
1336 1337 1338 1339 1340 1341
      <info><![CDATA[Launch a new 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>
1342 1343
      <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 已提交
1344
      <arg name='xmlDesc' type='const char *' info='string containing an XML description of the domain'/>
1345
      <arg name='flags' type='unsigned int' info='callers should always pass 0'/>
1346 1347
    </function>
    <function name='virDomainDefineXML' file='libvirt' module='libvirt'>
1348 1349 1350 1351
      <info><![CDATA[Define a domain, but does not start it.
This definition is persistent, until explicitly undefined with
virDomainUndefine(). A previous definition for this domain would be
overriden if it already exists.]]></info>
1352 1353 1354 1355 1356
      <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'>
1357 1358 1359 1360
      <info><![CDATA[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>
1361 1362 1363
      <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 已提交
1364
    <function name='virDomainDetachDevice' file='libvirt' module='libvirt'>
1365
      <info><![CDATA[Destroy a virtual device attachment to backend.]]></info>
D
Daniel Veillard 已提交
1366 1367
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
1368
      <arg name='xml' type='const char *' info='pointer to XML description of one device'/>
D
Daniel Veillard 已提交
1369
    </function>
1370
    <function name='virDomainFree' file='libvirt' module='libvirt'>
1371 1372
      <info><![CDATA[Free the domain object. The running instance is kept alive.
The data structure is freed and should not be used thereafter.]]></info>
1373 1374 1375
      <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>
1376
    <function name='virDomainGetAutostart' file='libvirt' module='libvirt'>
1377 1378 1379
      <info><![CDATA[Provides a boolean value indicating whether the domain
configured to be automatically started when the host
machine boots.]]></info>
1380
      <return type='int' info='-1 in case of error, 0 in case of success'/>
1381
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
1382
      <arg name='autostart' type='int *' info='the value returned'/>
1383
    </function>
1384
    <function name='virDomainGetConnect' file='libvirt' module='libvirt'>
1385 1386 1387 1388 1389 1390 1391
      <info><![CDATA[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>
1392
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
1393 1394
      <arg name='dom' type='virDomainPtr' info='pointer to a domain'/>
    </function>
1395
    <function name='virDomainGetID' file='libvirt' module='libvirt'>
1396
      <info><![CDATA[Get the hypervisor ID number for the domain]]></info>
1397 1398 1399 1400
      <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'>
1401 1402 1403
      <info><![CDATA[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>
1404 1405 1406 1407 1408
      <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'>
1409 1410 1411
      <info><![CDATA[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>
1412 1413 1414
      <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>
1415
    <function name='virDomainGetMaxVcpus' file='libvirt' module='libvirt'>
1416 1417 1418 1419 1420
      <info><![CDATA[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>
1421
      <return type='int' info='the maximum of virtual CPU or -1 in case of error.'/>
1422 1423
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
    </function>
1424
    <function name='virDomainGetName' file='libvirt' module='libvirt'>
1425
      <info><![CDATA[Get the public name for that domain]]></info>
1426 1427 1428 1429
      <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'>
1430
      <info><![CDATA[Get the type of domain operation system.]]></info>
1431 1432 1433
      <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>
1434
    <function name='virDomainGetSchedulerParameters' file='libvirt' module='libvirt'>
1435 1436
      <info><![CDATA[Get the scheduler parameters, the @params array will be filled with the
values.]]></info>
1437 1438 1439 1440 1441 1442
      <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'>
1443
      <info><![CDATA[Get the scheduler type.]]></info>
1444 1445 1446 1447
      <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>
1448
    <function name='virDomainGetSecurityLabel' file='libvirt' module='libvirt'>
1449 1450 1451
      <info><![CDATA[Extract security label of an active domain. The 'label' field
in the @seclabel argument will be initialized to the empty
string if the domain is not running under a security model.]]></info>
1452
      <return type='int' info='0 in case of success, -1 in case of failure'/>
1453 1454 1455
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='seclabel' type='virSecurityLabelPtr' info='pointer to a virSecurityLabel structure'/>
    </function>
1456
    <function name='virDomainGetUUID' file='libvirt' module='libvirt'>
1457
      <info><![CDATA[Get the UUID for a domain]]></info>
1458 1459
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
1460
      <arg name='uuid' type='unsigned char *' info='pointer to a VIR_UUID_BUFLEN bytes array'/>
1461 1462
    </function>
    <function name='virDomainGetUUIDString' file='libvirt' module='libvirt'>
1463 1464
      <info><![CDATA[Get the UUID for a domain as string. For more information about
UUID see RFC4122.]]></info>
1465 1466
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
1467
      <arg name='buf' type='char *' info='pointer to a VIR_UUID_STRING_BUFLEN bytes array'/>
1468
    </function>
1469
    <function name='virDomainGetVcpus' file='libvirt' module='libvirt'>
1470 1471
      <info><![CDATA[Extract information about virtual CPUs of domain, store it in info array
and also in cpumaps if this pointer isn't NULL.]]></info>
1472 1473 1474 1475
      <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 已提交
1476
      <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.'/>
1477 1478
      <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>
1479
    <function name='virDomainGetXMLDesc' file='libvirt' module='libvirt'>
1480 1481
      <info><![CDATA[Provide an XML description of the domain. The description may be reused
later to relaunch the domain with virDomainCreateXML().]]></info>
1482 1483
      <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'/>
1484
      <arg name='flags' type='int' info='an OR&apos;ed set of virDomainXMLFlags'/>
1485
    </function>
1486
    <function name='virDomainInterfaceStats' file='libvirt' module='libvirt'>
1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497
      <info><![CDATA[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>
1498 1499 1500 1501 1502 1503
      <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>
1504
    <function name='virDomainLookupByID' file='libvirt' module='libvirt'>
1505 1506 1507
      <info><![CDATA[Try to find a domain based on the hypervisor ID number
Note that this won'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>
1508
      <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.'/>
1509 1510 1511 1512
      <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'>
1513
      <info><![CDATA[Try to lookup a domain on the given hypervisor based on its name.]]></info>
1514
      <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.'/>
1515 1516 1517 1518
      <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'>
1519
      <info><![CDATA[Try to lookup a domain on the given hypervisor based on its UUID.]]></info>
1520
      <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.'/>
1521 1522 1523 1524
      <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'>
1525
      <info><![CDATA[Try to lookup a domain on the given hypervisor based on its UUID.]]></info>
1526
      <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.'/>
1527 1528 1529
      <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>
1530
    <function name='virDomainMemoryPeek' file='libvirt' module='libvirt'>
1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550
      <info><![CDATA[This function allows you to read the contents of a domain's
memory.

The memory which is read is controlled by the 'start', 'size'
and 'flags' parameters.

If 'flags' is VIR_MEMORY_VIRTUAL then the 'start' and 'size'
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.

'buffer' is the return buffer and must be at least 'size' bytes.
'size' may be 0 to test if the call would succeed.

NB. The remote driver imposes a 64K byte limit on 'size'.
For your program to be able to work reliably over a remote
connection you should split large requests to <= 65536 bytes.]]></info>
1551 1552 1553 1554 1555 1556 1557
      <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>
1558
    <function name='virDomainMigrate' file='libvirt' module='libvirt'>
1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592
      <info><![CDATA[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>
1593 1594 1595 1596 1597 1598 1599 1600
      <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>
1601
    <function name='virDomainPinVcpu' file='libvirt' module='libvirt'>
1602 1603
      <info><![CDATA[Dynamically change the real CPUs which can be allocated to a virtual CPU.
This function requires privileged access to the hypervisor.]]></info>
1604 1605 1606 1607 1608 1609
      <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>
1610
    <function name='virDomainReboot' file='libvirt' module='libvirt'>
1611 1612 1613
      <info><![CDATA[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>
1614 1615 1616 1617
      <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>
1618
    <function name='virDomainRef' file='libvirt' module='libvirt'>
1619 1620 1621 1622 1623 1624 1625 1626 1627 1628
      <info><![CDATA[Increment the reference count on the domain. For each
additional call to this method, there shall be a corresponding
call to virDomainFree to release the reference count, once
the caller no longer needs the reference to this object.

This method is typically useful for applications where multiple
threads are using a connection, and it is required that the
connection remain open until all threads have finished using
it. ie, each new thread using a domain would increment
the reference count.]]></info>
D
Daniel Veillard 已提交
1629 1630
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='the domain to hold a reference on'/>
1631
    </function>
1632
    <function name='virDomainRestore' file='libvirt' module='libvirt'>
1633
      <info><![CDATA[This method will restore a domain saved to disk by virDomainSave().]]></info>
1634 1635 1636 1637 1638
      <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'>
1639 1640 1641
      <info><![CDATA[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>
1642 1643 1644 1645
      <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'>
1646 1647 1648 1649
      <info><![CDATA[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>
1650 1651 1652 1653
      <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>
1654
    <function name='virDomainSetAutostart' file='libvirt' module='libvirt'>
1655 1656
      <info><![CDATA[Configure the domain to be automatically started
when the host machine boots.]]></info>
1657 1658
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
1659
      <arg name='autostart' type='int' info='whether the domain should be automatically started 0 or 1'/>
1660
    </function>
1661
    <function name='virDomainSetMaxMemory' file='libvirt' module='libvirt'>
1662 1663 1664 1665
      <info><![CDATA[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>
1666 1667 1668 1669 1670
      <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'>
1671 1672 1673 1674
      <info><![CDATA[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>
1675 1676 1677 1678
      <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>
1679
    <function name='virDomainSetSchedulerParameters' file='libvirt' module='libvirt'>
1680
      <info><![CDATA[Change the scheduler parameters]]></info>
1681 1682 1683 1684 1685
      <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>
1686
    <function name='virDomainSetVcpus' file='libvirt' module='libvirt'>
1687 1688 1689 1690
      <info><![CDATA[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>
1691 1692 1693 1694
      <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>
1695
    <function name='virDomainShutdown' file='libvirt' module='libvirt'>
1696 1697 1698 1699 1700 1701
      <info><![CDATA[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>
1702 1703 1704 1705
      <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'>
1706 1707 1708 1709 1710
      <info><![CDATA[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>
1711 1712 1713 1714
      <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'>
1715
      <info><![CDATA[Undefine a domain but does not stop it if it is running]]></info>
1716 1717 1718 1719
      <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'>
1720
      <info><![CDATA[Signature of a function to use when there is an error raised by the library.]]></info>
1721 1722 1723 1724
      <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>
1725
    <functype name='virEventAddHandleFunc' file='libvirt' module='libvirt'>
1726 1727 1728 1729 1730 1731 1732
      <info><![CDATA[Part of the EventImpl, this callback Adds a file handle callback to
listen for specific events. The same file handle can be registered
multiple times provided the requested event sets are non-overlapping

If the opaque user data requires free'ing when the handle
is unregistered, then a 2nd callback can be supplied for
this purpose.]]></info>
D
Daniel P. Berrange 已提交
1733
      <return type='int' info='a handle watch number to be used for updating and unregistering for events'/>
1734 1735
      <arg name='fd' type='int' info='file descriptor to listen on'/>
      <arg name='event' type='int' info='bitset of events on which to fire the callback'/>
D
Daniel P. Berrange 已提交
1736
      <arg name='cb' type='virEventHandleCallback' info='the callback to be called when an event occurrs'/>
1737
      <arg name='opaque' type='void *' info='user data to pass to the callback'/>
D
Daniel P. Berrange 已提交
1738
      <arg name='ff' type='virFreeCallback' info='the callback invoked to free opaque data blob'/>
1739 1740
    </functype>
    <functype name='virEventAddTimeoutFunc' file='libvirt' module='libvirt'>
1741 1742 1743 1744 1745 1746
      <info><![CDATA[Part of the EventImpl, this user-defined callback handles adding an
event timeout.

If the opaque user data requires free'ing when the handle
is unregistered, then a 2nd callback can be supplied for
this purpose.]]></info>
1747 1748 1749 1750
      <return type='int' info='a timer value'/>
      <arg name='timeout' type='int' info='The timeout to monitor'/>
      <arg name='cb' type='virEventTimeoutCallback' info='the callback to call when timeout has expired'/>
      <arg name='opaque' type='void *' info='user data to pass to the callback'/>
D
Daniel P. Berrange 已提交
1751
      <arg name='ff' type='virFreeCallback' info='the callback invoked to free opaque data blob'/>
1752 1753
    </functype>
    <functype name='virEventHandleCallback' file='libvirt' module='libvirt'>
1754 1755
      <info><![CDATA[Callback for receiving file handle events. The callback will
be invoked once for each event which is pending.]]></info>
1756
      <return type='void'/>
D
Daniel P. Berrange 已提交
1757
      <arg name='watch' type='int' info='watch on which the event occurred'/>
1758 1759 1760 1761 1762
      <arg name='fd' type='int' info='file handle on which the event occurred'/>
      <arg name='events' type='int' info='bitset of events from virEventHandleType constants'/>
      <arg name='opaque' type='void *' info='user data registered with handle'/>
    </functype>
    <function name='virEventRegisterImpl' file='libvirt' module='libvirt'>
1763
      <info><![CDATA[]]></info>
1764 1765 1766 1767 1768 1769 1770 1771 1772
      <return type='void'/>
      <arg name='addHandle' type='virEventAddHandleFunc' info=''/>
      <arg name='updateHandle' type='virEventUpdateHandleFunc' info=''/>
      <arg name='removeHandle' type='virEventRemoveHandleFunc' info=''/>
      <arg name='addTimeout' type='virEventAddTimeoutFunc' info=''/>
      <arg name='updateTimeout' type='virEventUpdateTimeoutFunc' info=''/>
      <arg name='removeTimeout' type='virEventRemoveTimeoutFunc' info=''/>
    </function>
    <functype name='virEventRemoveHandleFunc' file='libvirt' module='libvirt'>
1773 1774 1775 1776 1777 1778
      <info><![CDATA[Part of the EventImpl, this user-provided callback is notified when
an fd is no longer being listened on.

If a virEventHandleFreeFunc was supplied when the handle was
registered, it will be invoked some time during, or after this
function call, when it is safe to release the user data.]]></info>
1779
      <return type='int' info=''/>
D
Daniel P. Berrange 已提交
1780
      <arg name='watch' type='int' info='file descriptor watch to stop listening on'/>
1781 1782
    </functype>
    <functype name='virEventRemoveTimeoutFunc' file='libvirt' module='libvirt'>
1783 1784 1785 1786 1787
      <info><![CDATA[Part of the EventImpl, this user-defined callback removes a timer

If a virEventTimeoutFreeFunc was supplied when the handle was
registered, it will be invoked some time during, or after this
function call, when it is safe to release the user data.]]></info>
1788 1789 1790 1791
      <return type='int' info='0 on success, -1 on failure'/>
      <arg name='timer' type='int' info='the timer to remove'/>
    </functype>
    <functype name='virEventTimeoutCallback' file='libvirt' module='libvirt'>
1792
      <info><![CDATA[callback for receiving timer events]]></info>
1793 1794 1795 1796 1797
      <return type='void'/>
      <arg name='timer' type='int' info='timer id emitting the event'/>
      <arg name='opaque' type='void *' info='user data registered with handle'/>
    </functype>
    <functype name='virEventUpdateHandleFunc' file='libvirt' module='libvirt'>
1798 1799
      <info><![CDATA[Part of the EventImpl, this user-provided callback is notified when
events to listen on change]]></info>
1800
      <return type='void'/>
D
Daniel P. Berrange 已提交
1801
      <arg name='watch' type='int' info='file descriptor watch to modify'/>
1802 1803 1804
      <arg name='event' type='int' info='new events to listen on'/>
    </functype>
    <functype name='virEventUpdateTimeoutFunc' file='libvirt' module='libvirt'>
1805 1806
      <info><![CDATA[Part of the EventImpl, this user-defined callback updates an
event timeout.]]></info>
1807 1808 1809 1810
      <return type='void'/>
      <arg name='timer' type='int' info='the timer to modify'/>
      <arg name='timeout' type='int' info='the new timeout value'/>
    </functype>
D
Daniel P. Berrange 已提交
1811
    <functype name='virFreeCallback' file='libvirt' module='libvirt'>
1812
      <info><![CDATA[]]></info>
D
Daniel P. Berrange 已提交
1813 1814 1815
      <return type='void'/>
      <arg name='opaque' type='void *' info=''/>
    </functype>
1816
    <function name='virFreeError' file='virterror' module='virterror'>
1817
      <info><![CDATA[Resets and frees the given error.]]></info>
1818 1819 1820
      <return type='void'/>
      <arg name='err' type='virErrorPtr' info='error to free'/>
    </function>
1821
    <function name='virGetLastError' file='virterror' module='virterror'>
1822 1823 1824 1825
      <info><![CDATA[Provide a pointer to the last error caught at the library level

The error object is kept in thread local storage, so separate
threads can safely access this concurrently.]]></info>
1826
      <return type='virErrorPtr' info='a pointer to the last error or NULL if none occurred.'/>
1827 1828
    </function>
    <function name='virGetVersion' file='libvirt' module='libvirt'>
1829 1830 1831 1832 1833
      <info><![CDATA[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, "Xen" is assumed, if
@type is unknown or not available, an error code will be returned and
@typeVer will be 0.]]></info>
1834 1835 1836 1837 1838 1839
      <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'>
1840 1841 1842
      <info><![CDATA[Initialize the library. It's better to call this routine at startup
in multithreaded applications to avoid potential race when initializing
the library.]]></info>
1843 1844
      <return type='int' info='0 in case of success, -1 in case of error'/>
    </function>
1845
    <function name='virInterfaceCreate' file='libvirt' module='libvirt'>
1846
      <info><![CDATA[Activate an interface (ie call "ifup")]]></info>
1847
      <return type='int' info='0 in case of success, -1 in case of error'/>
1848
      <arg name='iface' type='virInterfacePtr' info='pointer to a defined interface'/>
1849 1850 1851
      <arg name='flags' type='unsigned int' info='and OR&apos;ed set of extraction flags, not used yet'/>
    </function>
    <function name='virInterfaceDefineXML' file='libvirt' module='libvirt'>
1852
      <info><![CDATA[Define an interface (or modify existing interface configuration)]]></info>
1853 1854 1855 1856 1857 1858
      <return type='virInterfacePtr' info='NULL in case of error, a pointer to the interface otherwise'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='xml' type='const char *' info='the XML description for the interface, preferably in UTF-8'/>
      <arg name='flags' type='unsigned int' info='and OR&apos;ed set of extraction flags, not used yet'/>
    </function>
    <function name='virInterfaceDestroy' file='libvirt' module='libvirt'>
1859 1860 1861
      <info><![CDATA[deactivate an interface (ie call "ifdown")
This does not remove the interface from the config, and
does not free the associated virInterfacePtr object.]]></info>
1862
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
1863
      <arg name='iface' type='virInterfacePtr' info='an interface object'/>
1864 1865 1866
      <arg name='flags' type='unsigned int' info='and OR&apos;ed set of extraction flags, not used yet'/>
    </function>
    <function name='virInterfaceFree' file='libvirt' module='libvirt'>
1867 1868
      <info><![CDATA[Free the interface object. The interface itself is unaltered.
The data structure is freed and should not be used thereafter.]]></info>
1869
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
D
Daniel P. Berrange 已提交
1870
      <arg name='iface' type='virInterfacePtr' info='an interface object'/>
1871 1872
    </function>
    <function name='virInterfaceGetConnect' file='libvirt' module='libvirt'>
1873 1874 1875 1876 1877 1878 1879
      <info><![CDATA[Provides the connection pointer associated with an interface.  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 interface object together.]]></info>
1880
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
D
Daniel P. Berrange 已提交
1881
      <arg name='iface' type='virInterfacePtr' info='pointer to an interface'/>
1882 1883
    </function>
    <function name='virInterfaceGetMACString' file='libvirt' module='libvirt'>
1884 1885
      <info><![CDATA[Get the MAC for an interface as string. For more information about
MAC see RFC4122.]]></info>
1886
      <return type='const char *' info='a pointer to the MAC address (in null-terminated ASCII format) or NULL, the string need not be deallocated its lifetime will be the same as the interface object.'/>
D
Daniel P. Berrange 已提交
1887
      <arg name='iface' type='virInterfacePtr' info='an interface object'/>
1888 1889
    </function>
    <function name='virInterfaceGetName' file='libvirt' module='libvirt'>
1890
      <info><![CDATA[Get the public name for that interface]]></info>
1891
      <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 interface object.'/>
D
Daniel P. Berrange 已提交
1892
      <arg name='iface' type='virInterfacePtr' info='an interface object'/>
1893 1894
    </function>
    <function name='virInterfaceGetXMLDesc' file='libvirt' module='libvirt'>
1895 1896
      <info><![CDATA[Provide an XML description of the interface. The description may be reused
later to redefine the interface with virInterfaceDefineXML().]]></info>
1897
      <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.'/>
D
Daniel P. Berrange 已提交
1898 1899
      <arg name='iface' type='virInterfacePtr' info='an interface object'/>
      <arg name='flags' type='unsigned int' info='an OR&apos;ed set of extraction flags, not used yet'/>
1900 1901
    </function>
    <function name='virInterfaceLookupByMACString' file='libvirt' module='libvirt'>
1902
      <info><![CDATA[Try to lookup an interface on the given hypervisor based on its MAC.]]></info>
1903 1904 1905 1906 1907
      <return type='virInterfacePtr' info='a new interface object or NULL in case of failure.  If the interface cannot be found, then VIR_ERR_NO_INTERFACE error is raised.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='macstr' type='const char *' info='the MAC for the interface (null-terminated ASCII format)'/>
    </function>
    <function name='virInterfaceLookupByName' file='libvirt' module='libvirt'>
1908
      <info><![CDATA[Try to lookup an interface on the given hypervisor based on its name.]]></info>
1909 1910 1911 1912 1913
      <return type='virInterfacePtr' info='a new interface object or NULL in case of failure.  If the interface cannot be found, then VIR_ERR_NO_INTERFACE error is raised.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='name' type='const char *' info='name for the interface'/>
    </function>
    <function name='virInterfaceRef' file='libvirt' module='libvirt'>
1914 1915 1916 1917 1918 1919 1920 1921 1922 1923
      <info><![CDATA[Increment the reference count on the interface. For each
additional call to this method, there shall be a corresponding
call to virInterfaceFree to release the reference count, once
the caller no longer needs the reference to this object.

This method is typically useful for applications where multiple
threads are using a connection, and it is required that the
connection remain open until all threads have finished using
it. ie, each new thread using an interface would increment
the reference count.]]></info>
1924
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
1925
      <arg name='iface' type='virInterfacePtr' info='the interface to hold a reference on'/>
1926 1927
    </function>
    <function name='virInterfaceUndefine' file='libvirt' module='libvirt'>
1928 1929
      <info><![CDATA[Undefine an interface, ie remove it from the config.
This does not free the associated virInterfacePtr object.]]></info>
1930
      <return type='int' info='0 in case of success, -1 in case of error'/>
1931
      <arg name='iface' type='virInterfacePtr' info='pointer to a defined interface'/>
1932
    </function>
1933
    <function name='virNetworkCreate' file='libvirt' module='libvirt'>
1934 1935
      <info><![CDATA[Create and start a defined network. If the call succeed the network
moves from the defined to the running networks pools.]]></info>
1936 1937 1938 1939
      <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'>
1940 1941
      <info><![CDATA[Create and start a new virtual network, based on an XML description
similar to the one returned by virNetworkGetXMLDesc()]]></info>
1942 1943 1944 1945 1946
      <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'>
1947
      <info><![CDATA[Define a network, but does not create it]]></info>
1948 1949 1950 1951 1952
      <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'>
1953 1954 1955 1956
      <info><![CDATA[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>
1957 1958 1959 1960
      <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'>
1961 1962
      <info><![CDATA[Free the network object. The running instance is kept alive.
The data structure is freed and should not be used thereafter.]]></info>
1963 1964 1965
      <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>
1966
    <function name='virNetworkGetAutostart' file='libvirt' module='libvirt'>
1967 1968 1969
      <info><![CDATA[Provides a boolean value indicating whether the network
configured to be automatically started when the host
machine boots.]]></info>
1970
      <return type='int' info='-1 in case of error, 0 in case of success'/>
1971
      <arg name='network' type='virNetworkPtr' info='a network object'/>
1972
      <arg name='autostart' type='int *' info='the value returned'/>
1973
    </function>
1974
    <function name='virNetworkGetBridgeName' file='libvirt' module='libvirt'>
1975 1976
      <info><![CDATA[Provides a bridge interface name to which a domain may connect
a network interface in order to join the network.]]></info>
1977
      <return type='char *' info='a 0 terminated interface name, or NULL in case of error. the caller must free() the returned value.'/>
1978 1979
      <arg name='network' type='virNetworkPtr' info='a network object'/>
    </function>
1980
    <function name='virNetworkGetConnect' file='libvirt' module='libvirt'>
1981 1982 1983 1984 1985 1986 1987
      <info><![CDATA[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>
1988
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
1989 1990
      <arg name='net' type='virNetworkPtr' info='pointer to a network'/>
    </function>
1991
    <function name='virNetworkGetName' file='libvirt' module='libvirt'>
1992
      <info><![CDATA[Get the public name for that network]]></info>
1993 1994 1995 1996
      <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'>
1997
      <info><![CDATA[Get the UUID for a network]]></info>
1998 1999 2000 2001 2002
      <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'>
2003 2004
      <info><![CDATA[Get the UUID for a network as string. For more information about
UUID see RFC4122.]]></info>
2005 2006 2007 2008 2009
      <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'>
2010 2011
      <info><![CDATA[Provide an XML description of the network. The description may be reused
later to relaunch the network with virNetworkCreateXML().]]></info>
2012 2013
      <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'/>
D
Daniel P. Berrange 已提交
2014
      <arg name='flags' type='int' info='an OR&apos;ed set of extraction flags, not used yet'/>
2015 2016
    </function>
    <function name='virNetworkLookupByName' file='libvirt' module='libvirt'>
2017
      <info><![CDATA[Try to lookup a network on the given hypervisor based on its name.]]></info>
2018
      <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.'/>
2019 2020 2021 2022
      <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'>
2023
      <info><![CDATA[Try to lookup a network on the given hypervisor based on its UUID.]]></info>
2024
      <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.'/>
2025 2026 2027 2028
      <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'>
2029
      <info><![CDATA[Try to lookup a network on the given hypervisor based on its UUID.]]></info>
2030
      <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.'/>
2031 2032 2033
      <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>
2034
    <function name='virNetworkRef' file='libvirt' module='libvirt'>
2035 2036 2037 2038 2039 2040 2041 2042 2043 2044
      <info><![CDATA[Increment the reference count on the network. For each
additional call to this method, there shall be a corresponding
call to virNetworkFree to release the reference count, once
the caller no longer needs the reference to this object.

This method is typically useful for applications where multiple
threads are using a connection, and it is required that the
connection remain open until all threads have finished using
it. ie, each new thread using a network would increment
the reference count.]]></info>
D
Daniel Veillard 已提交
2045 2046
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='network' type='virNetworkPtr' info='the network to hold a reference on'/>
2047
    </function>
2048
    <function name='virNetworkSetAutostart' file='libvirt' module='libvirt'>
2049 2050
      <info><![CDATA[Configure the network to be automatically started
when the host machine boots.]]></info>
2051 2052
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='network' type='virNetworkPtr' info='a network object'/>
2053
      <arg name='autostart' type='int' info='whether the network should be automatically started 0 or 1'/>
2054
    </function>
2055
    <function name='virNetworkUndefine' file='libvirt' module='libvirt'>
2056
      <info><![CDATA[Undefine a network but does not stop it if it is running]]></info>
2057 2058 2059
      <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>
D
Daniel Veillard 已提交
2060
    <function name='virNodeDeviceCreateXML' file='libvirt' module='libvirt'>
2061 2062
      <info><![CDATA[Create a new device on the VM host machine, for example, virtual
HBAs created using vport_create.]]></info>
D
Daniel Veillard 已提交
2063 2064 2065 2066 2067 2068
      <return type='virNodeDevicePtr' info='a node device object if successful, NULL in case of failure'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='xmlDesc' type='const char *' info='string containing an XML description of the device to be created'/>
      <arg name='flags' type='unsigned int' info='callers should always pass 0'/>
    </function>
    <function name='virNodeDeviceDestroy' file='libvirt' module='libvirt'>
2069 2070
      <info><![CDATA[Destroy the device object. The virtual device is removed from the host operating system.
This function may require privileged access]]></info>
D
Daniel Veillard 已提交
2071 2072 2073
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='dev' type='virNodeDevicePtr' info='a device object'/>
    </function>
2074
    <function name='virNodeDeviceDettach' file='libvirt' module='libvirt'>
2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086
      <info><![CDATA[Dettach the node device from the node itself so that it may be
assigned to a guest domain.

Depending on the hypervisor, this may involve operations such
as unbinding any device drivers from the device, binding the
device to a dummy device driver and resetting the device.

If the device is currently in use by the node, this method may
fail.

Once the device is not assigned to any guest, it may be re-attached
to the node using the virNodeDeviceReattach() method.]]></info>
D
Daniel Veillard 已提交
2087 2088
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='dev' type='virNodeDevicePtr' info='pointer to the node device'/>
2089
    </function>
D
Daniel P. Berrange 已提交
2090
    <function name='virNodeDeviceFree' file='libvirt' module='libvirt'>
2091 2092
      <info><![CDATA[Drops a reference to the node device, freeing it if
this was the last reference.]]></info>
D
Daniel P. Berrange 已提交
2093 2094 2095 2096
      <return type='int' info='the 0 for success, -1 for error.'/>
      <arg name='dev' type='virNodeDevicePtr' info='pointer to the node device'/>
    </function>
    <function name='virNodeDeviceGetName' file='libvirt' module='libvirt'>
2097
      <info><![CDATA[Just return the device name]]></info>
D
Daniel Veillard 已提交
2098
      <return type='const char *' info='the device name or NULL in case of error'/>
D
Daniel P. Berrange 已提交
2099 2100 2101
      <arg name='dev' type='virNodeDevicePtr' info='the device'/>
    </function>
    <function name='virNodeDeviceGetParent' file='libvirt' module='libvirt'>
2102
      <info><![CDATA[Accessor for the parent of the device]]></info>
D
Daniel P. Berrange 已提交
2103 2104 2105 2106
      <return type='const char *' info='the name of the device&apos;s parent, or NULL if the device has no parent.'/>
      <arg name='dev' type='virNodeDevicePtr' info='the device'/>
    </function>
    <function name='virNodeDeviceGetXMLDesc' file='libvirt' module='libvirt'>
2107 2108
      <info><![CDATA[Fetch an XML document describing all aspects of
the device.]]></info>
D
Daniel P. Berrange 已提交
2109 2110 2111 2112 2113
      <return type='char *' info='the XML document, or NULL on error'/>
      <arg name='dev' type='virNodeDevicePtr' info='pointer to the node device'/>
      <arg name='flags' type='unsigned int' info='flags for XML generation (unused, pass 0)'/>
    </function>
    <function name='virNodeDeviceListCaps' file='libvirt' module='libvirt'>
2114
      <info><![CDATA[Lists the names of the capabilities supported by the device.]]></info>
D
Daniel P. Berrange 已提交
2115 2116 2117 2118 2119 2120
      <return type='int' info='the number of capability names listed in @names.'/>
      <arg name='dev' type='virNodeDevicePtr' info='the device'/>
      <arg name='names' type='char ** const' info='array to collect the list of capability names'/>
      <arg name='maxnames' type='int' info='size of @names'/>
    </function>
    <function name='virNodeDeviceLookupByName' file='libvirt' module='libvirt'>
2121
      <info><![CDATA[Lookup a node device by its name.]]></info>
D
Daniel P. Berrange 已提交
2122 2123 2124 2125 2126
      <return type='virNodeDevicePtr' info='a virNodeDevicePtr if found, NULL otherwise.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='name' type='const char *' info='unique device name'/>
    </function>
    <function name='virNodeDeviceNumOfCaps' file='libvirt' module='libvirt'>
2127
      <info><![CDATA[Accessor for the number of capabilities supported by the device.]]></info>
D
Daniel P. Berrange 已提交
2128 2129 2130
      <return type='int' info='the number of capabilities supported by the device.'/>
      <arg name='dev' type='virNodeDevicePtr' info='the device'/>
    </function>
2131
    <function name='virNodeDeviceReAttach' file='libvirt' module='libvirt'>
2132 2133 2134 2135 2136 2137 2138 2139
      <info><![CDATA[Re-attach a previously dettached node device to the node so that it
may be used by the node again.

Depending on the hypervisor, this may involve operations such
as resetting the device, unbinding it from a dummy device driver
and binding it to its appropriate driver.

If the device is currently in use by a guest, this method may fail.]]></info>
D
Daniel Veillard 已提交
2140
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
2141 2142
      <arg name='dev' type='virNodeDevicePtr' info='pointer to the node device'/>
    </function>
2143
    <function name='virNodeDeviceRef' file='libvirt' module='libvirt'>
2144 2145 2146 2147 2148 2149 2150 2151 2152 2153
      <info><![CDATA[Increment the reference count on the dev. For each
additional call to this method, there shall be a corresponding
call to virNodeDeviceFree to release the reference count, once
the caller no longer needs the reference to this object.

This method is typically useful for applications where multiple
threads are using a connection, and it is required that the
connection remain open until all threads have finished using
it. ie, each new thread using a dev would increment
the reference count.]]></info>
D
Daniel Veillard 已提交
2154 2155
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='dev' type='virNodeDevicePtr' info='the dev to hold a reference on'/>
2156
    </function>
2157
    <function name='virNodeDeviceReset' file='libvirt' module='libvirt'>
2158 2159 2160 2161 2162 2163 2164 2165 2166 2167
      <info><![CDATA[Reset a previously dettached node device to the node before or
after assigning it to a guest.

The exact reset semantics depends on the hypervisor and device
type but, for example, KVM will attempt to reset PCI devices with
a Function Level Reset, Secondary Bus Reset or a Power Management
D-State reset.

If the reset will affect other devices which are currently in use,
this function may fail.]]></info>
D
Daniel Veillard 已提交
2168
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
2169 2170
      <arg name='dev' type='virNodeDevicePtr' info='pointer to the node device'/>
    </function>
2171
    <function name='virNodeGetCellsFreeMemory' file='libvirt' module='libvirt'>
2172 2173 2174 2175 2176 2177
      <info><![CDATA[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 bytes 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>
2178 2179 2180 2181 2182 2183
      <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>
2184
    <function name='virNodeGetFreeMemory' file='libvirt' module='libvirt'>
2185 2186 2187
      <info><![CDATA[provides the free memory available on the Node
Note: most libvirt APIs provide memory sizes in kilobytes, but in this
function the returned value is in bytes. Divide by 1024 as necessary.]]></info>
2188
      <return type='unsigned long long' info='the available free memory in bytes or 0 in case of error'/>
2189 2190
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
2191
    <function name='virNodeGetInfo' file='libvirt' module='libvirt'>
2192
      <info><![CDATA[Extract hardware information about the node.]]></info>
2193 2194 2195 2196
      <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>
2197
    <function name='virNodeGetSecurityModel' file='libvirt' module='libvirt'>
2198 2199 2200
      <info><![CDATA[Extract the security model of a hypervisor. The 'model' field
in the @secmodel argument may be initialized to the empty
string if the driver has not activated a security model.]]></info>
2201
      <return type='int' info='0 in case of success, -1 in case of failure'/>
2202 2203 2204
      <arg name='conn' type='virConnectPtr' info='a connection object'/>
      <arg name='secmodel' type='virSecurityModelPtr' info='pointer to a virSecurityModel structure'/>
    </function>
D
Daniel P. Berrange 已提交
2205
    <function name='virNodeListDevices' file='libvirt' module='libvirt'>
2206 2207 2208 2209
      <info><![CDATA[Collect the list of node devices, and store their names in @names

If the optional 'cap'  argument is non-NULL, then the count
will be restricted to devices with the specified capability]]></info>
D
Daniel P. Berrange 已提交
2210 2211 2212 2213 2214 2215 2216 2217
      <return type='int' info='the number of node devices found or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='cap' type='const char *' info='capability name'/>
      <arg name='names' type='char ** const' info='array to collect the list of node device names'/>
      <arg name='maxnames' type='int' info='size of @names'/>
      <arg name='flags' type='unsigned int' info='flags (unused, pass 0)'/>
    </function>
    <function name='virNodeNumOfDevices' file='libvirt' module='libvirt'>
2218 2219 2220 2221
      <info><![CDATA[Provides the number of node devices.

If the optional 'cap'  argument is non-NULL, then the count
will be restricted to devices with the specified capability]]></info>
D
Daniel P. Berrange 已提交
2222 2223 2224 2225 2226
      <return type='int' info='the number of node devices or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='cap' type='const char *' info='capability name'/>
      <arg name='flags' type='unsigned int' info='flags (unused, pass 0)'/>
    </function>
2227
    <function name='virResetError' file='virterror' module='virterror'>
2228
      <info><![CDATA[Reset the error being pointed to]]></info>
2229 2230 2231 2232
      <return type='void'/>
      <arg name='err' type='virErrorPtr' info='pointer to the virError to clean up'/>
    </function>
    <function name='virResetLastError' file='virterror' module='virterror'>
2233 2234 2235 2236 2237
      <info><![CDATA[Reset the last error caught at the library level.

The error object is kept in thread local storage, so separate
threads can safely access this concurrently, only resetting
their own error object.]]></info>
2238 2239
      <return type='void'/>
    </function>
2240
    <function name='virSaveLastError' file='virterror' module='virterror'>
2241
      <info><![CDATA[Save the last error into a new error object.]]></info>
2242 2243
      <return type='virErrorPtr' info='a pointer to the copied error or NULL if allocation failed. It is the caller&apos;s responsibility to free the error with virFreeError().'/>
    </function>
2244
    <function name='virSecretDefineXML' file='libvirt' module='libvirt'>
2245 2246 2247 2248 2249 2250
      <info><![CDATA[If XML specifies an UUID, locates the specified secret and replaces all
attributes of the secret specified by UUID by attributes specified in xml
(any attributes not specified in xml are discarded).

Otherwise, creates a new secret with an automatically chosen UUID, and
initializes its attributes from xml.]]></info>
2251 2252 2253 2254 2255 2256
      <return type='virSecretPtr' info='a the secret on success, NULL on failure.'/>
      <arg name='conn' type='virConnectPtr' info='virConnect connection'/>
      <arg name='xml' type='const char *' info='XML describing the secret.'/>
      <arg name='flags' type='unsigned int' info='flags, use 0 for now'/>
    </function>
    <function name='virSecretFree' file='libvirt' module='libvirt'>
2257
      <info><![CDATA[Release the secret handle. The underlying secret continues to exist.]]></info>
2258 2259 2260 2261
      <return type='int' info='0 on success, or -1 on error'/>
      <arg name='secret' type='virSecretPtr' info='pointer to a secret'/>
    </function>
    <function name='virSecretGetConnect' file='libvirt' module='libvirt'>
2262 2263 2264 2265 2266
      <info><![CDATA[Provides the connection pointer associated with a secret.  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 secret object together.]]></info>
2267 2268 2269
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
      <arg name='secret' type='virSecretPtr' info='A virSecret secret'/>
    </function>
D
Daniel P. Berrange 已提交
2270
    <function name='virSecretGetUUID' file='libvirt' module='libvirt'>
2271
      <info><![CDATA[Fetches the UUID of the secret.]]></info>
D
Daniel P. Berrange 已提交
2272
      <return type='int' info='0 on success with the uuid buffer being filled, or -1 upon failure.'/>
2273
      <arg name='secret' type='virSecretPtr' info='A virSecret secret'/>
D
Daniel P. Berrange 已提交
2274 2275 2276
      <arg name='uuid' type='unsigned char *' info='buffer of VIR_UUID_BUFLEN bytes in size'/>
    </function>
    <function name='virSecretGetUUIDString' file='libvirt' module='libvirt'>
2277 2278
      <info><![CDATA[Get the UUID for a secret as string. For more information about
UUID see RFC4122.]]></info>
D
Daniel P. Berrange 已提交
2279 2280 2281 2282 2283
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='secret' type='virSecretPtr' info='a secret object'/>
      <arg name='buf' type='char *' info='pointer to a VIR_UUID_STRING_BUFLEN bytes array'/>
    </function>
    <function name='virSecretGetUsageID' file='libvirt' module='libvirt'>
2284 2285 2286 2287 2288 2289 2290 2291
      <info><![CDATA[Get the unique identifier of the object with which this
secret is to be used. The format of the identifier is
dependant on the usage type of the secret. For a secret
with a usage type of VIR_SECRET_USAGE_TYPE_VOLUME the
identifier will be a fully qualfied path name. The
identifiers are intended to be unique within the set of
all secrets sharing the same usage type. ie, there shall
only ever be one secret for each volume path.]]></info>
D
Daniel P. Berrange 已提交
2292 2293 2294 2295
      <return type='const char *' info='a string identifying the object using the secret, or NULL upon error'/>
      <arg name='secret' type='virSecretPtr' info='a secret object'/>
    </function>
    <function name='virSecretGetUsageType' file='libvirt' module='libvirt'>
2296 2297 2298 2299 2300
      <info><![CDATA[Get the type of object which uses this secret. The returned
value is one of the constants defined in the virSecretUsageType
enumeration. More values may be added to this enumeration in
the future, so callers should expect to see usage types they
do not explicitly know about.]]></info>
D
Daniel P. Berrange 已提交
2301 2302
      <return type='int' info='a positive integer identifying the type of object, or -1 upon error.'/>
      <arg name='secret' type='virSecretPtr' info='a secret object'/>
2303 2304
    </function>
    <function name='virSecretGetValue' file='libvirt' module='libvirt'>
2305
      <info><![CDATA[Fetches the value of a secret.]]></info>
2306 2307 2308 2309 2310 2311
      <return type='unsigned char *' info='the secret value on success, NULL on failure.  The caller must free() the secret value.'/>
      <arg name='secret' type='virSecretPtr' info='A virSecret connection'/>
      <arg name='value_size' type='size_t *' info='Place for storing size of the secret value'/>
      <arg name='flags' type='unsigned int' info='flags, use 0 for now'/>
    </function>
    <function name='virSecretGetXMLDesc' file='libvirt' module='libvirt'>
2312
      <info><![CDATA[Fetches an XML document describing attributes of the secret.]]></info>
2313 2314 2315 2316
      <return type='char *' info='the XML document on success, NULL on failure.  The caller must free() the XML.'/>
      <arg name='secret' type='virSecretPtr' info='A virSecret secret'/>
      <arg name='flags' type='unsigned int' info='flags, use 0 for now'/>
    </function>
D
Daniel P. Berrange 已提交
2317
    <function name='virSecretLookupByUUID' file='libvirt' module='libvirt'>
2318 2319
      <info><![CDATA[Try to lookup a secret on the given hypervisor based on its UUID.
Uses the 16 bytes of raw data to describe the UUID]]></info>
D
Daniel P. Berrange 已提交
2320 2321 2322 2323
      <return type='virSecretPtr' info='a new secret object or NULL in case of failure.  If the secret cannot be found, then VIR_ERR_NO_SECRET error is raised.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='uuid' type='const unsigned char *' info='the raw UUID for the secret'/>
    </function>
2324
    <function name='virSecretLookupByUUIDString' file='libvirt' module='libvirt'>
2325 2326
      <info><![CDATA[Try to lookup a secret on the given hypervisor based on its UUID.
Uses the printable string value to describe the UUID]]></info>
D
Daniel P. Berrange 已提交
2327 2328 2329 2330 2331
      <return type='virSecretPtr' info='a new secret object or NULL in case of failure.  If the secret cannot be found, then VIR_ERR_NO_SECRET error is raised.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='uuidstr' type='const char *' info='the string UUID for the secret'/>
    </function>
    <function name='virSecretLookupByUsage' file='libvirt' module='libvirt'>
2332 2333 2334
      <info><![CDATA[Try to lookup a secret on the given hypervisor based on its usage
The usageID is unique within the set of secrets sharing the
same usageType value.]]></info>
D
Daniel P. Berrange 已提交
2335 2336 2337 2338
      <return type='virSecretPtr' info='a new secret object or NULL in case of failure.  If the secret cannot be found, then VIR_ERR_NO_SECRET error is raised.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='usageType' type='int' info='the type of secret usage'/>
      <arg name='usageID' type='const char *' info='identifier of the object using the secret'/>
2339 2340
    </function>
    <function name='virSecretRef' file='libvirt' module='libvirt'>
2341 2342 2343 2344 2345 2346 2347 2348 2349
      <info><![CDATA[Increment the reference count on the secret. For each additional call to
this method, there shall be a corresponding call to virSecretFree to release
the reference count, once the caller no longer needs the reference to this
object.

This method is typically useful for applications where multiple threads are
using a connection, and it is required that the connection remain open until
all threads have finished using it. ie, each new thread using a secret would
increment the reference count.]]></info>
2350 2351 2352 2353
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='secret' type='virSecretPtr' info='the secret to hold a reference on'/>
    </function>
    <function name='virSecretSetValue' file='libvirt' module='libvirt'>
2354
      <info><![CDATA[Sets the value of a secret.]]></info>
2355 2356 2357 2358 2359 2360 2361
      <return type='int' info='0 on success, -1 on failure.'/>
      <arg name='secret' type='virSecretPtr' info='A virSecret secret'/>
      <arg name='value' type='const unsigned char *' info='Value of the secret'/>
      <arg name='value_size' type='size_t' info='Size of the value'/>
      <arg name='flags' type='unsigned int' info='flags, use 0 for now'/>
    </function>
    <function name='virSecretUndefine' file='libvirt' module='libvirt'>
2362 2363
      <info><![CDATA[Deletes the specified secret.  This does not free the associated
virSecretPtr object.]]></info>
2364 2365 2366
      <return type='int' info='0 on success, -1 on failure.'/>
      <arg name='secret' type='virSecretPtr' info='A virSecret secret'/>
    </function>
2367
    <function name='virSetErrorFunc' file='virterror' module='virterror'>
2368 2369 2370
      <info><![CDATA[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>
2371 2372 2373 2374
      <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>
2375
    <function name='virStoragePoolBuild' file='libvirt' module='libvirt'>
2376
      <info><![CDATA[Build the underlying storage pool]]></info>
2377 2378
      <return type='int' info='0 on success, or -1 upon failure'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
2379
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
2380 2381
    </function>
    <function name='virStoragePoolCreate' file='libvirt' module='libvirt'>
2382
      <info><![CDATA[Starts an inactive storage pool]]></info>
2383 2384
      <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'/>
2385
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
2386 2387
    </function>
    <function name='virStoragePoolCreateXML' file='libvirt' module='libvirt'>
2388 2389 2390
      <info><![CDATA[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>
2391 2392 2393
      <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'/>
2394
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
2395 2396
    </function>
    <function name='virStoragePoolDefineXML' file='libvirt' module='libvirt'>
2397 2398
      <info><![CDATA[Define a new inactive storage pool based on its XML description. The
pool is persistent, until explicitly undefined.]]></info>
2399 2400 2401
      <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'/>
2402
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
2403 2404
    </function>
    <function name='virStoragePoolDelete' file='libvirt' module='libvirt'>
2405 2406 2407
      <info><![CDATA[Delete the underlying pool resources. This is
a non-recoverable operation. The virStoragePoolPtr object
itself is not free'd.]]></info>
2408 2409 2410 2411 2412
      <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'>
2413 2414 2415 2416 2417
      <info><![CDATA[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>
2418 2419 2420 2421
      <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'>
2422 2423
      <info><![CDATA[Free a storage pool object, releasing all memory associated with
it. Does not change the state of the pool on the host.]]></info>
2424 2425 2426 2427
      <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'>
2428 2429
      <info><![CDATA[Fetches the value of the autostart flag, which determines
whether the pool is automatically started at boot time]]></info>
2430 2431 2432 2433 2434
      <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'>
2435 2436 2437 2438 2439 2440 2441
      <info><![CDATA[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>
2442
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
2443
      <arg name='pool' type='virStoragePoolPtr' info='pointer to a pool'/>
2444 2445
    </function>
    <function name='virStoragePoolGetInfo' file='libvirt' module='libvirt'>
2446 2447
      <info><![CDATA[Get volatile information about the storage pool
such as free space / usage summary]]></info>
2448 2449 2450 2451 2452
      <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'>
2453
      <info><![CDATA[Fetch the locally unique name of the storage pool]]></info>
2454 2455 2456 2457
      <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'>
2458
      <info><![CDATA[Fetch the globally unique ID of the storage pool]]></info>
2459 2460 2461 2462 2463
      <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'>
2464
      <info><![CDATA[Fetch the globally unique ID of the storage pool as a string]]></info>
2465 2466 2467 2468 2469
      <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'>
2470 2471 2472
      <info><![CDATA[Fetch an XML document describing all aspects of the
storage pool. This is suitable for later feeding back
into the virStoragePoolCreateXML method.]]></info>
2473 2474
      <return type='char *' info='a XML document, or NULL on error'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
2475
      <arg name='flags' type='unsigned int' info='flags for XML format options (set of virDomainXMLFlags)'/>
2476 2477
    </function>
    <function name='virStoragePoolListVolumes' file='libvirt' module='libvirt'>
2478 2479
      <info><![CDATA[Fetch list of storage volume names, limiting to
at most maxnames.]]></info>
2480 2481 2482 2483 2484 2485
      <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'>
2486
      <info><![CDATA[Fetch a storage pool based on its unique name]]></info>
2487 2488 2489 2490 2491
      <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'>
2492
      <info><![CDATA[Fetch a storage pool based on its globally unique id]]></info>
2493 2494 2495 2496 2497
      <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'>
2498
      <info><![CDATA[Fetch a storage pool based on its globally unique id]]></info>
2499 2500 2501 2502 2503
      <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'>
2504
      <info><![CDATA[Fetch a storage pool which contains a particular volume]]></info>
2505 2506 2507 2508
      <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'>
2509
      <info><![CDATA[Fetch the number of storage volumes within a pool]]></info>
2510 2511 2512
      <return type='int' info='the number of storage pools, or -1 on failure'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
    </function>
2513
    <function name='virStoragePoolRef' file='libvirt' module='libvirt'>
2514 2515 2516 2517 2518 2519 2520 2521 2522 2523
      <info><![CDATA[Increment the reference count on the pool. For each
additional call to this method, there shall be a corresponding
call to virStoragePoolFree to release the reference count, once
the caller no longer needs the reference to this object.

This method is typically useful for applications where multiple
threads are using a connection, and it is required that the
connection remain open until all threads have finished using
it. ie, each new thread using a pool would increment
the reference count.]]></info>
D
Daniel Veillard 已提交
2524 2525
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='pool' type='virStoragePoolPtr' info='the pool to hold a reference on'/>
2526
    </function>
2527
    <function name='virStoragePoolRefresh' file='libvirt' module='libvirt'>
2528 2529 2530
      <info><![CDATA[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>
2531 2532 2533 2534 2535
      <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'>
2536
      <info><![CDATA[Sets the autostart flag]]></info>
2537 2538 2539 2540 2541
      <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'>
2542
      <info><![CDATA[Undefine an inactive storage pool]]></info>
D
Daniel Veillard 已提交
2543
      <return type='int' info='0 on success, -1 on failure'/>
2544 2545 2546
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
    </function>
    <function name='virStorageVolCreateXML' file='libvirt' module='libvirt'>
2547 2548 2549
      <info><![CDATA[Create a storage volume within a pool based
on an XML description. Not all pools support
creation of volumes]]></info>
2550 2551 2552 2553 2554
      <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>
2555
    <function name='virStorageVolCreateXMLFrom' file='libvirt' module='libvirt'>
2556 2557 2558 2559
      <info><![CDATA[Create a storage volume in the parent pool, using the
'clonevol' volume as input. Information for the new
volume (name, perms)  are passed via a typical volume
XML description.]]></info>
2560 2561 2562 2563 2564 2565
      <return type='virStorageVolPtr' info='the storage volume, or NULL on error'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to parent pool for the new volume'/>
      <arg name='xmldesc' type='const char *' info='description of volume to create'/>
      <arg name='clonevol' type='virStorageVolPtr' info='storage volume to use as input'/>
      <arg name='flags' type='unsigned int' info='flags for creation (unused, pass 0)'/>
    </function>
2566
    <function name='virStorageVolDelete' file='libvirt' module='libvirt'>
2567
      <info><![CDATA[Delete the storage volume from the pool]]></info>
2568 2569
      <return type='int' info='0 on success, or -1 on error'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
2570
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
2571 2572
    </function>
    <function name='virStorageVolFree' file='libvirt' module='libvirt'>
2573 2574
      <info><![CDATA[Release the storage volume handle. The underlying
storage volume continues to exist.]]></info>
2575 2576 2577 2578
      <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'>
2579 2580 2581 2582 2583 2584 2585
      <info><![CDATA[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>
2586
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
2587
      <arg name='vol' type='virStorageVolPtr' info='pointer to a pool'/>
2588 2589
    </function>
    <function name='virStorageVolGetInfo' file='libvirt' module='libvirt'>
2590 2591
      <info><![CDATA[Fetches volatile information about the storage
volume such as its current allocation]]></info>
2592 2593 2594 2595 2596
      <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'>
2597 2598 2599
      <info><![CDATA[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>
2600 2601 2602 2603
      <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'>
2604 2605
      <info><![CDATA[Fetch the storage volume name. This is unique
within the scope of a pool]]></info>
2606 2607 2608 2609
      <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'>
2610 2611 2612 2613 2614
      <info><![CDATA[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>
2615 2616 2617 2618
      <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'>
2619 2620
      <info><![CDATA[Fetch an XML document describing all aspects of
the storage volume]]></info>
2621 2622 2623 2624 2625
      <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'>
2626 2627
      <info><![CDATA[Fetch a pointer to a storage volume based on its
globally unique key]]></info>
2628 2629 2630 2631 2632
      <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'>
2633 2634
      <info><![CDATA[Fetch a pointer to a storage volume based on its name
within a pool]]></info>
2635 2636 2637 2638 2639
      <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'>
2640 2641
      <info><![CDATA[Fetch a pointer to a storage volume based on its
locally (host) unique path]]></info>
2642 2643 2644 2645
      <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>
2646
    <function name='virStorageVolRef' file='libvirt' module='libvirt'>
2647 2648 2649 2650 2651 2652 2653 2654 2655 2656
      <info><![CDATA[Increment the reference count on the vol. For each
additional call to this method, there shall be a corresponding
call to virStorageVolFree to release the reference count, once
the caller no longer needs the reference to this object.

This method is typically useful for applications where multiple
threads are using a connection, and it is required that the
connection remain open until all threads have finished using
it. ie, each new thread using a vol would increment
the reference count.]]></info>
D
Daniel Veillard 已提交
2657 2658
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='vol' type='virStorageVolPtr' info='the vol to hold a reference on'/>
2659
    </function>
2660 2661
  </symbols>
</api>