You need to sign in or sign up before continuing.
libvirt-api.xml 195.0 KB
Newer Older
1
<?xml version="1.0" encoding="ISO-8859-1"?>
D
Daniel Veillard 已提交
2
<api name='libvirt'>
3
  <files>
4 5
    <file name='libvirt'>
     <summary>core interfaces for the libvirt library</summary>
6
     <description>Provides the interfaces of the libvirt library to handle virtualized domains </description>
7
     <author>Daniel Veillard &lt;veillard@redhat.com&gt; </author>
8
     <exports symbol='VIR_NODEINFO_MAXCPUS' type='macro'/>
9
     <exports symbol='LIBVIR_VERSION_NUMBER' type='macro'/>
10
     <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_STREAM_NONBLOCK' type='enum'/>
29
     <exports symbol='VIR_STORAGE_POOL_BUILDING' type='enum'/>
30 31
     <exports symbol='VIR_CRED_CNONCE' type='enum'/>
     <exports symbol='VIR_CRED_ECHOPROMPT' type='enum'/>
32
     <exports symbol='VIR_DOMAIN_EVENT_STARTED_BOOTED' type='enum'/>
33 34
     <exports symbol='VIR_DOMAIN_EVENT_RESUMED' type='enum'/>
     <exports symbol='VIR_VCPU_OFFLINE' type='enum'/>
35
     <exports symbol='VIR_STORAGE_VOL_DELETE_NORMAL' type='enum'/>
36 37
     <exports symbol='VIR_STORAGE_POOL_RUNNING' type='enum'/>
     <exports symbol='VIR_STORAGE_POOL_BUILD_RESIZE' type='enum'/>
38
     <exports symbol='VIR_DOMAIN_EVENT_STOPPED_FAILED' type='enum'/>
39
     <exports symbol='VIR_CONNECT_RO' type='enum'/>
40
     <exports symbol='VIR_DOMAIN_EVENT_STOPPED' type='enum'/>
41
     <exports symbol='VIR_CRED_AUTHNAME' type='enum'/>
42
     <exports symbol='VIR_STORAGE_POOL_BUILD_REPAIR' type='enum'/>
43 44
     <exports symbol='VIR_CRED_LANGUAGE' type='enum'/>
     <exports symbol='VIR_CRED_NOECHOPROMPT' type='enum'/>
45
     <exports symbol='VIR_STREAM_EVENT_ERROR' type='enum'/>
46
     <exports symbol='VIR_DOMAIN_EVENT_UNDEFINED' type='enum'/>
47
     <exports symbol='VIR_MIGRATE_LIVE' type='enum'/>
48 49
     <exports symbol='VIR_DOMAIN_EVENT_STOPPED_DESTROYED' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_DEFINED_ADDED' type='enum'/>
D
Daniel P. Berrange 已提交
50
     <exports symbol='VIR_SECRET_USAGE_TYPE_NONE' type='enum'/>
51
     <exports symbol='VIR_DOMAIN_EVENT_STARTED_MIGRATED' type='enum'/>
52
     <exports symbol='VIR_STREAM_EVENT_HANGUP' type='enum'/>
53
     <exports symbol='VIR_MEMORY_VIRTUAL' type='enum'/>
54 55
     <exports symbol='VIR_CRED_USERNAME' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_RESUMED_UNPAUSED' type='enum'/>
56
     <exports symbol='VIR_DOMAIN_RUNNING' type='enum'/>
D
Daniel Veillard 已提交
57
     <exports symbol='VIR_STORAGE_VOL_DELETE_ZEROED' type='enum'/>
58 59
     <exports symbol='VIR_EVENT_HANDLE_ERROR' type='enum'/>
     <exports symbol='VIR_DOMAIN_NOSTATE' type='enum'/>
60
     <exports symbol='VIR_DOMAIN_SHUTOFF' type='enum'/>
61 62
     <exports symbol='VIR_STORAGE_POOL_DELETE_ZEROED' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_STARTED_RESTORED' type='enum'/>
63
     <exports symbol='VIR_EVENT_HANDLE_WRITABLE' type='enum'/>
64 65
     <exports symbol='VIR_STORAGE_POOL_BUILD_NEW' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_SUSPENDED_PAUSED' type='enum'/>
66
     <exports symbol='VIR_STORAGE_POOL_DELETE_NORMAL' type='enum'/>
D
Daniel Veillard 已提交
67
     <exports symbol='VIR_MEMORY_PHYSICAL' type='enum'/>
68
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_INT' type='enum'/>
69
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_ULLONG' type='enum'/>
70
     <exports symbol='VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN' type='enum'/>
71
     <exports symbol='VIR_CRED_REALM' type='enum'/>
72
     <exports symbol='VIR_DOMAIN_EVENT_STARTED' type='enum'/>
73
     <exports symbol='VIR_STORAGE_VOL_FILE' type='enum'/>
D
Daniel P. Berrange 已提交
74
     <exports symbol='VIR_SECRET_USAGE_TYPE_VOLUME' type='enum'/>
75
     <exports symbol='VIR_EVENT_HANDLE_HANGUP' type='enum'/>
76
     <exports symbol='VIR_DOMAIN_PAUSED' type='enum'/>
77
     <exports symbol='VIR_STORAGE_POOL_DEGRADED' type='enum'/>
78 79
     <exports symbol='VIR_DOMAIN_EVENT_DEFINED_UPDATED' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_SUSPENDED_MIGRATED' type='enum'/>
80
     <exports symbol='VIR_DOMAIN_CRASHED' type='enum'/>
81
     <exports symbol='VIR_VCPU_RUNNING' type='enum'/>
82
     <exports symbol='VIR_STREAM_EVENT_WRITABLE' type='enum'/>
83 84
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_DOUBLE' type='enum'/>
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_LLONG' type='enum'/>
M
Matthias Bolte 已提交
85
     <exports symbol='VIR_VCPU_BLOCKED' type='enum'/>
86
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_BOOLEAN' type='enum'/>
87
     <exports symbol='VIR_DOMAIN_XML_INACTIVE' type='enum'/>
88
     <exports symbol='VIR_STORAGE_VOL_BLOCK' type='enum'/>
89
     <exports symbol='VIR_DOMAIN_NONE' type='enum'/>
90 91
     <exports symbol='VIR_DOMAIN_EVENT_UNDEFINED_REMOVED' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_RESUMED_MIGRATED' type='enum'/>
92
     <exports symbol='VIR_DOMAIN_BLOCKED' type='enum'/>
93 94 95 96
     <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'/>
97
     <exports symbol='VIR_STREAM_EVENT_READABLE' type='enum'/>
98
     <exports symbol='VIR_DOMAIN_XML_SECURE' type='enum'/>
99
     <exports symbol='VIR_DOMAIN_EVENT_SUSPENDED' type='enum'/>
100
     <exports symbol='virDomainBlockStatsStruct' type='typedef'/>
101
     <exports symbol='virDomainMigrateFlags' type='typedef'/>
102 103
     <exports symbol='virNodeInfo' type='typedef'/>
     <exports symbol='virNetwork' type='typedef'/>
104
     <exports symbol='virDomainEventResumedDetailType' type='typedef'/>
105 106
     <exports symbol='virDomainBlockStatsPtr' type='typedef'/>
     <exports symbol='virConnect' type='typedef'/>
107
     <exports symbol='virSecretPtr' type='typedef'/>
108
     <exports symbol='virDomainEventStartedDetailType' type='typedef'/>
109
     <exports symbol='virDomainInfo' type='typedef'/>
110
     <exports symbol='virStoragePoolDeleteFlags' type='typedef'/>
111
     <exports symbol='virEventHandleType' type='typedef'/>
112
     <exports symbol='virStoragePool' type='typedef'/>
113
     <exports symbol='virDomainEventType' type='typedef'/>
114
     <exports symbol='virStream' type='typedef'/>
115
     <exports symbol='virDomainInterfaceStatsStruct' type='typedef'/>
116
     <exports symbol='virStoragePoolInfo' type='typedef'/>
117
     <exports symbol='virSecret' type='typedef'/>
118
     <exports symbol='virStreamPtr' type='typedef'/>
119 120
     <exports symbol='virDomainState' type='typedef'/>
     <exports symbol='virDomain' type='typedef'/>
121
     <exports symbol='virDomainInterfaceStatsPtr' type='typedef'/>
122
     <exports symbol='virConnectAuthPtr' type='typedef'/>
123
     <exports symbol='virStorageVolInfo' type='typedef'/>
124
     <exports symbol='virSchedParameterType' type='typedef'/>
125
     <exports symbol='virSecurityLabel' type='typedef'/>
D
Daniel P. Berrange 已提交
126
     <exports symbol='virStorageVolInfoPtr' type='typedef'/>
127
     <exports symbol='virConnectCredentialPtr' type='typedef'/>
128
     <exports symbol='virStoragePoolPtr' type='typedef'/>
129 130 131
     <exports symbol='virNodeInfoPtr' type='typedef'/>
     <exports symbol='virNetworkPtr' type='typedef'/>
     <exports symbol='virDomainInfoPtr' type='typedef'/>
D
Daniel P. Berrange 已提交
132
     <exports symbol='virNodeDevice' type='typedef'/>
133
     <exports symbol='virConnectPtr' type='typedef'/>
134
     <exports symbol='virStorageVol' type='typedef'/>
D
Daniel P. Berrange 已提交
135
     <exports symbol='virNodeDevicePtr' type='typedef'/>
136
     <exports symbol='virStreamEventType' type='typedef'/>
137
     <exports symbol='virInterface' type='typedef'/>
138
     <exports symbol='virSchedParameter' type='typedef'/>
139
     <exports symbol='virConnectFlags' type='typedef'/>
140
     <exports symbol='virDomainEventDefinedDetailType' type='typedef'/>
141
     <exports symbol='virInterfacePtr' type='typedef'/>
142
     <exports symbol='virStreamFlags' type='typedef'/>
143
     <exports symbol='virDomainMemoryFlags' type='typedef'/>
144
     <exports symbol='virDomainEventStoppedDetailType' type='typedef'/>
145
     <exports symbol='virStorageVolPtr' type='typedef'/>
146
     <exports symbol='virVcpuState' type='typedef'/>
147
     <exports symbol='virStorageVolDeleteFlags' type='typedef'/>
148
     <exports symbol='virVcpuInfo' type='typedef'/>
149
     <exports symbol='virSchedParameterPtr' type='typedef'/>
150 151
     <exports symbol='virConnectAuth' type='typedef'/>
     <exports symbol='virConnectCredential' type='typedef'/>
152
     <exports symbol='virSecurityModelPtr' type='typedef'/>
153
     <exports symbol='virDomainEventSuspendedDetailType' type='typedef'/>
154
     <exports symbol='virVcpuInfoPtr' type='typedef'/>
155
     <exports symbol='virStoragePoolBuildFlags' type='typedef'/>
156
     <exports symbol='virDomainXMLFlags' type='typedef'/>
157
     <exports symbol='virStorageVolType' type='typedef'/>
158
     <exports symbol='virDomainEventUndefinedDetailType' type='typedef'/>
159
     <exports symbol='virDomainPtr' type='typedef'/>
160
     <exports symbol='virConnectCredentialType' type='typedef'/>
161 162
     <exports symbol='virStoragePoolState' type='typedef'/>
     <exports symbol='virStoragePoolInfoPtr' type='typedef'/>
163
     <exports symbol='virDomainCreateFlags' type='typedef'/>
164 165
     <exports symbol='virSecurityLabelPtr' type='typedef'/>
     <exports symbol='virSecurityModel' type='typedef'/>
D
Daniel P. Berrange 已提交
166
     <exports symbol='virSecretUsageType' type='typedef'/>
167
     <exports symbol='_virDomainInfo' type='struct'/>
168
     <exports symbol='_virConnectAuth' type='struct'/>
169
     <exports symbol='_virVcpuInfo' type='struct'/>
170
     <exports symbol='_virDomainInterfaceStats' type='struct'/>
171
     <exports symbol='_virStoragePoolInfo' type='struct'/>
172
     <exports symbol='_virConnectCredential' type='struct'/>
173
     <exports symbol='_virSecurityLabel' type='struct'/>
174
     <exports symbol='_virStorageVolInfo' type='struct'/>
175
     <exports symbol='_virSecurityModel' type='struct'/>
176 177
     <exports symbol='_virDomainBlockStats' type='struct'/>
     <exports symbol='_virNodeInfo' type='struct'/>
178 179
     <exports symbol='_virSchedParameter' type='struct'/>
     <exports symbol='virConnectAuthPtrDefault' type='variable'/>
180
     <exports symbol='virStoragePoolGetXMLDesc' type='function'/>
181
     <exports symbol='virSecretGetUUIDString' type='function'/>
182
     <exports symbol='virStorageVolGetKey' type='function'/>
183
     <exports symbol='virEventUpdateTimeoutFunc' type='function'/>
184
     <exports symbol='virDomainUndefine' type='function'/>
185 186
     <exports symbol='virDomainDefineXML' type='function'/>
     <exports symbol='virDomainShutdown' type='function'/>
187
     <exports symbol='virConnectListDefinedInterfaces' type='function'/>
188
     <exports symbol='virGetVersion' type='function'/>
189
     <exports symbol='virNodeGetCellsFreeMemory' type='function'/>
190
     <exports symbol='virInitialize' type='function'/>
D
Daniel P. Berrange 已提交
191
     <exports symbol='virNodeDeviceGetName' type='function'/>
192
     <exports symbol='virConnectNumOfSecrets' type='function'/>
193
     <exports symbol='virStoragePoolSetAutostart' type='function'/>
194
     <exports symbol='virConnectDomainXMLFromNative' type='function'/>
195 196
     <exports symbol='virNodeDeviceDettach' type='function'/>
     <exports symbol='virDomainGetSecurityLabel' type='function'/>
197
     <exports symbol='virConnectDomainEventDeregister' type='function'/>
198 199 200
     <exports symbol='virDomainGetSchedulerParameters' type='function'/>
     <exports symbol='virDomainLookupByUUIDString' type='function'/>
     <exports symbol='virConnectNumOfDefinedNetworks' type='function'/>
201
     <exports symbol='virStreamRecvAll' type='function'/>
202
     <exports symbol='virConnectListStoragePools' type='function'/>
203
     <exports symbol='virNetworkGetUUID' type='function'/>
204
     <exports symbol='virInterfaceGetXMLDesc' type='function'/>
205 206 207
     <exports symbol='virStoragePoolGetConnect' type='function'/>
     <exports symbol='virConnectGetVersion' type='function'/>
     <exports symbol='virDomainFree' type='function'/>
208
     <exports symbol='virStorageVolRef' type='function'/>
209 210 211 212 213
     <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'/>
214
     <exports symbol='virStreamSinkFunc' type='function'/>
215
     <exports symbol='virNetworkCreate' type='function'/>
D
Daniel P. Berrange 已提交
216
     <exports symbol='virSecretLookupByUUID' type='function'/>
217
     <exports symbol='virDomainSetMaxMemory' type='function'/>
218
     <exports symbol='virEventRegisterImpl' type='function'/>
219
     <exports symbol='virInterfaceDefineXML' type='function'/>
220 221
     <exports symbol='virDomainMigrate' type='function'/>
     <exports symbol='virDomainSuspend' type='function'/>
222
     <exports symbol='virStreamSourceFunc' type='function'/>
223
     <exports symbol='virDomainCreateLinux' type='function'/>
D
Daniel P. Berrange 已提交
224
     <exports symbol='virNodeDeviceGetXMLDesc' type='function'/>
225
     <exports symbol='virEventUpdateHandleFunc' type='function'/>
226 227 228
     <exports symbol='virDomainDestroy' type='function'/>
     <exports symbol='virConnectNumOfNetworks' type='function'/>
     <exports symbol='virStoragePoolLookupByUUIDString' type='function'/>
229
     <exports symbol='virSecretGetConnect' type='function'/>
230
     <exports symbol='virInterfaceCreate' type='function'/>
231
     <exports symbol='virDomainGetXMLDesc' type='function'/>
D
Daniel P. Berrange 已提交
232
     <exports symbol='virSecretLookupByUsage' type='function'/>
233
     <exports symbol='virStoragePoolGetUUID' type='function'/>
D
Daniel P. Berrange 已提交
234
     <exports symbol='virNodeDeviceFree' type='function'/>
D
Daniel P. Berrange 已提交
235
     <exports symbol='virSecretGetUsageType' type='function'/>
236
     <exports symbol='virDomainGetInfo' type='function'/>
237
     <exports symbol='virNodeDeviceCreateXML' type='function'/>
238 239
     <exports symbol='virNetworkDestroy' type='function'/>
     <exports symbol='virStoragePoolLookupByName' type='function'/>
D
Daniel P. Berrange 已提交
240
     <exports symbol='virStoragePoolCreateXML' type='function'/>
241
     <exports symbol='virStreamFree' type='function'/>
242
     <exports symbol='virNetworkGetAutostart' type='function'/>
243
     <exports symbol='virNetworkGetBridgeName' type='function'/>
244
     <exports symbol='virStorageVolGetXMLDesc' type='function'/>
245
     <exports symbol='virConnectDomainXMLToNative' type='function'/>
246
     <exports symbol='virDomainSetSchedulerParameters' type='function'/>
247
     <exports symbol='virConnectGetType' type='function'/>
248
     <exports symbol='virStorageVolCreateXML' type='function'/>
249
     <exports symbol='virDomainSave' type='function'/>
250
     <exports symbol='virDomainCreate' type='function'/>
251
     <exports symbol='virStreamEventAddCallback' type='function'/>
252
     <exports symbol='virConnectListDomains' type='function'/>
D
Daniel Veillard 已提交
253
     <exports symbol='virDomainCoreDump' type='function'/>
254
     <exports symbol='virDomainSetMemory' type='function'/>
255
     <exports symbol='virInterfaceGetName' type='function'/>
256
     <exports symbol='virStoragePoolCreate' type='function'/>
257
     <exports symbol='virNodeGetInfo' type='function'/>
258
     <exports symbol='virNetworkSetAutostart' type='function'/>
259
     <exports symbol='virSecretLookupByUUIDString' type='function'/>
D
Daniel Veillard 已提交
260
     <exports symbol='virDomainGetMaxMemory' type='function'/>
261 262
     <exports symbol='virStreamRef' type='function'/>
     <exports symbol='virStreamAbort' type='function'/>
263
     <exports symbol='virStoragePoolFree' type='function'/>
D
Daniel Veillard 已提交
264
     <exports symbol='virConnectNumOfDefinedInterfaces' type='function'/>
D
Daniel P. Berrange 已提交
265
     <exports symbol='virFreeCallback' type='function'/>
266
     <exports symbol='virNetworkDefineXML' type='function'/>
D
Daniel P. Berrange 已提交
267
     <exports symbol='virNodeDeviceListCaps' type='function'/>
268
     <exports symbol='virDomainBlockStats' type='function'/>
269
     <exports symbol='virStreamFinish' type='function'/>
270
     <exports symbol='virConnectOpenAuth' type='function'/>
271
     <exports symbol='virStoragePoolDelete' type='function'/>
272
     <exports symbol='virDomainResume' type='function'/>
273
     <exports symbol='virStorageVolGetName' type='function'/>
274
     <exports symbol='virStreamNew' type='function'/>
275
     <exports symbol='virStoragePoolGetAutostart' type='function'/>
276
     <exports symbol='virDomainGetAutostart' type='function'/>
277
     <exports symbol='virStoragePoolListVolumes' type='function'/>
278
     <exports symbol='virConnectGetHostname' type='function'/>
279
     <exports symbol='virEventRemoveTimeoutFunc' type='function'/>
D
Daniel P. Berrange 已提交
280
     <exports symbol='virStorageVolGetInfo' type='function'/>
281
     <exports symbol='virDomainGetName' type='function'/>
282
     <exports symbol='virStoragePoolRef' type='function'/>
283 284
     <exports symbol='virNetworkGetXMLDesc' type='function'/>
     <exports symbol='virConnectNumOfStoragePools' type='function'/>
285
     <exports symbol='virInterfaceGetConnect' type='function'/>
D
Daniel P. Berrange 已提交
286
     <exports symbol='virStoragePoolNumOfVolumes' type='function'/>
287
     <exports symbol='virNetworkGetName' type='function'/>
288
     <exports symbol='virSecretGetXMLDesc' type='function'/>
289 290 291
     <exports symbol='virConnectListDefinedDomains' type='function'/>
     <exports symbol='virConnectGetCapabilities' type='function'/>
     <exports symbol='virDomainLookupByName' type='function'/>
292
     <exports symbol='virConnectFindStoragePoolSources' type='function'/>
293
     <exports symbol='virStorageVolFree' type='function'/>
294
     <exports symbol='virDomainPinVcpu' type='function'/>
295
     <exports symbol='virNodeGetSecurityModel' type='function'/>
296
     <exports symbol='virDomainRestore' type='function'/>
D
Daniel P. Berrange 已提交
297
     <exports symbol='virSecretGetUUID' type='function'/>
D
Daniel Veillard 已提交
298
     <exports symbol='virNodeDeviceDestroy' type='function'/>
299 300
     <exports symbol='virStorageVolGetPath' type='function'/>
     <exports symbol='virNetworkLookupByUUIDString' type='function'/>
301
     <exports symbol='virConnectDomainEventCallback' type='function'/>
302
     <exports symbol='virDomainLookupByID' type='function'/>
303
     <exports symbol='virStorageVolDelete' type='function'/>
304
     <exports symbol='virSecretUndefine' type='function'/>
305
     <exports symbol='virConnectListInterfaces' type='function'/>
306
     <exports symbol='virDomainMemoryPeek' type='function'/>
307 308
     <exports symbol='virNetworkLookupByUUID' type='function'/>
     <exports symbol='virConnectListDefinedNetworks' type='function'/>
309
     <exports symbol='virConnectRef' type='function'/>
310 311
     <exports symbol='virDomainGetUUID' type='function'/>
     <exports symbol='virNetworkCreateXML' type='function'/>
D
Daniel Veillard 已提交
312
     <exports symbol='virNetworkUndefine' type='function'/>
313
     <exports symbol='virConnectDomainEventRegister' type='function'/>
314
     <exports symbol='virDomainGetVcpus' type='function'/>
D
Daniel P. Berrange 已提交
315
     <exports symbol='virNodeDeviceLookupByName' type='function'/>
316
     <exports symbol='virStoragePoolGetInfo' type='function'/>
317
     <exports symbol='virEventRemoveHandleFunc' type='function'/>
318 319
     <exports symbol='virInterfaceRef' type='function'/>
     <exports symbol='virInterfaceGetMACString' type='function'/>
D
Daniel Veillard 已提交
320
     <exports symbol='virConnectNumOfDomains' type='function'/>
321 322
     <exports symbol='virStoragePoolRefresh' type='function'/>
     <exports symbol='virConnectNumOfDefinedDomains' type='function'/>
323
     <exports symbol='virStorageVolCreateXMLFrom' type='function'/>
324
     <exports symbol='virConnectClose' type='function'/>
325
     <exports symbol='virDomainReboot' type='function'/>
326
     <exports symbol='virStreamEventCallback' type='function'/>
327 328 329
     <exports symbol='virNetworkGetUUIDString' type='function'/>
     <exports symbol='virNetworkLookupByName' type='function'/>
     <exports symbol='virDomainGetMaxVcpus' type='function'/>
330
     <exports symbol='virStreamEventUpdateCallback' type='function'/>
331
     <exports symbol='virEventHandleCallback' type='function'/>
332
     <exports symbol='virDomainGetSchedulerType' type='function'/>
333
     <exports symbol='virNodeDeviceReset' type='function'/>
334
     <exports symbol='virDomainDetachDevice' type='function'/>
D
Daniel P. Berrange 已提交
335
     <exports symbol='virSecretGetUsageID' type='function'/>
336
     <exports symbol='virStoragePoolGetUUIDString' type='function'/>
337
     <exports symbol='virNodeDeviceReAttach' type='function'/>
338
     <exports symbol='virStoragePoolUndefine' type='function'/>
339
     <exports symbol='virConnectAuthCallbackPtr' type='function'/>
340
     <exports symbol='virDomainAttachDevice' type='function'/>
341
     <exports symbol='virConnectGetURI' type='function'/>
342
     <exports symbol='virConnectOpenReadOnly' type='function'/>
343
     <exports symbol='virSecretDefineXML' type='function'/>
344 345
     <exports symbol='virNetworkFree' type='function'/>
     <exports symbol='virStoragePoolLookupByUUID' type='function'/>
346
     <exports symbol='virEventAddHandleFunc' type='function'/>
D
Daniel Veillard 已提交
347
     <exports symbol='virNetworkRef' type='function'/>
348
     <exports symbol='virConnectListDefinedStoragePools' type='function'/>
349
     <exports symbol='virEventTimeoutCallback' type='function'/>
350
     <exports symbol='virInterfaceFree' type='function'/>
D
Daniel P. Berrange 已提交
351
     <exports symbol='virNodeDeviceNumOfCaps' type='function'/>
352
     <exports symbol='virInterfaceLookupByMACString' type='function'/>
353 354
     <exports symbol='virNetworkGetConnect' type='function'/>
     <exports symbol='virNodeGetFreeMemory' type='function'/>
355
     <exports symbol='virInterfaceDestroy' type='function'/>
356
     <exports symbol='virSecretSetValue' type='function'/>
357
     <exports symbol='virStorageVolGetConnect' type='function'/>
D
Daniel P. Berrange 已提交
358
     <exports symbol='virNodeNumOfDevices' type='function'/>
359
     <exports symbol='virStoragePoolDestroy' type='function'/>
360
     <exports symbol='virStreamRecv' type='function'/>
361 362
     <exports symbol='virStoragePoolLookupByVolume' type='function'/>
     <exports symbol='virDomainLookupByUUID' type='function'/>
363
     <exports symbol='virStreamSend' type='function'/>
364 365 366 367 368 369
     <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'/>
370
     <exports symbol='virSecretFree' type='function'/>
371
     <exports symbol='virNodeListDevices' type='function'/>
D
Daniel P. Berrange 已提交
372
     <exports symbol='virNodeDeviceGetParent' type='function'/>
373
     <exports symbol='virConnectOpen' type='function'/>
374
     <exports symbol='virDomainCreateXML' type='function'/>
375 376
     <exports symbol='virStreamEventRemoveCallback' type='function'/>
     <exports symbol='virStreamSendAll' type='function'/>
377
     <exports symbol='virNodeDeviceRef' type='function'/>
378
     <exports symbol='virInterfaceUndefine' type='function'/>
379
     <exports symbol='virDomainSetVcpus' type='function'/>
380
     <exports symbol='virDomainRef' type='function'/>
381
     <exports symbol='virConnectListSecrets' type='function'/>
382
     <exports symbol='virConnectNumOfInterfaces' type='function'/>
383
     <exports symbol='virDomainGetID' type='function'/>
384
     <exports symbol='virSecretRef' type='function'/>
385
     <exports symbol='virDomainBlockPeek' type='function'/>
386
     <exports symbol='virEventAddTimeoutFunc' type='function'/>
387
     <exports symbol='virInterfaceLookupByName' type='function'/>
388 389
     <exports symbol='virDomainInterfaceStats' type='function'/>
     <exports symbol='virConnectListNetworks' type='function'/>
390
     <exports symbol='virSecretGetValue' type='function'/>
391
     <exports symbol='virStorageVolLookupByKey' type='function'/>
392 393 394 395 396 397
    </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'/>
398
     <exports symbol='VIR_FROM_ONE' type='enum'/>
399
     <exports symbol='VIR_FROM_NETWORK' type='enum'/>
D
Daniel P. Berrange 已提交
400
     <exports symbol='VIR_ERR_NO_NODE_DEVICE' type='enum'/>
401
     <exports symbol='VIR_ERR_NO_MEMORY' type='enum'/>
D
Daniel P. Berrange 已提交
402
     <exports symbol='VIR_WAR_NO_NODE' type='enum'/>
403
     <exports symbol='VIR_ERR_NO_STORAGE_VOL' type='enum'/>
404
     <exports symbol='VIR_FROM_XML' type='enum'/>
405
     <exports symbol='VIR_FROM_CONF' type='enum'/>
406
     <exports symbol='VIR_ERR_INVALID_NETWORK' type='enum'/>
407
     <exports symbol='VIR_ERR_PARSE_FAILED' type='enum'/>
408 409
     <exports symbol='VIR_ERR_POST_FAILED' type='enum'/>
     <exports symbol='VIR_ERR_INVALID_CONN' type='enum'/>
410
     <exports symbol='VIR_ERR_GET_FAILED' type='enum'/>
D
Daniel P. Berrange 已提交
411
     <exports symbol='VIR_FROM_XEN' type='enum'/>
412 413
     <exports symbol='VIR_ERR_NO_SOURCE' type='enum'/>
     <exports symbol='VIR_ERR_NETWORK_EXIST' type='enum'/>
414
     <exports symbol='VIR_ERR_NONE' type='enum'/>
415 416 417 418 419 420
     <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 已提交
421
     <exports symbol='VIR_FROM_ESX' type='enum'/>
422 423
     <exports symbol='VIR_FROM_VBOX' type='enum'/>
     <exports symbol='VIR_FROM_TEST' type='enum'/>
D
Daniel Veillard 已提交
424
     <exports symbol='VIR_ERR_MULTIPLE_INTERFACES' type='enum'/>
425 426 427 428 429 430 431 432 433
     <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'/>
434
     <exports symbol='VIR_WAR_NO_SECRET' type='enum'/>
435 436
     <exports symbol='VIR_WAR_NO_NETWORK' type='enum'/>
     <exports symbol='VIR_FROM_UML' type='enum'/>
437 438 439
     <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 已提交
440
     <exports symbol='VIR_FROM_NODEDEV' type='enum'/>
441
     <exports symbol='VIR_ERR_NO_TARGET' type='enum'/>
442
     <exports symbol='VIR_FROM_SECURITY' type='enum'/>
443
     <exports symbol='VIR_ERR_CONF_SYNTAX' type='enum'/>
444
     <exports symbol='VIR_ERR_NO_SUPPORT' type='enum'/>
445
     <exports symbol='VIR_ERR_NO_SECURITY_MODEL' type='enum'/>
D
Daniel Veillard 已提交
446
     <exports symbol='VIR_FROM_PHYP' type='enum'/>
447 448 449 450 451 452 453 454 455 456 457 458 459 460
     <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'/>
461
     <exports symbol='VIR_FROM_PROXY' type='enum'/>
462 463
     <exports symbol='VIR_ERR_DRIVER_FULL' type='enum'/>
     <exports symbol='VIR_FROM_DOMAIN' type='enum'/>
464
     <exports symbol='VIR_ERR_INVALID_SECRET' type='enum'/>
465 466
     <exports symbol='VIR_ERR_OPERATION_DENIED' type='enum'/>
     <exports symbol='VIR_ERR_INVALID_STORAGE_POOL' type='enum'/>
467
     <exports symbol='VIR_FROM_SECRET' type='enum'/>
468
     <exports symbol='VIR_ERR_NO_DOMAIN' type='enum'/>
D
Daniel P. Berrange 已提交
469
     <exports symbol='VIR_ERR_INVALID_INTERFACE' type='enum'/>
470 471 472
     <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 已提交
473
     <exports symbol='VIR_ERR_CALL_FAILED' type='enum'/>
474
     <exports symbol='VIR_ERR_ERROR' type='enum'/>
D
Daniel P. Berrange 已提交
475
     <exports symbol='VIR_ERR_NO_SECRET' type='enum'/>
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
     <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'/>
492 493 494 495 496 497 498 499
     <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'/>
500
     <exports symbol='virFreeError' type='function'/>
501 502 503 504 505 506 507 508 509 510 511
     <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'/>
512
     <exports symbol='virSaveLastError' type='function'/>
513
    </file>
514 515
  </files>
  <symbols>
516
    <macro name='LIBVIR_VERSION_NUMBER' file='libvirt'>
517
      <info><![CDATA[Macro providing the version of the library as version * 1,000,000 + minor * 1000 + micro]]></info>
518
    </macro>
519
    <macro name='VIR_COPY_CPUMAP' file='libvirt'>
520
      <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>
521 522 523 524 525 526
      <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'>
527
      <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>
528
      <arg name='cpu' info='number of physical CPUs'/>
529 530
    </macro>
    <macro name='VIR_CPU_USABLE' file='libvirt'>
531
      <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>
532 533 534 535 536
      <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>
537
    <macro name='VIR_DOMAIN_SCHED_FIELD_LENGTH' file='libvirt'>
538
      <info><![CDATA[Macro providing the field length of virSchedParameter]]></info>
539
    </macro>
540
    <macro name='VIR_GET_CPUMAP' file='libvirt'>
541
      <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>
542 543 544 545 546
      <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'>
547
      <info><![CDATA[This macro is to calculate the total number of CPUs supported but not necessary active in the host.]]></info>
548 549
      <arg name='nodeinfo' info='virNodeInfo instance'/>
    </macro>
550
    <macro name='VIR_SECURITY_DOI_BUFLEN' file='libvirt'>
551
      <info><![CDATA[Macro providing the maximum length of the virSecurityModel doi string.]]></info>
552 553
    </macro>
    <macro name='VIR_SECURITY_LABEL_BUFLEN' file='libvirt'>
554
      <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>
555 556
    </macro>
    <macro name='VIR_SECURITY_MODEL_BUFLEN' file='libvirt'>
557
      <info><![CDATA[Macro providing the maximum length of the virSecurityModel model string.]]></info>
558
    </macro>
559
    <macro name='VIR_UNUSE_CPU' file='libvirt'>
560
      <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>
561 562 563 564
      <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'>
565
      <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>
566 567 568
      <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>
569
    <macro name='VIR_UUID_BUFLEN' file='libvirt'>
570
      <info><![CDATA[This macro provides the length of the buffer required for virDomainGetUUID()]]></info>
571 572
    </macro>
    <macro name='VIR_UUID_STRING_BUFLEN' file='libvirt'>
573
      <info><![CDATA[This macro provides the length of the buffer required for virDomainGetUUIDString()]]></info>
574
    </macro>
575 576 577 578 579 580 581 582 583 584
    <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'/>
585 586
    <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'/>
587 588 589
    <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'/>
590
    <enum name='VIR_DOMAIN_EVENT_RESUMED' file='libvirt' value='4' type='virDomainEventType'/>
591 592
    <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'/>
593
    <enum name='VIR_DOMAIN_EVENT_STARTED' file='libvirt' value='2' type='virDomainEventType'/>
594 595 596
    <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'/>
597
    <enum name='VIR_DOMAIN_EVENT_STOPPED' file='libvirt' value='5' type='virDomainEventType'/>
598 599 600 601 602 603
    <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'/>
604
    <enum name='VIR_DOMAIN_EVENT_SUSPENDED' file='libvirt' value='3' type='virDomainEventType'/>
605 606 607 608
    <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'/>
609 610 611 612
    <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'/>
613 614 615 616 617 618
    <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'/>
619 620
    <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'/>
621 622
    <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'/>
623
    <enum name='VIR_ERR_AUTH_FAILED' file='virterror' value='45' type='virErrorNumber' info='authentication failed'/>
624
    <enum name='VIR_ERR_CALL_FAILED' file='virterror' value='26' type='virErrorNumber' info='not supported by the drivers (DEPRECATED)'/>
625
    <enum name='VIR_ERR_CONF_SYNTAX' file='virterror' value='33' type='virErrorNumber' info='failed to parse the syntax of a conf file'/>
626
    <enum name='VIR_ERR_DOM_EXIST' file='virterror' value='28' type='virErrorNumber' info='the domain already exist'/>
627 628 629
    <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'/>
630
    <enum name='VIR_ERR_GNUTLS_ERROR' file='virterror' value='40' type='virErrorNumber' info='error from a GNUTLS call'/>
631 632 633 634 635
    <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 已提交
636
    <enum name='VIR_ERR_INVALID_INTERFACE' file='virterror' value='58' type='virErrorNumber' info='invalid interface object'/>
637
    <enum name='VIR_ERR_INVALID_MAC' file='virterror' value='44' type='virErrorNumber' info='invalid MAC address'/>
638
    <enum name='VIR_ERR_INVALID_NETWORK' file='virterror' value='36' type='virErrorNumber' info='invalid network object'/>
D
Daniel P. Berrange 已提交
639
    <enum name='VIR_ERR_INVALID_NODE_DEVICE' file='virterror' value='52' type='virErrorNumber' info='invalid node device object'/>
D
Daniel P. Berrange 已提交
640
    <enum name='VIR_ERR_INVALID_SECRET' file='virterror' value='61' type='virErrorNumber' info='invalid secret'/>
641 642
    <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'/>
643
    <enum name='VIR_ERR_MULTIPLE_INTERFACES' file='virterror' value='59' type='virErrorNumber' info='more than one matching interface found'/>
644
    <enum name='VIR_ERR_NETWORK_EXIST' file='virterror' value='37' type='virErrorNumber' info='the network already exist'/>
645 646 647
    <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'/>
648
    <enum name='VIR_ERR_NO_DOMAIN' file='virterror' value='42' type='virErrorNumber' info='domain not found or unexpectedly disappeared'/>
649
    <enum name='VIR_ERR_NO_INTERFACE' file='virterror' value='57' type='virErrorNumber' info='interface driver not running'/>
650 651 652
    <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'/>
653
    <enum name='VIR_ERR_NO_NETWORK' file='virterror' value='43' type='virErrorNumber' info='network not found'/>
654
    <enum name='VIR_ERR_NO_NODE_DEVICE' file='virterror' value='53' type='virErrorNumber' info='node device not found'/>
655 656
    <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 已提交
657
    <enum name='VIR_ERR_NO_SECRET' file='virterror' value='62' type='virErrorNumber' info=' secret not found'/>
658
    <enum name='VIR_ERR_NO_SECURITY_MODEL' file='virterror' value='54' type='virErrorNumber' info='security model not found'/>
659
    <enum name='VIR_ERR_NO_SOURCE' file='virterror' value='19' type='virErrorNumber' info='missing source device information'/>
660
    <enum name='VIR_ERR_NO_STORAGE_POOL' file='virterror' value='49' type='virErrorNumber' info='storage pool not found'/>
D
Daniel P. Berrange 已提交
661
    <enum name='VIR_ERR_NO_STORAGE_VOL' file='virterror' value='50' type='virErrorNumber' info='storage pool not found'/>
662
    <enum name='VIR_ERR_NO_SUPPORT' file='virterror' value='3' type='virErrorNumber' info='no support for this function'/>
663 664 665 666
    <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'/>
667 668
    <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'/>
669
    <enum name='VIR_ERR_OPERATION_FAILED' file='virterror' value='9' type='virErrorNumber' info='a command to hypervisor failed'/>
670
    <enum name='VIR_ERR_OPERATION_INVALID' file='virterror' value='55' type='virErrorNumber' info='operation is not applicable at this time'/>
671
    <enum name='VIR_ERR_OS_TYPE' file='virterror' value='16' type='virErrorNumber' info='unknown OS type'/>
672
    <enum name='VIR_ERR_PARSE_FAILED' file='virterror' value='32' type='virErrorNumber' info='failed to parse a conf file'/>
673
    <enum name='VIR_ERR_POST_FAILED' file='virterror' value='11' type='virErrorNumber' info='a HTTP POST command to failed'/>
674
    <enum name='VIR_ERR_READ_FAILED' file='virterror' value='31' type='virErrorNumber' info='failed to read a conf file'/>
675
    <enum name='VIR_ERR_RPC' file='virterror' value='39' type='virErrorNumber' info='some sort of RPC error'/>
676
    <enum name='VIR_ERR_SEXPR_SERIAL' file='virterror' value='13' type='virErrorNumber' info='failure to serialize an S-Expr'/>
677
    <enum name='VIR_ERR_SYSTEM_ERROR' file='virterror' value='38' type='virErrorNumber' info='general system call failure'/>
678 679
    <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'/>
680
    <enum name='VIR_ERR_WRITE_FAILED' file='virterror' value='34' type='virErrorNumber' info='failed to write a conf file'/>
681
    <enum name='VIR_ERR_XEN_CALL' file='virterror' value='15' type='virErrorNumber' info='failure doing an hypervisor call'/>
682
    <enum name='VIR_ERR_XML_DETAIL' file='virterror' value='35' type='virErrorNumber' info='detail of an XML error'/>
683
    <enum name='VIR_ERR_XML_ERROR' file='virterror' value='27' type='virErrorNumber' info='an XML description is not well formed or broken'/>
684 685 686 687
    <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'/>
688
    <enum name='VIR_FROM_CONF' file='virterror' value='9' type='virErrorDomain' info='Error in the configuration file handling'/>
689
    <enum name='VIR_FROM_DOM' file='virterror' value='6' type='virErrorDomain' info='Error when operating on a domain'/>
D
Daniel P. Berrange 已提交
690
    <enum name='VIR_FROM_DOMAIN' file='virterror' value='20' type='virErrorDomain' info='Error from domain config'/>
D
Daniel Veillard 已提交
691
    <enum name='VIR_FROM_ESX' file='virterror' value='28' type='virErrorDomain' info='Error from ESX driver'/>
692
    <enum name='VIR_FROM_INTERFACE' file='virterror' value='26' type='virErrorDomain' info='Error when operating on an interface'/>
D
Daniel Veillard 已提交
693
    <enum name='VIR_FROM_LXC' file='virterror' value='17' type='virErrorDomain' info='Error from Linux Container driver'/>
694
    <enum name='VIR_FROM_NET' file='virterror' value='11' type='virErrorDomain' info='Error when operating on a network'/>
695
    <enum name='VIR_FROM_NETWORK' file='virterror' value='19' type='virErrorDomain' info='Error from network config'/>
D
Daniel Veillard 已提交
696
    <enum name='VIR_FROM_NODEDEV' file='virterror' value='22' type='virErrorDomain' info='Error from node device monitor'/>
697
    <enum name='VIR_FROM_NONE' file='virterror' value='0' type='virErrorDomain'/>
D
Daniel Veillard 已提交
698
    <enum name='VIR_FROM_ONE' file='virterror' value='27' type='virErrorDomain' info='Error from OpenNebula driver'/>
R
Richard W.M. Jones 已提交
699
    <enum name='VIR_FROM_OPENVZ' file='virterror' value='14' type='virErrorDomain' info='Error from OpenVZ driver'/>
700
    <enum name='VIR_FROM_PHYP' file='virterror' value='29' type='virErrorDomain' info='Error from IBM power hypervisor'/>
701
    <enum name='VIR_FROM_PROXY' file='virterror' value='8' type='virErrorDomain' info='Error in the proxy code'/>
702
    <enum name='VIR_FROM_QEMU' file='virterror' value='10' type='virErrorDomain' info='Error at the QEMU daemon'/>
703
    <enum name='VIR_FROM_REMOTE' file='virterror' value='13' type='virErrorDomain' info='Error from remote driver'/>
704
    <enum name='VIR_FROM_RPC' file='virterror' value='7' type='virErrorDomain' info='Error in the XML-RPC code'/>
705
    <enum name='VIR_FROM_SECRET' file='virterror' value='30' type='virErrorDomain' info=' Error from secret storage'/>
706
    <enum name='VIR_FROM_SECURITY' file='virterror' value='24' type='virErrorDomain' info='Error from security framework'/>
707
    <enum name='VIR_FROM_SEXPR' file='virterror' value='4' type='virErrorDomain' info='Error in the S-Expression code'/>
708
    <enum name='VIR_FROM_STATS_LINUX' file='virterror' value='16' type='virErrorDomain' info='Error in the Linux Stats code'/>
709
    <enum name='VIR_FROM_STORAGE' file='virterror' value='18' type='virErrorDomain' info='Error from storage driver'/>
710
    <enum name='VIR_FROM_TEST' file='virterror' value='12' type='virErrorDomain' info='Error from test driver'/>
D
Daniel P. Berrange 已提交
711
    <enum name='VIR_FROM_UML' file='virterror' value='21' type='virErrorDomain' info='Error at the UML driver'/>
712
    <enum name='VIR_FROM_VBOX' file='virterror' value='25' type='virErrorDomain' info='Error from VirtualBox driver'/>
713 714 715
    <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 已提交
716
    <enum name='VIR_FROM_XENXM' file='virterror' value='15' type='virErrorDomain' info='Error at Xen XM layer'/>
717
    <enum name='VIR_FROM_XEN_INOTIFY' file='virterror' value='23' type='virErrorDomain' info='Error from xen inotify layer'/>
718
    <enum name='VIR_FROM_XML' file='virterror' value='5' type='virErrorDomain' info='Error in the XML code'/>
D
Daniel Veillard 已提交
719 720
    <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'/>
721
    <enum name='VIR_MIGRATE_LIVE' file='libvirt' value='1' type='virDomainMigrateFlags' info=' live migration'/>
D
Daniel P. Berrange 已提交
722 723
    <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...'/>
724 725 726 727 728 729 730 731 732 733 734 735 736
    <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'/>
737 738 739 740 741
    <enum name='VIR_STREAM_EVENT_ERROR' file='libvirt' value='4' type='virStreamEventType'/>
    <enum name='VIR_STREAM_EVENT_HANGUP' file='libvirt' value='8' type='virStreamEventType'/>
    <enum name='VIR_STREAM_EVENT_READABLE' file='libvirt' value='1' type='virStreamEventType'/>
    <enum name='VIR_STREAM_EVENT_WRITABLE' file='libvirt' value='2' type='virStreamEventType'/>
    <enum name='VIR_STREAM_NONBLOCK' file='libvirt' value='1' type='virStreamFlags'/>
742 743 744
    <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'/>
745
    <enum name='VIR_WAR_NO_INTERFACE' file='virterror' value='56' type='virErrorNumber' info='failed to start interface driver'/>
746
    <enum name='VIR_WAR_NO_NETWORK' file='virterror' value='41' type='virErrorNumber' info='failed to start network'/>
D
Daniel P. Berrange 已提交
747
    <enum name='VIR_WAR_NO_NODE' file='virterror' value='51' type='virErrorNumber' info='failed to start node driver'/>
748
    <enum name='VIR_WAR_NO_SECRET' file='virterror' value='60' type='virErrorNumber' info='failed to start secret storage'/>
749
    <enum name='VIR_WAR_NO_STORAGE' file='virterror' value='48' type='virErrorNumber' info='failed to start storage'/>
750
    <struct name='virConnect' file='libvirt' type='struct _virConnect'/>
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
    <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'/>
769
    <typedef name='virConnectPtr' file='libvirt' type='virConnect *'>
770
      <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>
771 772
    </typedef>
    <struct name='virDomain' file='libvirt' type='struct _virDomain'/>
773
    <typedef name='virDomainBlockStatsPtr' file='libvirt' type='virDomainBlockStatsStruct *'>
774
      <info><![CDATA[A pointer to a virDomainBlockStats structure]]></info>
775 776
    </typedef>
    <struct name='virDomainBlockStatsStruct' file='libvirt' type='struct _virDomainBlockStats'>
777 778 779
      <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'/>
780
      <field name='wr_bytes' type='long long' info=' number of written bytes'/>
781 782
      <field name='errs' type='long long' info=' In Xen this returns the mysterious &apos;oo_req&apos;.'/>
    </struct>
783
    <typedef name='virDomainCreateFlags' file='libvirt' type='enum'/>
784 785 786 787 788
    <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'/>
789
    <typedef name='virDomainEventType' file='libvirt' type='enum'/>
790
    <typedef name='virDomainEventUndefinedDetailType' file='libvirt' type='enum'/>
791
    <struct name='virDomainInfo' file='libvirt' type='struct _virDomainInfo'>
792
      <field name='state' type='unsigned char' info=' the running state, one of virDomainState'/>
793 794 795 796 797 798
      <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 *'>
799
      <info><![CDATA[a virDomainInfoPtr is a pointer to a virDomainInfo structure.]]></info>
800
    </typedef>
801
    <typedef name='virDomainInterfaceStatsPtr' file='libvirt' type='virDomainInterfaceStatsStruct *'>
802
      <info><![CDATA[A pointer to a virDomainInterfaceStats structure]]></info>
803 804 805 806 807 808 809 810 811 812 813
    </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>
814
    <typedef name='virDomainMemoryFlags' file='libvirt' type='enum'/>
815
    <typedef name='virDomainMigrateFlags' file='libvirt' type='enum'/>
816
    <typedef name='virDomainPtr' file='libvirt' type='virDomain *'>
817
      <info><![CDATA[a virDomainPtr is pointer to a virDomain private structure, this is the type used to reference a domain in the API.]]></info>
818 819
    </typedef>
    <typedef name='virDomainState' file='libvirt' type='enum'/>
820
    <typedef name='virDomainXMLFlags' file='libvirt' type='enum'/>
821 822 823 824 825
    <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'/>
826 827 828
      <field name='conn' type='virConnectPtr' info=' connection if available, deprecated
see note above'/>
      <field name='dom' type='virDomainPtr' info=' domain if available, deprecated
829
see note above'/>
830 831 832 833 834
      <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'/>
835 836
      <field name='net' type='virNetworkPtr' info=' network if available, deprecated
see note above'/>
837 838 839 840 841
    </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 *'/>
842
    <typedef name='virEventHandleType' file='libvirt' type='enum'/>
843 844
    <struct name='virInterface' file='libvirt' type='struct _virInterface'/>
    <typedef name='virInterfacePtr' file='libvirt' type='virInterface *'>
845
      <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>
846
    </typedef>
847 848
    <struct name='virNetwork' file='libvirt' type='struct _virNetwork'/>
    <typedef name='virNetworkPtr' file='libvirt' type='virNetwork *'>
849
      <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>
850
    </typedef>
D
Daniel P. Berrange 已提交
851 852
    <struct name='virNodeDevice' file='libvirt' type='struct _virNodeDevice'/>
    <typedef name='virNodeDevicePtr' file='libvirt' type='virNodeDevice *'>
853
      <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 已提交
854
    </typedef>
855 856 857 858 859 860 861 862 863 864 865
    <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 *'>
866
      <info><![CDATA[a virNodeInfoPtr is a pointer to a virNodeInfo structure.]]></info>
867
    </typedef>
868 869 870 871 872
    <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 *'>
873
      <info><![CDATA[a virSchedParameterPtr is a pointer to a virSchedParameter structure.]]></info>
874 875
    </typedef>
    <typedef name='virSchedParameterType' file='libvirt' type='enum'/>
876 877
    <struct name='virSecret' file='libvirt' type='struct _virSecret'/>
    <typedef name='virSecretPtr' file='libvirt' type='virSecret *'/>
D
Daniel P. Berrange 已提交
878
    <typedef name='virSecretUsageType' file='libvirt' type='enum'/>
879 880
    <struct name='virSecurityLabel' file='libvirt' type='struct _virSecurityLabel'/>
    <typedef name='virSecurityLabelPtr' file='libvirt' type='virSecurityLabel *'>
881
      <info><![CDATA[a virSecurityLabelPtr is a pointer to a virSecurityLabel.]]></info>
882 883 884
    </typedef>
    <struct name='virSecurityModel' file='libvirt' type='struct _virSecurityModel'/>
    <typedef name='virSecurityModelPtr' file='libvirt' type='virSecurityModel *'>
885
      <info><![CDATA[a virSecurityModelPtr is a pointer to a virSecurityModel.]]></info>
886
    </typedef>
887 888 889 890 891 892 893 894 895 896 897
    <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 *'>
898
      <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>
899 900 901 902 903 904 905 906 907 908 909
    </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 *'>
910
      <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>
911 912
    </typedef>
    <typedef name='virStorageVolType' file='libvirt' type='enum'/>
913 914 915 916 917 918
    <struct name='virStream' file='libvirt' type='struct _virStream'/>
    <typedef name='virStreamEventType' file='libvirt' type='enum'/>
    <typedef name='virStreamFlags' file='libvirt' type='enum'/>
    <typedef name='virStreamPtr' file='libvirt' type='virStream *'>
      <info><![CDATA[a virStreamPtr is pointer to a virStream private structure, this is the type used to reference a data stream in the API.]]></info>
    </typedef>
919 920 921 922 923 924 925 926
    <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'/>
927
    <variable name='virConnectAuthPtrDefault' file='libvirt' type='virConnectAuthPtr'/>
928
    <function name='virConnCopyLastError' file='virterror' module='virterror'>
929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
      <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>
946 947 948 949 950
      <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'>
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965
      <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>
966
      <return type='virErrorPtr' info='a pointer to the last error or NULL if none occurred.'/>
967 968 969
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
    <function name='virConnResetLastError' file='virterror' module='virterror'>
970 971 972 973
      <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>
974 975 976 977
      <return type='void'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
    <function name='virConnSetErrorFunc' file='virterror' module='virterror'>
978 979 980
      <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>
981 982 983 984 985
      <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>
986
    <functype name='virConnectAuthCallbackPtr' file='libvirt' module='libvirt'>
987
      <info><![CDATA[]]></info>
988 989 990 991 992
      <return type='int' info=''/>
      <arg name='cred' type='virConnectCredentialPtr' info=''/>
      <arg name='ncred' type='unsigned int' info=''/>
      <arg name='cbdata' type='void *' info=''/>
    </functype>
993
    <function name='virConnectClose' file='libvirt' module='libvirt'>
994 995 996 997
      <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>
998 999 1000
      <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>
1001
    <functype name='virConnectDomainEventCallback' file='libvirt' module='libvirt'>
1002
      <info><![CDATA[A callback function to be registered, and called when a domain event occurs]]></info>
1003 1004 1005 1006
      <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'/>
1007
      <arg name='detail' type='int' info='event specific detail information'/>
1008 1009 1010
      <arg name='opaque' type='void *' info='opaque user data'/>
    </functype>
    <function name='virConnectDomainEventDeregister' file='libvirt' module='libvirt'>
1011 1012 1013
      <info><![CDATA[Removes a Domain Event Callback.
De-registering for a domain callback will disable
delivery of this event type]]></info>
1014 1015 1016 1017 1018
      <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'>
1019 1020 1021 1022 1023 1024
      <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>
1025
      <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'/>
1026 1027 1028
      <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 已提交
1029
      <arg name='freecb' type='virFreeCallback' info='optional function to deallocate opaque when not used anymore'/>
1030
    </function>
1031
    <function name='virConnectDomainXMLFromNative' file='libvirt' module='libvirt'>
1032 1033 1034
      <info><![CDATA[Reads native configuration data  describing a domain, and
generates libvirt domain XML. The format of the native
data is hypervisor dependant.]]></info>
1035 1036 1037 1038 1039 1040 1041
      <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'>
1042 1043 1044
      <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>
1045 1046 1047 1048 1049 1050
      <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>
1051
    <function name='virConnectFindStoragePoolSources' file='libvirt' module='libvirt'>
1052 1053 1054 1055 1056 1057 1058 1059 1060
      <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>
1061 1062 1063 1064 1065 1066
      <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>
1067
    <function name='virConnectGetCapabilities' file='libvirt' module='libvirt'>
1068
      <info><![CDATA[Provides capabilities of the hypervisor / driver.]]></info>
1069
      <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.'/>
1070 1071
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
1072
    <function name='virConnectGetHostname' file='libvirt' module='libvirt'>
1073 1074 1075 1076
      <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>
1077 1078 1079
      <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>
1080
    <function name='virConnectGetMaxVcpus' file='libvirt' module='libvirt'>
1081 1082 1083
      <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>
1084
      <return type='int' info='the maximum of virtual CPU or -1 in case of error.'/>
1085 1086 1087
      <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>
1088
    <function name='virConnectGetType' file='libvirt' module='libvirt'>
1089
      <info><![CDATA[Get the name of the Hypervisor software used.]]></info>
1090
      <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'/>
1091 1092
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
1093
    <function name='virConnectGetURI' file='libvirt' module='libvirt'>
1094 1095 1096 1097 1098 1099 1100
      <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>
1101 1102 1103
      <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>
1104
    <function name='virConnectGetVersion' file='libvirt' module='libvirt'>
1105 1106 1107
      <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>
1108 1109 1110 1111 1112
      <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'>
1113 1114
      <info><![CDATA[list the defined but inactive domains, stores the pointers to the names
in @names]]></info>
1115 1116
      <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'/>
1117
      <arg name='names' type='char ** const' info='pointer to an array to store the names'/>
1118 1119
      <arg name='maxnames' type='int' info='size of the array'/>
    </function>
D
Daniel Veillard 已提交
1120
    <function name='virConnectListDefinedInterfaces' file='libvirt' module='libvirt'>
1121 1122
      <info><![CDATA[Collect the list of defined (inactive) physical host interfaces,
and store their names in @names.]]></info>
D
Daniel Veillard 已提交
1123 1124 1125 1126 1127
      <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>
1128
    <function name='virConnectListDefinedNetworks' file='libvirt' module='libvirt'>
1129
      <info><![CDATA[list the inactive networks, stores the pointers to the names in @names]]></info>
1130 1131
      <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'/>
1132
      <arg name='names' type='char ** const' info='pointer to an array to store the names'/>
1133 1134
      <arg name='maxnames' type='int' info='size of the array'/>
    </function>
1135
    <function name='virConnectListDefinedStoragePools' file='libvirt' module='libvirt'>
1136 1137 1138
      <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>
1139 1140 1141 1142 1143
      <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>
1144
    <function name='virConnectListDomains' file='libvirt' module='libvirt'>
1145
      <info><![CDATA[Collect the list of active domains, and store their ID in @maxids]]></info>
1146 1147 1148 1149 1150
      <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>
1151
    <function name='virConnectListInterfaces' file='libvirt' module='libvirt'>
1152 1153
      <info><![CDATA[Collect the list of active physical host interfaces,
and store their names in @names]]></info>
1154 1155 1156 1157 1158
      <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>
1159
    <function name='virConnectListNetworks' file='libvirt' module='libvirt'>
1160
      <info><![CDATA[Collect the list of active networks, and store their names in @names]]></info>
1161 1162
      <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'/>
1163
      <arg name='names' type='char ** const' info='array to collect the list of names of active networks'/>
1164 1165
      <arg name='maxnames' type='int' info='size of @names'/>
    </function>
1166
    <function name='virConnectListSecrets' file='libvirt' module='libvirt'>
1167
      <info><![CDATA[List UUIDs of defined secrets, store pointers to names in uuids.]]></info>
1168 1169 1170 1171 1172
      <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>
1173
    <function name='virConnectListStoragePools' file='libvirt' module='libvirt'>
1174 1175 1176
      <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>
1177 1178 1179 1180 1181
      <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>
1182
    <function name='virConnectNumOfDefinedDomains' file='libvirt' module='libvirt'>
1183
      <info><![CDATA[Provides the number of defined but inactive domains.]]></info>
1184 1185 1186
      <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 已提交
1187
    <function name='virConnectNumOfDefinedInterfaces' file='libvirt' module='libvirt'>
1188
      <info><![CDATA[Provides the number of defined (inactive) interfaces on the physical host.]]></info>
D
Daniel Veillard 已提交
1189 1190 1191
      <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>
1192
    <function name='virConnectNumOfDefinedNetworks' file='libvirt' module='libvirt'>
1193
      <info><![CDATA[Provides the number of inactive networks.]]></info>
1194 1195 1196
      <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>
1197
    <function name='virConnectNumOfDefinedStoragePools' file='libvirt' module='libvirt'>
1198
      <info><![CDATA[Provides the number of inactive storage pools]]></info>
1199 1200 1201
      <return type='int' info='the number of pools found, or -1 on error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
    </function>
1202
    <function name='virConnectNumOfDomains' file='libvirt' module='libvirt'>
1203
      <info><![CDATA[Provides the number of active domains.]]></info>
1204 1205 1206
      <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>
1207
    <function name='virConnectNumOfInterfaces' file='libvirt' module='libvirt'>
1208
      <info><![CDATA[Provides the number of active interfaces on the physical host.]]></info>
D
Daniel Veillard 已提交
1209
      <return type='int' info='the number of active interfaces found or -1 in case of error'/>
1210 1211
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
1212
    <function name='virConnectNumOfNetworks' file='libvirt' module='libvirt'>
1213
      <info><![CDATA[Provides the number of active networks.]]></info>
1214 1215 1216
      <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>
1217
    <function name='virConnectNumOfSecrets' file='libvirt' module='libvirt'>
1218
      <info><![CDATA[Fetch number of currently defined secrets.]]></info>
1219 1220 1221
      <return type='int' info='the number currently defined secrets.'/>
      <arg name='conn' type='virConnectPtr' info='virConnect connection'/>
    </function>
1222
    <function name='virConnectNumOfStoragePools' file='libvirt' module='libvirt'>
1223
      <info><![CDATA[Provides the number of active storage pools]]></info>
1224 1225 1226
      <return type='int' info='the number of pools found, or -1 on error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
    </function>
1227
    <function name='virConnectOpen' file='libvirt' module='libvirt'>
1228 1229
      <info><![CDATA[This function should be called first to get a connection to the
Hypervisor and xen store]]></info>
D
Daniel Veillard 已提交
1230
      <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'/>
1231
      <arg name='name' type='const char *' info='URI of the hypervisor'/>
1232
    </function>
1233
    <function name='virConnectOpenAuth' file='libvirt' module='libvirt'>
1234 1235 1236 1237 1238 1239
      <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>
1240 1241 1242 1243 1244
      <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>
1245
    <function name='virConnectOpenReadOnly' file='libvirt' module='libvirt'>
1246 1247 1248 1249 1250 1251
      <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>
1252 1253
      <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'/>
1254
    </function>
1255
    <function name='virConnectRef' file='libvirt' module='libvirt'>
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
      <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 已提交
1266
      <return type='int' info='0 in case of success, -1 in case of failure'/>
1267 1268
      <arg name='conn' type='virConnectPtr' info='the connection to hold a reference on'/>
    </function>
1269
    <function name='virCopyLastError' file='virterror' module='virterror'>
1270 1271 1272 1273 1274 1275
      <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>
1276 1277 1278 1279
      <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'>
1280
      <info><![CDATA[Default routine reporting an error to stderr.]]></info>
1281 1282 1283
      <return type='void'/>
      <arg name='err' type='virErrorPtr' info='pointer to the error.'/>
    </function>
D
Daniel Veillard 已提交
1284
    <function name='virDomainAttachDevice' file='libvirt' module='libvirt'>
1285
      <info><![CDATA[Create a virtual device attachment to backend.]]></info>
D
Daniel Veillard 已提交
1286 1287
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
1288
      <arg name='xml' type='const char *' info='pointer to XML description of one device'/>
D
Daniel Veillard 已提交
1289
    </function>
1290
    <function name='virDomainBlockPeek' file='libvirt' module='libvirt'>
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
      <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>
1318 1319 1320 1321 1322 1323 1324 1325
      <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>
1326
    <function name='virDomainBlockStats' file='libvirt' module='libvirt'>
1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339
      <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>
1340 1341 1342 1343 1344 1345
      <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 已提交
1346
    <function name='virDomainCoreDump' file='libvirt' module='libvirt'>
1347 1348 1349
      <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 已提交
1350 1351 1352 1353 1354
      <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>
1355
    <function name='virDomainCreate' file='libvirt' module='libvirt'>
1356 1357
      <info><![CDATA[launch a defined domain. If the call succeed the domain moves from the
defined to the running domains pools.]]></info>
1358 1359 1360 1361
      <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'>
1362 1363 1364
      <info><![CDATA[Deprecated after 0.4.6.
Renamed to virDomainCreateXML() providing identical functionality.
This existing name will left indefinitely for API compatability.]]></info>
1365 1366 1367 1368 1369 1370
      <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'>
1371 1372 1373 1374 1375 1376
      <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>
1377 1378
      <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 已提交
1379
      <arg name='xmlDesc' type='const char *' info='string containing an XML description of the domain'/>
1380
      <arg name='flags' type='unsigned int' info='callers should always pass 0'/>
1381 1382
    </function>
    <function name='virDomainDefineXML' file='libvirt' module='libvirt'>
1383 1384 1385 1386
      <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>
1387 1388 1389 1390 1391
      <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'>
1392 1393 1394 1395
      <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>
1396 1397 1398
      <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 已提交
1399
    <function name='virDomainDetachDevice' file='libvirt' module='libvirt'>
1400
      <info><![CDATA[Destroy a virtual device attachment to backend.]]></info>
D
Daniel Veillard 已提交
1401 1402
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
1403
      <arg name='xml' type='const char *' info='pointer to XML description of one device'/>
D
Daniel Veillard 已提交
1404
    </function>
1405
    <function name='virDomainFree' file='libvirt' module='libvirt'>
1406 1407
      <info><![CDATA[Free the domain object. The running instance is kept alive.
The data structure is freed and should not be used thereafter.]]></info>
1408 1409 1410
      <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>
1411
    <function name='virDomainGetAutostart' file='libvirt' module='libvirt'>
1412 1413 1414
      <info><![CDATA[Provides a boolean value indicating whether the domain
configured to be automatically started when the host
machine boots.]]></info>
1415
      <return type='int' info='-1 in case of error, 0 in case of success'/>
1416
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
1417
      <arg name='autostart' type='int *' info='the value returned'/>
1418
    </function>
1419
    <function name='virDomainGetConnect' file='libvirt' module='libvirt'>
1420 1421 1422 1423 1424 1425 1426
      <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>
1427
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
1428 1429
      <arg name='dom' type='virDomainPtr' info='pointer to a domain'/>
    </function>
1430
    <function name='virDomainGetID' file='libvirt' module='libvirt'>
1431
      <info><![CDATA[Get the hypervisor ID number for the domain]]></info>
1432 1433 1434 1435
      <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'>
1436 1437 1438
      <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>
1439 1440 1441 1442 1443
      <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'>
1444 1445 1446
      <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>
1447 1448 1449
      <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>
1450
    <function name='virDomainGetMaxVcpus' file='libvirt' module='libvirt'>
1451 1452 1453 1454 1455
      <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>
1456
      <return type='int' info='the maximum of virtual CPU or -1 in case of error.'/>
1457 1458
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
    </function>
1459
    <function name='virDomainGetName' file='libvirt' module='libvirt'>
1460
      <info><![CDATA[Get the public name for that domain]]></info>
1461 1462 1463 1464
      <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'>
1465
      <info><![CDATA[Get the type of domain operation system.]]></info>
1466 1467 1468
      <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>
1469
    <function name='virDomainGetSchedulerParameters' file='libvirt' module='libvirt'>
1470 1471
      <info><![CDATA[Get the scheduler parameters, the @params array will be filled with the
values.]]></info>
1472 1473 1474 1475 1476 1477
      <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'>
1478
      <info><![CDATA[Get the scheduler type.]]></info>
1479 1480 1481 1482
      <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>
1483
    <function name='virDomainGetSecurityLabel' file='libvirt' module='libvirt'>
1484 1485 1486
      <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>
1487
      <return type='int' info='0 in case of success, -1 in case of failure'/>
1488 1489 1490
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='seclabel' type='virSecurityLabelPtr' info='pointer to a virSecurityLabel structure'/>
    </function>
1491
    <function name='virDomainGetUUID' file='libvirt' module='libvirt'>
1492
      <info><![CDATA[Get the UUID for a domain]]></info>
1493 1494
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
1495
      <arg name='uuid' type='unsigned char *' info='pointer to a VIR_UUID_BUFLEN bytes array'/>
1496 1497
    </function>
    <function name='virDomainGetUUIDString' file='libvirt' module='libvirt'>
1498 1499
      <info><![CDATA[Get the UUID for a domain as string. For more information about
UUID see RFC4122.]]></info>
1500 1501
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
1502
      <arg name='buf' type='char *' info='pointer to a VIR_UUID_STRING_BUFLEN bytes array'/>
1503
    </function>
1504
    <function name='virDomainGetVcpus' file='libvirt' module='libvirt'>
1505 1506
      <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>
1507 1508 1509 1510
      <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 已提交
1511
      <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.'/>
1512 1513
      <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>
1514
    <function name='virDomainGetXMLDesc' file='libvirt' module='libvirt'>
1515 1516
      <info><![CDATA[Provide an XML description of the domain. The description may be reused
later to relaunch the domain with virDomainCreateXML().]]></info>
1517 1518
      <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'/>
1519
      <arg name='flags' type='int' info='an OR&apos;ed set of virDomainXMLFlags'/>
1520
    </function>
1521
    <function name='virDomainInterfaceStats' file='libvirt' module='libvirt'>
1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532
      <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>
1533 1534 1535 1536 1537 1538
      <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>
1539
    <function name='virDomainLookupByID' file='libvirt' module='libvirt'>
1540 1541 1542
      <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>
1543
      <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.'/>
1544 1545 1546 1547
      <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'>
1548
      <info><![CDATA[Try to lookup a domain on the given hypervisor based on its name.]]></info>
1549
      <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.'/>
1550 1551 1552 1553
      <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'>
1554
      <info><![CDATA[Try to lookup a domain on the given hypervisor based on its UUID.]]></info>
1555
      <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.'/>
1556 1557 1558 1559
      <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'>
1560
      <info><![CDATA[Try to lookup a domain on the given hypervisor based on its UUID.]]></info>
1561
      <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.'/>
1562 1563 1564
      <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>
1565
    <function name='virDomainMemoryPeek' file='libvirt' module='libvirt'>
1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585
      <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>
1586 1587 1588 1589 1590 1591 1592
      <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>
1593
    <function name='virDomainMigrate' file='libvirt' module='libvirt'>
1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627
      <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>
1628 1629 1630 1631 1632 1633 1634 1635
      <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>
1636
    <function name='virDomainPinVcpu' file='libvirt' module='libvirt'>
1637 1638
      <info><![CDATA[Dynamically change the real CPUs which can be allocated to a virtual CPU.
This function requires privileged access to the hypervisor.]]></info>
1639 1640 1641 1642 1643 1644
      <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>
1645
    <function name='virDomainReboot' file='libvirt' module='libvirt'>
1646 1647 1648
      <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>
1649 1650 1651 1652
      <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>
1653
    <function name='virDomainRef' file='libvirt' module='libvirt'>
1654 1655 1656 1657 1658 1659 1660 1661 1662 1663
      <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 已提交
1664 1665
      <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'/>
1666
    </function>
1667
    <function name='virDomainRestore' file='libvirt' module='libvirt'>
1668
      <info><![CDATA[This method will restore a domain saved to disk by virDomainSave().]]></info>
1669 1670 1671 1672 1673
      <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'>
1674 1675 1676
      <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>
1677 1678 1679 1680
      <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'>
1681 1682 1683 1684
      <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>
1685 1686 1687 1688
      <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>
1689
    <function name='virDomainSetAutostart' file='libvirt' module='libvirt'>
1690 1691
      <info><![CDATA[Configure the domain to be automatically started
when the host machine boots.]]></info>
1692 1693
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
1694
      <arg name='autostart' type='int' info='whether the domain should be automatically started 0 or 1'/>
1695
    </function>
1696
    <function name='virDomainSetMaxMemory' file='libvirt' module='libvirt'>
1697 1698 1699 1700
      <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>
1701 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 or NULL'/>
      <arg name='memory' type='unsigned long' info='the memory size in kilobytes'/>
    </function>
    <function name='virDomainSetMemory' file='libvirt' module='libvirt'>
1706 1707 1708 1709
      <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>
1710 1711 1712 1713
      <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>
1714
    <function name='virDomainSetSchedulerParameters' file='libvirt' module='libvirt'>
1715
      <info><![CDATA[Change the scheduler parameters]]></info>
1716 1717 1718 1719 1720
      <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>
1721
    <function name='virDomainSetVcpus' file='libvirt' module='libvirt'>
1722 1723 1724 1725
      <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>
1726 1727 1728 1729
      <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>
1730
    <function name='virDomainShutdown' file='libvirt' module='libvirt'>
1731 1732 1733 1734 1735 1736
      <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>
1737 1738 1739 1740
      <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'>
1741 1742 1743 1744 1745
      <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>
1746 1747 1748 1749
      <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'>
1750
      <info><![CDATA[Undefine a domain but does not stop it if it is running]]></info>
1751 1752 1753 1754
      <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'>
1755
      <info><![CDATA[Signature of a function to use when there is an error raised by the library.]]></info>
1756 1757 1758 1759
      <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>
1760
    <functype name='virEventAddHandleFunc' file='libvirt' module='libvirt'>
1761 1762 1763 1764 1765 1766 1767
      <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 已提交
1768
      <return type='int' info='a handle watch number to be used for updating and unregistering for events'/>
1769 1770
      <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 已提交
1771
      <arg name='cb' type='virEventHandleCallback' info='the callback to be called when an event occurrs'/>
1772
      <arg name='opaque' type='void *' info='user data to pass to the callback'/>
D
Daniel P. Berrange 已提交
1773
      <arg name='ff' type='virFreeCallback' info='the callback invoked to free opaque data blob'/>
1774 1775
    </functype>
    <functype name='virEventAddTimeoutFunc' file='libvirt' module='libvirt'>
1776 1777 1778 1779 1780 1781
      <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>
1782 1783 1784 1785
      <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 已提交
1786
      <arg name='ff' type='virFreeCallback' info='the callback invoked to free opaque data blob'/>
1787 1788
    </functype>
    <functype name='virEventHandleCallback' file='libvirt' module='libvirt'>
1789 1790
      <info><![CDATA[Callback for receiving file handle events. The callback will
be invoked once for each event which is pending.]]></info>
1791
      <return type='void'/>
D
Daniel P. Berrange 已提交
1792
      <arg name='watch' type='int' info='watch on which the event occurred'/>
1793 1794 1795 1796 1797
      <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'>
1798
      <info><![CDATA[]]></info>
1799 1800 1801 1802 1803 1804 1805 1806 1807
      <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'>
1808 1809 1810 1811 1812 1813
      <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>
1814
      <return type='int' info=''/>
D
Daniel P. Berrange 已提交
1815
      <arg name='watch' type='int' info='file descriptor watch to stop listening on'/>
1816 1817
    </functype>
    <functype name='virEventRemoveTimeoutFunc' file='libvirt' module='libvirt'>
1818 1819 1820 1821 1822
      <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>
1823 1824 1825 1826
      <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'>
1827
      <info><![CDATA[callback for receiving timer events]]></info>
1828 1829 1830 1831 1832
      <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'>
1833 1834
      <info><![CDATA[Part of the EventImpl, this user-provided callback is notified when
events to listen on change]]></info>
1835
      <return type='void'/>
D
Daniel P. Berrange 已提交
1836
      <arg name='watch' type='int' info='file descriptor watch to modify'/>
1837 1838 1839
      <arg name='event' type='int' info='new events to listen on'/>
    </functype>
    <functype name='virEventUpdateTimeoutFunc' file='libvirt' module='libvirt'>
1840 1841
      <info><![CDATA[Part of the EventImpl, this user-defined callback updates an
event timeout.]]></info>
1842 1843 1844 1845
      <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 已提交
1846
    <functype name='virFreeCallback' file='libvirt' module='libvirt'>
1847
      <info><![CDATA[]]></info>
D
Daniel P. Berrange 已提交
1848 1849 1850
      <return type='void'/>
      <arg name='opaque' type='void *' info=''/>
    </functype>
1851
    <function name='virFreeError' file='virterror' module='virterror'>
1852
      <info><![CDATA[Resets and frees the given error.]]></info>
1853 1854 1855
      <return type='void'/>
      <arg name='err' type='virErrorPtr' info='error to free'/>
    </function>
1856
    <function name='virGetLastError' file='virterror' module='virterror'>
1857 1858 1859 1860
      <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>
1861
      <return type='virErrorPtr' info='a pointer to the last error or NULL if none occurred.'/>
1862 1863
    </function>
    <function name='virGetVersion' file='libvirt' module='libvirt'>
1864 1865 1866 1867 1868
      <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>
1869 1870 1871 1872 1873 1874
      <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'>
1875 1876 1877
      <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>
1878 1879
      <return type='int' info='0 in case of success, -1 in case of error'/>
    </function>
1880
    <function name='virInterfaceCreate' file='libvirt' module='libvirt'>
1881
      <info><![CDATA[Activate an interface (ie call "ifup")]]></info>
1882
      <return type='int' info='0 in case of success, -1 in case of error'/>
1883
      <arg name='iface' type='virInterfacePtr' info='pointer to a defined interface'/>
1884 1885 1886
      <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'>
1887
      <info><![CDATA[Define an interface (or modify existing interface configuration)]]></info>
1888 1889 1890 1891 1892 1893
      <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'>
1894 1895 1896
      <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>
1897
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
1898
      <arg name='iface' type='virInterfacePtr' info='an interface object'/>
1899 1900 1901
      <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'>
1902 1903
      <info><![CDATA[Free the interface object. The interface itself is unaltered.
The data structure is freed and should not be used thereafter.]]></info>
1904
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
D
Daniel P. Berrange 已提交
1905
      <arg name='iface' type='virInterfacePtr' info='an interface object'/>
1906 1907
    </function>
    <function name='virInterfaceGetConnect' file='libvirt' module='libvirt'>
1908 1909 1910 1911 1912 1913 1914
      <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>
1915
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
D
Daniel P. Berrange 已提交
1916
      <arg name='iface' type='virInterfacePtr' info='pointer to an interface'/>
1917 1918
    </function>
    <function name='virInterfaceGetMACString' file='libvirt' module='libvirt'>
1919 1920
      <info><![CDATA[Get the MAC for an interface as string. For more information about
MAC see RFC4122.]]></info>
1921
      <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 已提交
1922
      <arg name='iface' type='virInterfacePtr' info='an interface object'/>
1923 1924
    </function>
    <function name='virInterfaceGetName' file='libvirt' module='libvirt'>
1925
      <info><![CDATA[Get the public name for that interface]]></info>
1926
      <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 已提交
1927
      <arg name='iface' type='virInterfacePtr' info='an interface object'/>
1928 1929
    </function>
    <function name='virInterfaceGetXMLDesc' file='libvirt' module='libvirt'>
1930 1931
      <info><![CDATA[Provide an XML description of the interface. The description may be reused
later to redefine the interface with virInterfaceDefineXML().]]></info>
1932
      <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 已提交
1933 1934
      <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'/>
1935 1936
    </function>
    <function name='virInterfaceLookupByMACString' file='libvirt' module='libvirt'>
1937
      <info><![CDATA[Try to lookup an interface on the given hypervisor based on its MAC.]]></info>
1938 1939 1940 1941 1942
      <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'>
1943
      <info><![CDATA[Try to lookup an interface on the given hypervisor based on its name.]]></info>
1944 1945 1946 1947 1948
      <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'>
1949 1950 1951 1952 1953 1954 1955 1956 1957 1958
      <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>
1959
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
1960
      <arg name='iface' type='virInterfacePtr' info='the interface to hold a reference on'/>
1961 1962
    </function>
    <function name='virInterfaceUndefine' file='libvirt' module='libvirt'>
1963 1964
      <info><![CDATA[Undefine an interface, ie remove it from the config.
This does not free the associated virInterfacePtr object.]]></info>
1965
      <return type='int' info='0 in case of success, -1 in case of error'/>
1966
      <arg name='iface' type='virInterfacePtr' info='pointer to a defined interface'/>
1967
    </function>
1968
    <function name='virNetworkCreate' file='libvirt' module='libvirt'>
1969 1970
      <info><![CDATA[Create and start a defined network. If the call succeed the network
moves from the defined to the running networks pools.]]></info>
1971 1972 1973 1974
      <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'>
1975 1976
      <info><![CDATA[Create and start a new virtual network, based on an XML description
similar to the one returned by virNetworkGetXMLDesc()]]></info>
1977 1978 1979 1980 1981
      <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'>
1982
      <info><![CDATA[Define a network, but does not create it]]></info>
1983 1984 1985 1986 1987
      <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'>
1988 1989 1990 1991
      <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>
1992 1993 1994 1995
      <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'>
1996 1997
      <info><![CDATA[Free the network object. The running instance is kept alive.
The data structure is freed and should not be used thereafter.]]></info>
1998 1999 2000
      <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>
2001
    <function name='virNetworkGetAutostart' file='libvirt' module='libvirt'>
2002 2003 2004
      <info><![CDATA[Provides a boolean value indicating whether the network
configured to be automatically started when the host
machine boots.]]></info>
2005
      <return type='int' info='-1 in case of error, 0 in case of success'/>
2006
      <arg name='network' type='virNetworkPtr' info='a network object'/>
2007
      <arg name='autostart' type='int *' info='the value returned'/>
2008
    </function>
2009
    <function name='virNetworkGetBridgeName' file='libvirt' module='libvirt'>
2010 2011
      <info><![CDATA[Provides a bridge interface name to which a domain may connect
a network interface in order to join the network.]]></info>
2012
      <return type='char *' info='a 0 terminated interface name, or NULL in case of error. the caller must free() the returned value.'/>
2013 2014
      <arg name='network' type='virNetworkPtr' info='a network object'/>
    </function>
2015
    <function name='virNetworkGetConnect' file='libvirt' module='libvirt'>
2016 2017 2018 2019 2020 2021 2022
      <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>
2023
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
2024 2025
      <arg name='net' type='virNetworkPtr' info='pointer to a network'/>
    </function>
2026
    <function name='virNetworkGetName' file='libvirt' module='libvirt'>
2027
      <info><![CDATA[Get the public name for that network]]></info>
2028 2029 2030 2031
      <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'>
2032
      <info><![CDATA[Get the UUID for a network]]></info>
2033 2034 2035 2036 2037
      <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'>
2038 2039
      <info><![CDATA[Get the UUID for a network as string. For more information about
UUID see RFC4122.]]></info>
2040 2041 2042 2043 2044
      <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'>
2045 2046
      <info><![CDATA[Provide an XML description of the network. The description may be reused
later to relaunch the network with virNetworkCreateXML().]]></info>
2047 2048
      <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 已提交
2049
      <arg name='flags' type='int' info='an OR&apos;ed set of extraction flags, not used yet'/>
2050 2051
    </function>
    <function name='virNetworkLookupByName' file='libvirt' module='libvirt'>
2052
      <info><![CDATA[Try to lookup a network on the given hypervisor based on its name.]]></info>
2053
      <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.'/>
2054 2055 2056 2057
      <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'>
2058
      <info><![CDATA[Try to lookup a network on the given hypervisor based on its UUID.]]></info>
2059
      <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.'/>
2060 2061 2062 2063
      <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'>
2064
      <info><![CDATA[Try to lookup a network on the given hypervisor based on its UUID.]]></info>
2065
      <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.'/>
2066 2067 2068
      <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>
2069
    <function name='virNetworkRef' file='libvirt' module='libvirt'>
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079
      <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 已提交
2080 2081
      <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'/>
2082
    </function>
2083
    <function name='virNetworkSetAutostart' file='libvirt' module='libvirt'>
2084 2085
      <info><![CDATA[Configure the network to be automatically started
when the host machine boots.]]></info>
2086 2087
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='network' type='virNetworkPtr' info='a network object'/>
2088
      <arg name='autostart' type='int' info='whether the network should be automatically started 0 or 1'/>
2089
    </function>
2090
    <function name='virNetworkUndefine' file='libvirt' module='libvirt'>
2091
      <info><![CDATA[Undefine a network but does not stop it if it is running]]></info>
2092 2093 2094
      <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 已提交
2095
    <function name='virNodeDeviceCreateXML' file='libvirt' module='libvirt'>
2096 2097
      <info><![CDATA[Create a new device on the VM host machine, for example, virtual
HBAs created using vport_create.]]></info>
D
Daniel Veillard 已提交
2098 2099 2100 2101 2102 2103
      <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'>
2104 2105
      <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 已提交
2106 2107 2108
      <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>
2109
    <function name='virNodeDeviceDettach' file='libvirt' module='libvirt'>
2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121
      <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 已提交
2122 2123
      <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'/>
2124
    </function>
D
Daniel P. Berrange 已提交
2125
    <function name='virNodeDeviceFree' file='libvirt' module='libvirt'>
2126 2127
      <info><![CDATA[Drops a reference to the node device, freeing it if
this was the last reference.]]></info>
D
Daniel P. Berrange 已提交
2128 2129 2130 2131
      <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'>
2132
      <info><![CDATA[Just return the device name]]></info>
D
Daniel Veillard 已提交
2133
      <return type='const char *' info='the device name or NULL in case of error'/>
D
Daniel P. Berrange 已提交
2134 2135 2136
      <arg name='dev' type='virNodeDevicePtr' info='the device'/>
    </function>
    <function name='virNodeDeviceGetParent' file='libvirt' module='libvirt'>
2137
      <info><![CDATA[Accessor for the parent of the device]]></info>
D
Daniel P. Berrange 已提交
2138 2139 2140 2141
      <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'>
2142 2143
      <info><![CDATA[Fetch an XML document describing all aspects of
the device.]]></info>
D
Daniel P. Berrange 已提交
2144 2145 2146 2147 2148
      <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'>
2149
      <info><![CDATA[Lists the names of the capabilities supported by the device.]]></info>
D
Daniel P. Berrange 已提交
2150 2151 2152 2153 2154 2155
      <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'>
2156
      <info><![CDATA[Lookup a node device by its name.]]></info>
D
Daniel P. Berrange 已提交
2157 2158 2159 2160 2161
      <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'>
2162
      <info><![CDATA[Accessor for the number of capabilities supported by the device.]]></info>
D
Daniel P. Berrange 已提交
2163 2164 2165
      <return type='int' info='the number of capabilities supported by the device.'/>
      <arg name='dev' type='virNodeDevicePtr' info='the device'/>
    </function>
2166
    <function name='virNodeDeviceReAttach' file='libvirt' module='libvirt'>
2167 2168 2169 2170 2171 2172 2173 2174
      <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 已提交
2175
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
2176 2177
      <arg name='dev' type='virNodeDevicePtr' info='pointer to the node device'/>
    </function>
2178
    <function name='virNodeDeviceRef' file='libvirt' module='libvirt'>
2179 2180 2181 2182 2183 2184 2185 2186 2187 2188
      <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 已提交
2189 2190
      <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'/>
2191
    </function>
2192
    <function name='virNodeDeviceReset' file='libvirt' module='libvirt'>
2193 2194 2195 2196 2197 2198 2199 2200 2201 2202
      <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 已提交
2203
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
2204 2205
      <arg name='dev' type='virNodeDevicePtr' info='pointer to the node device'/>
    </function>
2206
    <function name='virNodeGetCellsFreeMemory' file='libvirt' module='libvirt'>
2207 2208 2209 2210 2211 2212
      <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>
2213 2214 2215 2216 2217 2218
      <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>
2219
    <function name='virNodeGetFreeMemory' file='libvirt' module='libvirt'>
2220 2221 2222
      <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>
2223
      <return type='unsigned long long' info='the available free memory in bytes or 0 in case of error'/>
2224 2225
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
2226
    <function name='virNodeGetInfo' file='libvirt' module='libvirt'>
2227
      <info><![CDATA[Extract hardware information about the node.]]></info>
2228 2229 2230 2231
      <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>
2232
    <function name='virNodeGetSecurityModel' file='libvirt' module='libvirt'>
2233 2234 2235
      <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>
2236
      <return type='int' info='0 in case of success, -1 in case of failure'/>
2237 2238 2239
      <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 已提交
2240
    <function name='virNodeListDevices' file='libvirt' module='libvirt'>
2241 2242 2243 2244
      <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 已提交
2245 2246 2247 2248 2249 2250 2251 2252
      <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'>
2253 2254 2255 2256
      <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 已提交
2257 2258 2259 2260 2261
      <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>
2262
    <function name='virResetError' file='virterror' module='virterror'>
2263
      <info><![CDATA[Reset the error being pointed to]]></info>
2264 2265 2266 2267
      <return type='void'/>
      <arg name='err' type='virErrorPtr' info='pointer to the virError to clean up'/>
    </function>
    <function name='virResetLastError' file='virterror' module='virterror'>
2268 2269 2270 2271 2272
      <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>
2273 2274
      <return type='void'/>
    </function>
2275
    <function name='virSaveLastError' file='virterror' module='virterror'>
2276
      <info><![CDATA[Save the last error into a new error object.]]></info>
2277 2278
      <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>
2279
    <function name='virSecretDefineXML' file='libvirt' module='libvirt'>
2280 2281 2282 2283 2284 2285
      <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>
2286 2287 2288 2289 2290 2291
      <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'>
2292
      <info><![CDATA[Release the secret handle. The underlying secret continues to exist.]]></info>
2293 2294 2295 2296
      <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'>
2297 2298 2299 2300 2301
      <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>
2302 2303 2304
      <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 已提交
2305
    <function name='virSecretGetUUID' file='libvirt' module='libvirt'>
2306
      <info><![CDATA[Fetches the UUID of the secret.]]></info>
D
Daniel P. Berrange 已提交
2307
      <return type='int' info='0 on success with the uuid buffer being filled, or -1 upon failure.'/>
2308
      <arg name='secret' type='virSecretPtr' info='A virSecret secret'/>
D
Daniel P. Berrange 已提交
2309 2310 2311
      <arg name='uuid' type='unsigned char *' info='buffer of VIR_UUID_BUFLEN bytes in size'/>
    </function>
    <function name='virSecretGetUUIDString' file='libvirt' module='libvirt'>
2312 2313
      <info><![CDATA[Get the UUID for a secret as string. For more information about
UUID see RFC4122.]]></info>
D
Daniel P. Berrange 已提交
2314 2315 2316 2317 2318
      <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'>
2319 2320 2321 2322 2323 2324 2325 2326
      <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 已提交
2327 2328 2329 2330
      <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'>
2331 2332 2333 2334 2335
      <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 已提交
2336 2337
      <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'/>
2338 2339
    </function>
    <function name='virSecretGetValue' file='libvirt' module='libvirt'>
2340
      <info><![CDATA[Fetches the value of a secret.]]></info>
2341 2342 2343 2344 2345 2346
      <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'>
2347
      <info><![CDATA[Fetches an XML document describing attributes of the secret.]]></info>
2348 2349 2350 2351
      <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 已提交
2352
    <function name='virSecretLookupByUUID' file='libvirt' module='libvirt'>
2353 2354
      <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 已提交
2355 2356 2357 2358
      <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>
2359
    <function name='virSecretLookupByUUIDString' file='libvirt' module='libvirt'>
2360 2361
      <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 已提交
2362 2363 2364 2365 2366
      <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'>
2367 2368 2369
      <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 已提交
2370 2371 2372 2373
      <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'/>
2374 2375
    </function>
    <function name='virSecretRef' file='libvirt' module='libvirt'>
2376 2377 2378 2379 2380 2381 2382 2383 2384
      <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>
2385 2386 2387 2388
      <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'>
2389
      <info><![CDATA[Sets the value of a secret.]]></info>
2390 2391 2392 2393 2394 2395 2396
      <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'>
2397 2398
      <info><![CDATA[Deletes the specified secret.  This does not free the associated
virSecretPtr object.]]></info>
2399 2400 2401
      <return type='int' info='0 on success, -1 on failure.'/>
      <arg name='secret' type='virSecretPtr' info='A virSecret secret'/>
    </function>
2402
    <function name='virSetErrorFunc' file='virterror' module='virterror'>
2403 2404 2405
      <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>
2406 2407 2408 2409
      <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>
2410
    <function name='virStoragePoolBuild' file='libvirt' module='libvirt'>
2411
      <info><![CDATA[Build the underlying storage pool]]></info>
2412 2413
      <return type='int' info='0 on success, or -1 upon failure'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
2414
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
2415 2416
    </function>
    <function name='virStoragePoolCreate' file='libvirt' module='libvirt'>
2417
      <info><![CDATA[Starts an inactive storage pool]]></info>
2418 2419
      <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'/>
2420
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
2421 2422
    </function>
    <function name='virStoragePoolCreateXML' file='libvirt' module='libvirt'>
2423 2424 2425
      <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>
2426 2427 2428
      <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'/>
2429
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
2430 2431
    </function>
    <function name='virStoragePoolDefineXML' file='libvirt' module='libvirt'>
2432 2433
      <info><![CDATA[Define a new inactive storage pool based on its XML description. The
pool is persistent, until explicitly undefined.]]></info>
2434 2435 2436
      <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'/>
2437
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
2438 2439
    </function>
    <function name='virStoragePoolDelete' file='libvirt' module='libvirt'>
2440 2441 2442
      <info><![CDATA[Delete the underlying pool resources. This is
a non-recoverable operation. The virStoragePoolPtr object
itself is not free'd.]]></info>
2443 2444 2445 2446 2447
      <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'>
2448 2449 2450 2451 2452
      <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>
2453 2454 2455 2456
      <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'>
2457 2458
      <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>
2459 2460 2461 2462
      <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'>
2463 2464
      <info><![CDATA[Fetches the value of the autostart flag, which determines
whether the pool is automatically started at boot time]]></info>
2465 2466 2467 2468 2469
      <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'>
2470 2471 2472 2473 2474 2475 2476
      <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>
2477
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
2478
      <arg name='pool' type='virStoragePoolPtr' info='pointer to a pool'/>
2479 2480
    </function>
    <function name='virStoragePoolGetInfo' file='libvirt' module='libvirt'>
2481 2482
      <info><![CDATA[Get volatile information about the storage pool
such as free space / usage summary]]></info>
2483 2484 2485 2486 2487
      <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'>
2488
      <info><![CDATA[Fetch the locally unique name of the storage pool]]></info>
2489 2490 2491 2492
      <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'>
2493
      <info><![CDATA[Fetch the globally unique ID of the storage pool]]></info>
2494 2495 2496 2497 2498
      <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'>
2499
      <info><![CDATA[Fetch the globally unique ID of the storage pool as a string]]></info>
2500 2501 2502 2503 2504
      <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'>
2505 2506 2507
      <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>
2508 2509
      <return type='char *' info='a XML document, or NULL on error'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
2510
      <arg name='flags' type='unsigned int' info='flags for XML format options (set of virDomainXMLFlags)'/>
2511 2512
    </function>
    <function name='virStoragePoolListVolumes' file='libvirt' module='libvirt'>
2513 2514
      <info><![CDATA[Fetch list of storage volume names, limiting to
at most maxnames.]]></info>
2515 2516 2517 2518 2519 2520
      <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'>
2521
      <info><![CDATA[Fetch a storage pool based on its unique name]]></info>
2522 2523 2524 2525 2526
      <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'>
2527
      <info><![CDATA[Fetch a storage pool based on its globally unique id]]></info>
2528 2529 2530 2531 2532
      <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'>
2533
      <info><![CDATA[Fetch a storage pool based on its globally unique id]]></info>
2534 2535 2536 2537 2538
      <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'>
2539
      <info><![CDATA[Fetch a storage pool which contains a particular volume]]></info>
2540 2541 2542 2543
      <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'>
2544
      <info><![CDATA[Fetch the number of storage volumes within a pool]]></info>
2545 2546 2547
      <return type='int' info='the number of storage pools, or -1 on failure'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
    </function>
2548
    <function name='virStoragePoolRef' file='libvirt' module='libvirt'>
2549 2550 2551 2552 2553 2554 2555 2556 2557 2558
      <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 已提交
2559 2560
      <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'/>
2561
    </function>
2562
    <function name='virStoragePoolRefresh' file='libvirt' module='libvirt'>
2563 2564 2565
      <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>
2566 2567 2568 2569 2570
      <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'>
2571
      <info><![CDATA[Sets the autostart flag]]></info>
2572 2573 2574 2575 2576
      <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'>
2577
      <info><![CDATA[Undefine an inactive storage pool]]></info>
D
Daniel Veillard 已提交
2578
      <return type='int' info='0 on success, -1 on failure'/>
2579 2580 2581
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
    </function>
    <function name='virStorageVolCreateXML' file='libvirt' module='libvirt'>
2582 2583 2584
      <info><![CDATA[Create a storage volume within a pool based
on an XML description. Not all pools support
creation of volumes]]></info>
2585 2586 2587 2588 2589
      <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>
2590
    <function name='virStorageVolCreateXMLFrom' file='libvirt' module='libvirt'>
2591 2592 2593 2594
      <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>
2595 2596 2597 2598 2599 2600
      <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>
2601
    <function name='virStorageVolDelete' file='libvirt' module='libvirt'>
2602
      <info><![CDATA[Delete the storage volume from the pool]]></info>
2603 2604
      <return type='int' info='0 on success, or -1 on error'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
2605
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
2606 2607
    </function>
    <function name='virStorageVolFree' file='libvirt' module='libvirt'>
2608 2609
      <info><![CDATA[Release the storage volume handle. The underlying
storage volume continues to exist.]]></info>
2610 2611 2612 2613
      <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'>
2614 2615 2616 2617 2618 2619 2620
      <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>
2621
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
2622
      <arg name='vol' type='virStorageVolPtr' info='pointer to a pool'/>
2623 2624
    </function>
    <function name='virStorageVolGetInfo' file='libvirt' module='libvirt'>
2625 2626
      <info><![CDATA[Fetches volatile information about the storage
volume such as its current allocation]]></info>
2627 2628 2629 2630 2631
      <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'>
2632 2633 2634
      <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>
2635 2636 2637 2638
      <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'>
2639 2640
      <info><![CDATA[Fetch the storage volume name. This is unique
within the scope of a pool]]></info>
2641 2642 2643 2644
      <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'>
2645 2646 2647 2648 2649
      <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>
2650 2651 2652 2653
      <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'>
2654 2655
      <info><![CDATA[Fetch an XML document describing all aspects of
the storage volume]]></info>
2656 2657 2658 2659 2660
      <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'>
2661 2662
      <info><![CDATA[Fetch a pointer to a storage volume based on its
globally unique key]]></info>
2663 2664 2665 2666 2667
      <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'>
2668 2669
      <info><![CDATA[Fetch a pointer to a storage volume based on its name
within a pool]]></info>
2670 2671 2672 2673 2674
      <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'>
2675 2676
      <info><![CDATA[Fetch a pointer to a storage volume based on its
locally (host) unique path]]></info>
2677 2678 2679 2680
      <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>
2681
    <function name='virStorageVolRef' file='libvirt' module='libvirt'>
2682 2683 2684 2685 2686 2687 2688 2689 2690 2691
      <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 已提交
2692 2693
      <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'/>
2694
    </function>
2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705
    <function name='virStreamAbort' file='libvirt' module='libvirt'>
      <info><![CDATA[Request that the in progress data transfer be cancelled
abnormally before the end of the stream has been reached.
For output streams this can be used to inform the driver
that the stream is being terminated early. For input
streams this can be used to inform the driver that it
should stop sending data.]]></info>
      <return type='int' info='0 on success, -1 upon error'/>
      <arg name='stream' type='virStreamPtr' info='pointer to the stream object'/>
    </function>
    <function name='virStreamEventAddCallback' file='libvirt' module='libvirt'>
M
Matthias Bolte 已提交
2706 2707 2708 2709 2710 2711 2712 2713 2714 2715
      <info><![CDATA[Register a callback to be notified when a stream
becomes writable, or readable. This is most commonly
used in conjunction with non-blocking data streams
to integrate into an event loop]]></info>
      <return type='int' info='0 on success, -1 upon error'/>
      <arg name='stream' type='virStreamPtr' info='pointer to the stream object'/>
      <arg name='events' type='int' info='set of events to monitor'/>
      <arg name='cb' type='virStreamEventCallback' info='callback to invoke when an event occurs'/>
      <arg name='opaque' type='void *' info='application defined data'/>
      <arg name='ff' type='virFreeCallback' info='callback to free @opaque data'/>
2716 2717 2718 2719 2720 2721 2722 2723 2724 2725
    </function>
    <functype name='virStreamEventCallback' file='libvirt' module='libvirt'>
      <info><![CDATA[Callback for receiving stream events. The callback will
be invoked once for each event which is pending.]]></info>
      <return type='void'/>
      <arg name='stream' type='virStreamPtr' info='stream 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='virStreamEventRemoveCallback' file='libvirt' module='libvirt'>
M
Matthias Bolte 已提交
2726 2727 2728
      <info><![CDATA[Remove a event callback from the stream]]></info>
      <return type='int' info='0 on success, -1 on error'/>
      <arg name='stream' type='virStreamPtr' info='pointer to the stream object'/>
2729 2730
    </function>
    <function name='virStreamEventUpdateCallback' file='libvirt' module='libvirt'>
M
Matthias Bolte 已提交
2731 2732 2733 2734 2735 2736 2737
      <info><![CDATA[Changes the set of events to monitor for a stream. This allows
for event notification to be changed without having to
unregister & register the callback completely. This method
is guarenteed to succeed if a callback is already registered]]></info>
      <return type='int' info='0 on success, -1 if no callback is registered'/>
      <arg name='stream' type='virStreamPtr' info='pointer to the stream object'/>
      <arg name='events' type='int' info='set of events to monitor'/>
2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849
    </function>
    <function name='virStreamFinish' file='libvirt' module='libvirt'>
      <info><![CDATA[Indicate that there is no further data is to be transmitted
on the stream. For output streams this should be called once
all data has been written. For input streams this should be
called once virStreamRecv returns end-of-file.

This method is a synchronization point for all asynchronous
errors, so if this returns a success code the application can
be sure that all data has been successfully processed.]]></info>
      <return type='int' info='0 on success, -1 upon error'/>
      <arg name='stream' type='virStreamPtr' info='pointer to the stream object'/>
    </function>
    <function name='virStreamFree' file='libvirt' module='libvirt'>
      <info><![CDATA[Decrement the reference count on a stream, releasing
the stream object if the reference count has hit zero.

There must not be a active data transfer in progress
when releasing the stream. If a stream needs to be
disposed of prior to end of stream being reached, then
the virStreamAbort function should be called first.]]></info>
      <return type='int' info='0 upon success, or -1 on error'/>
      <arg name='stream' type='virStreamPtr' info='pointer to the stream object'/>
    </function>
    <function name='virStreamNew' file='libvirt' module='libvirt'>
      <info><![CDATA[Creates a new stream object which can be used to perform
streamed I/O with other public API function.

When no longer needed, a stream object must be released
with virStreamFree. If a data stream has been used,
then the application must call virStreamFinish or
virStreamAbort before free'ing to, in order to notify
the driver of termination.

If a non-blocking data stream is required passed
VIR_STREAM_NONBLOCK for flags, otherwise pass 0.]]></info>
      <return type='virStreamPtr' info='the new stream, or NULL upon error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the connection'/>
      <arg name='flags' type='unsigned int' info='control features of the stream'/>
    </function>
    <function name='virStreamRecv' file='libvirt' module='libvirt'>
      <info><![CDATA[Write a series of bytes to the stream. This method may
block the calling application for an arbitrary amount
of time.

Errors are not guaranteed to be reported synchronously
with the call, but may instead be delayed until a
subsequent call.

A example using this with a hypothetical file download
API looks like

  virStreamPtr st = virStreamNew(conn, 0);
  int fd = open("demo.iso", O_WRONLY, 0600)

  virConnectDownloadFile(conn, "demo.iso", st);

  while (1) {
      char buf[1024];
      int got = virStreamRecv(st, buf, 1024);
      if (got < 0)
         break;
      if (got == 0) {
         virStreamFinish(st);
         break;
      }
      int offset = 0;
      while (offset < got) {
         int sent = write(fd, buf+offset, got-offset)
         if (sent < 0) {
            virStreamAbort(st);
            goto done;
         }
         offset += sent;
      }
  }
  if (virStreamFinish(st) < 0)
     ... report an error ....
done:
  virStreamFree(st);
  close(fd);]]></info>
      <return type='int' info='the number of bytes read, which may be less than requested.  Returns 0 when the end of the stream is reached, at which time the caller should invoke virStreamFinish() to get confirmation of stream completion.  Returns -1 upon error, at which time the stream will be marked as aborted, and the caller should now release the stream with virStreamFree.  Returns -2 if there is no data pending to be read &amp; the stream is marked as non-blocking.'/>
      <arg name='stream' type='virStreamPtr' info='pointer to the stream object'/>
      <arg name='data' type='char *' info='buffer to write to stream'/>
      <arg name='nbytes' type='size_t' info='size of @data buffer'/>
    </function>
    <function name='virStreamRecvAll' file='libvirt' module='libvirt'>
      <info><![CDATA[Receive the entire data stream, sending the data to the
requested data sink. This is simply a convenient alternative
to virStreamRecv, for apps that do blocking-I/o.

A example using this with a hypothetical file download
API looks like

  int mysink(virStreamPtr st, const char *buf, int nbytes, void *opaque) {
      int *fd = opaque;

      return write(*fd, buf, nbytes);
  }

  virStreamPtr st = virStreamNew(conn, 0);
  int fd = open("demo.iso", O_WRONLY)

  virConnectUploadFile(conn, st);
  if (virStreamRecvAll(st, mysink, &fd) < 0) {
     ...report an error ...
     goto done;
  }
  if (virStreamFinish(st) < 0)
     ...report an error...
  virStreamFree(st);
  close(fd);]]></info>
2850
      <return type='int' info='0 if all the data was successfully received. The caller should invoke virStreamFinish(st) to flush the stream upon success and then virStreamFree  Returns -1 upon any error, with virStreamAbort() already having been called,  so the caller need only call virStreamFree()'/>
2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866
      <arg name='stream' type='virStreamPtr' info='pointer to the stream object'/>
      <arg name='handler' type='virStreamSinkFunc' info='sink callback for writing data to application'/>
      <arg name='opaque' type='void *' info='application defined data'/>
    </function>
    <function name='virStreamRef' file='libvirt' module='libvirt'>
      <info><![CDATA[Increment the reference count on the stream. For each
additional call to this method, there shall be a corresponding
call to virStreamFree to release the reference count, once
the caller no longer needs the reference to this object.]]></info>
      <return type='int' info='0 in case of success, -1 in case of failure'/>
      <arg name='stream' type='virStreamPtr' info='pointer to the stream'/>
    </function>
    <function name='virStreamSend' file='libvirt' module='libvirt'>
      <info><![CDATA[Write a series of bytes to the stream. This method may
block the calling application for an arbitrary amount
of time. Once an application has finished sending data
2867
it should call virStreamFinish to wait for successful
2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941
confirmation from the driver, or detect any error

This method may not be used if a stream source has been
registered

Errors are not guaranteed to be reported synchronously
with the call, but may instead be delayed until a
subsequent call.

A example using this with a hypothetical file upload
API looks like

  virStreamPtr st = virStreamNew(conn, 0);
  int fd = open("demo.iso", O_RDONLY)

  virConnectUploadFile(conn, "demo.iso", st);

  while (1) {
      char buf[1024];
      int got = read(fd, buf, 1024);
      if (got < 0) {
         virStreamAbort(st);
         break;
      }
      if (got == 0) {
         virStreamFinish(st);
         break;
      }
      int offset = 0;
      while (offset < got) {
         int sent = virStreamSend(st, buf+offset, got-offset)
         if (sent < 0) {
            virStreamAbort(st);
            goto done;
         }
         offset += sent;
      }
  }
  if (virStreamFinish(st) < 0)
     ... report an error ....
done:
  virStreamFree(st);
  close(fd);]]></info>
      <return type='int' info='the number of bytes written, which may be less than requested.  Returns -1 upon error, at which time the stream will be marked as aborted, and the caller should now release the stream with virStreamFree.  Returns -2 if the outgoing transmit buffers are full &amp; the stream is marked as non-blocking.'/>
      <arg name='stream' type='virStreamPtr' info='pointer to the stream object'/>
      <arg name='data' type='const char *' info='buffer to write to stream'/>
      <arg name='nbytes' type='size_t' info='size of @data buffer'/>
    </function>
    <function name='virStreamSendAll' file='libvirt' module='libvirt'>
      <info><![CDATA[Send the entire data stream, reading the data from the
requested data source. This is simply a convenient alternative
to virStreamSend, for apps that do blocking-I/o.

A example using this with a hypothetical file upload
API looks like

  int mysource(virStreamPtr st, char *buf, int nbytes, void *opaque) {
      int *fd = opaque;

      return read(*fd, buf, nbytes);
  }

  virStreamPtr st = virStreamNew(conn, 0);
  int fd = open("demo.iso", O_RDONLY)

  virConnectUploadFile(conn, st);
  if (virStreamSendAll(st, mysource, &fd) < 0) {
     ...report an error ...
     goto done;
  }
  if (virStreamFinish(st) < 0)
     ...report an error...
  virStreamFree(st);
  close(fd);]]></info>
2942
      <return type='int' info='0 if all the data was successfully sent. The caller should invoke virStreamFinish(st) to flush the stream upon success and then virStreamFree  Returns -1 upon any error, with virStreamAbort() already having been called,  so the caller need only call virStreamFree()'/>
2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984
      <arg name='stream' type='virStreamPtr' info='pointer to the stream object'/>
      <arg name='handler' type='virStreamSourceFunc' info='source callback for reading data from application'/>
      <arg name='opaque' type='void *' info='application defined data'/>
    </function>
    <functype name='virStreamSinkFunc' file='libvirt' module='libvirt'>
      <info><![CDATA[The virStreamSinkFunc callback is used together
with the virStreamRecvAll function for libvirt to
provide the data that has been received.

The callback will be invoked multiple times,
providing data in small chunks. The application
should consume up 'nbytes' from the 'data' array
of data and then return the number actual number
of bytes consumed. The callback will continue to be
invoked until it indicates the end of the stream
has been reached. A return value of -1 at any time
will abort the receive operation]]></info>
      <return type='int' info='the number of bytes consumed or -1 upon error'/>
      <arg name='st' type='virStreamPtr' info='the stream object'/>
      <arg name='data' type='const char *' info='preallocated array to be filled with data'/>
      <arg name='nbytes' type='size_t' info='size of the data array'/>
      <arg name='opaque' type='void *' info='optional application provided data'/>
    </functype>
    <functype name='virStreamSourceFunc' file='libvirt' module='libvirt'>
      <info><![CDATA[The virStreamSourceFunc callback is used together
with the virStreamSendAll function for libvirt to
obtain the data that is to be sent.

The callback will be invoked multiple times,
fetching data in small chunks. The application
should fill the 'data' array with upto 'nbytes'
of data and then return the number actual number
of bytes. The callback will continue to be
invoked until it indicates the end of the source
has been reached by returning 0. A return value
of -1 at any time will abort the send operation]]></info>
      <return type='int' info='the number of bytes filled, 0 upon end of file, or -1 upon error'/>
      <arg name='st' type='virStreamPtr' info='the stream object'/>
      <arg name='data' type='char *' info='preallocated array to be filled with data'/>
      <arg name='nbytes' type='size_t' info='size of the data array'/>
      <arg name='opaque' type='void *' info='optional application provided data'/>
    </functype>
2985 2986
  </symbols>
</api>