libvirt-api.xml 172.8 KB
Newer Older
1
<?xml version="1.0" encoding="ISO-8859-1"?>
D
Daniel Veillard 已提交
2
<api name='libvirt'>
3
  <files>
4 5
    <file name='libvirt'>
     <summary>core interfaces for the libvirt library</summary>
6
     <description>Provides the interfaces of the libvirt library to handle virtualized domains </description>
7
     <author>Daniel Veillard &lt;veillard@redhat.com&gt; </author>
8
     <exports symbol='VIR_NODEINFO_MAXCPUS' type='macro'/>
9
     <exports symbol='LIBVIR_VERSION_NUMBER' type='macro'/>
10
     <exports symbol='VIR_USE_CPU' type='macro'/>
11
     <exports symbol='VIR_SECURITY_DOI_BUFLEN' type='macro'/>
12
     <exports symbol='VIR_CPU_MAPLEN' type='macro'/>
13
     <exports symbol='VIR_SECURITY_LABEL_BUFLEN' type='macro'/>
14 15
     <exports symbol='VIR_CPU_USABLE' type='macro'/>
     <exports symbol='VIR_COPY_CPUMAP' type='macro'/>
16
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_LENGTH' type='macro'/>
17
     <exports symbol='VIR_SECURITY_MODEL_BUFLEN' type='macro'/>
18
     <exports symbol='VIR_UUID_STRING_BUFLEN' type='macro'/>
19
     <exports symbol='VIR_GET_CPUMAP' type='macro'/>
20
     <exports symbol='VIR_UUID_BUFLEN' type='macro'/>
21
     <exports symbol='VIR_UNUSE_CPU' type='macro'/>
22
     <exports symbol='VIR_DOMAIN_EVENT_DEFINED' type='enum'/>
23
     <exports symbol='VIR_CRED_EXTERNAL' type='enum'/>
24
     <exports symbol='VIR_DOMAIN_EVENT_STOPPED_CRASHED' type='enum'/>
25
     <exports symbol='VIR_EVENT_HANDLE_READABLE' type='enum'/>
26 27
     <exports symbol='VIR_DOMAIN_SHUTDOWN' type='enum'/>
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_UINT' type='enum'/>
28
     <exports symbol='VIR_STORAGE_POOL_BUILDING' type='enum'/>
29 30
     <exports symbol='VIR_CRED_CNONCE' type='enum'/>
     <exports symbol='VIR_CRED_ECHOPROMPT' type='enum'/>
31
     <exports symbol='VIR_DOMAIN_EVENT_STARTED_BOOTED' type='enum'/>
32 33
     <exports symbol='VIR_DOMAIN_EVENT_RESUMED' type='enum'/>
     <exports symbol='VIR_VCPU_OFFLINE' type='enum'/>
34
     <exports symbol='VIR_STORAGE_VOL_DELETE_NORMAL' type='enum'/>
35 36
     <exports symbol='VIR_STORAGE_POOL_RUNNING' type='enum'/>
     <exports symbol='VIR_STORAGE_POOL_BUILD_RESIZE' type='enum'/>
37
     <exports symbol='VIR_DOMAIN_EVENT_STOPPED_FAILED' type='enum'/>
38
     <exports symbol='VIR_CONNECT_RO' type='enum'/>
39
     <exports symbol='VIR_DOMAIN_EVENT_STOPPED' type='enum'/>
40
     <exports symbol='VIR_CRED_AUTHNAME' type='enum'/>
41
     <exports symbol='VIR_STORAGE_POOL_BUILD_REPAIR' type='enum'/>
42 43
     <exports symbol='VIR_CRED_LANGUAGE' type='enum'/>
     <exports symbol='VIR_CRED_NOECHOPROMPT' type='enum'/>
44
     <exports symbol='VIR_DOMAIN_EVENT_UNDEFINED' type='enum'/>
45
     <exports symbol='VIR_MIGRATE_LIVE' type='enum'/>
46 47 48
     <exports symbol='VIR_DOMAIN_EVENT_STOPPED_DESTROYED' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_DEFINED_ADDED' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_STARTED_MIGRATED' type='enum'/>
49
     <exports symbol='VIR_VCPU_BLOCKED' type='enum'/>
50
     <exports symbol='VIR_MEMORY_VIRTUAL' type='enum'/>
51 52
     <exports symbol='VIR_CRED_USERNAME' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_RESUMED_UNPAUSED' type='enum'/>
53
     <exports symbol='VIR_DOMAIN_RUNNING' type='enum'/>
D
Daniel Veillard 已提交
54
     <exports symbol='VIR_STORAGE_VOL_DELETE_ZEROED' type='enum'/>
55 56
     <exports symbol='VIR_EVENT_HANDLE_ERROR' type='enum'/>
     <exports symbol='VIR_DOMAIN_NOSTATE' type='enum'/>
57
     <exports symbol='VIR_DOMAIN_SHUTOFF' type='enum'/>
58 59
     <exports symbol='VIR_STORAGE_POOL_DELETE_ZEROED' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_STARTED_RESTORED' type='enum'/>
60
     <exports symbol='VIR_EVENT_HANDLE_WRITABLE' type='enum'/>
61 62
     <exports symbol='VIR_STORAGE_POOL_BUILD_NEW' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_SUSPENDED_PAUSED' type='enum'/>
63
     <exports symbol='VIR_STORAGE_POOL_DELETE_NORMAL' type='enum'/>
D
Daniel Veillard 已提交
64
     <exports symbol='VIR_MEMORY_PHYSICAL' type='enum'/>
65
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_INT' type='enum'/>
66
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_ULLONG' type='enum'/>
67
     <exports symbol='VIR_DOMAIN_EVENT_STOPPED_SHUTDOWN' type='enum'/>
68
     <exports symbol='VIR_CRED_REALM' type='enum'/>
69
     <exports symbol='VIR_DOMAIN_EVENT_STARTED' type='enum'/>
70
     <exports symbol='VIR_STORAGE_VOL_FILE' type='enum'/>
71
     <exports symbol='VIR_EVENT_HANDLE_HANGUP' type='enum'/>
72
     <exports symbol='VIR_DOMAIN_PAUSED' type='enum'/>
73
     <exports symbol='VIR_STORAGE_POOL_DEGRADED' type='enum'/>
74 75
     <exports symbol='VIR_DOMAIN_EVENT_DEFINED_UPDATED' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_SUSPENDED_MIGRATED' type='enum'/>
76
     <exports symbol='VIR_DOMAIN_CRASHED' type='enum'/>
77
     <exports symbol='VIR_VCPU_RUNNING' type='enum'/>
78 79 80
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_DOUBLE' type='enum'/>
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_LLONG' type='enum'/>
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_BOOLEAN' type='enum'/>
81
     <exports symbol='VIR_DOMAIN_XML_INACTIVE' type='enum'/>
82
     <exports symbol='VIR_STORAGE_VOL_BLOCK' type='enum'/>
83
     <exports symbol='VIR_DOMAIN_NONE' type='enum'/>
84 85
     <exports symbol='VIR_DOMAIN_EVENT_UNDEFINED_REMOVED' type='enum'/>
     <exports symbol='VIR_DOMAIN_EVENT_RESUMED_MIGRATED' type='enum'/>
86
     <exports symbol='VIR_DOMAIN_BLOCKED' type='enum'/>
87 88 89 90
     <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'/>
91
     <exports symbol='VIR_DOMAIN_XML_SECURE' type='enum'/>
92
     <exports symbol='VIR_DOMAIN_EVENT_SUSPENDED' type='enum'/>
93
     <exports symbol='virDomainBlockStatsStruct' type='typedef'/>
94
     <exports symbol='virDomainMigrateFlags' type='typedef'/>
95 96
     <exports symbol='virNodeInfo' type='typedef'/>
     <exports symbol='virNetwork' type='typedef'/>
97
     <exports symbol='virDomainEventResumedDetailType' type='typedef'/>
98 99
     <exports symbol='virDomainBlockStatsPtr' type='typedef'/>
     <exports symbol='virConnect' type='typedef'/>
100
     <exports symbol='virSecretPtr' type='typedef'/>
101
     <exports symbol='virDomainEventStartedDetailType' type='typedef'/>
102
     <exports symbol='virDomainInfo' type='typedef'/>
103
     <exports symbol='virStoragePoolDeleteFlags' type='typedef'/>
104
     <exports symbol='virEventHandleType' type='typedef'/>
105
     <exports symbol='virStoragePool' type='typedef'/>
106
     <exports symbol='virDomainEventType' type='typedef'/>
107
     <exports symbol='virDomainInterfaceStatsStruct' type='typedef'/>
108
     <exports symbol='virStoragePoolInfo' type='typedef'/>
109
     <exports symbol='virSecret' type='typedef'/>
110 111
     <exports symbol='virDomainState' type='typedef'/>
     <exports symbol='virDomain' type='typedef'/>
112
     <exports symbol='virDomainInterfaceStatsPtr' type='typedef'/>
113
     <exports symbol='virConnectAuthPtr' type='typedef'/>
114
     <exports symbol='virStorageVolInfo' type='typedef'/>
115
     <exports symbol='virSchedParameterType' type='typedef'/>
116
     <exports symbol='virSecurityLabel' type='typedef'/>
D
Daniel P. Berrange 已提交
117
     <exports symbol='virStorageVolInfoPtr' type='typedef'/>
118
     <exports symbol='virConnectCredentialPtr' type='typedef'/>
119
     <exports symbol='virStoragePoolPtr' type='typedef'/>
120 121 122
     <exports symbol='virNodeInfoPtr' type='typedef'/>
     <exports symbol='virNetworkPtr' type='typedef'/>
     <exports symbol='virDomainInfoPtr' type='typedef'/>
D
Daniel P. Berrange 已提交
123
     <exports symbol='virNodeDevice' type='typedef'/>
124
     <exports symbol='virConnectPtr' type='typedef'/>
125
     <exports symbol='virStorageVol' type='typedef'/>
D
Daniel P. Berrange 已提交
126
     <exports symbol='virNodeDevicePtr' type='typedef'/>
127
     <exports symbol='virInterface' type='typedef'/>
128
     <exports symbol='virSchedParameter' type='typedef'/>
129
     <exports symbol='virConnectFlags' type='typedef'/>
130
     <exports symbol='virDomainEventDefinedDetailType' type='typedef'/>
131
     <exports symbol='virInterfacePtr' type='typedef'/>
132
     <exports symbol='virDomainMemoryFlags' type='typedef'/>
133
     <exports symbol='virDomainEventStoppedDetailType' type='typedef'/>
134
     <exports symbol='virStorageVolPtr' type='typedef'/>
135
     <exports symbol='virVcpuState' type='typedef'/>
136
     <exports symbol='virStorageVolDeleteFlags' type='typedef'/>
137
     <exports symbol='virVcpuInfo' type='typedef'/>
138
     <exports symbol='virSchedParameterPtr' type='typedef'/>
139 140
     <exports symbol='virConnectAuth' type='typedef'/>
     <exports symbol='virConnectCredential' type='typedef'/>
141
     <exports symbol='virSecurityModelPtr' type='typedef'/>
142
     <exports symbol='virDomainEventSuspendedDetailType' type='typedef'/>
143
     <exports symbol='virVcpuInfoPtr' type='typedef'/>
144
     <exports symbol='virStoragePoolBuildFlags' type='typedef'/>
145
     <exports symbol='virDomainXMLFlags' type='typedef'/>
146
     <exports symbol='virStorageVolType' type='typedef'/>
147
     <exports symbol='virDomainEventUndefinedDetailType' type='typedef'/>
148
     <exports symbol='virDomainPtr' type='typedef'/>
149
     <exports symbol='virConnectCredentialType' type='typedef'/>
150 151
     <exports symbol='virStoragePoolState' type='typedef'/>
     <exports symbol='virStoragePoolInfoPtr' type='typedef'/>
152
     <exports symbol='virDomainCreateFlags' type='typedef'/>
153 154
     <exports symbol='virSecurityLabelPtr' type='typedef'/>
     <exports symbol='virSecurityModel' type='typedef'/>
155
     <exports symbol='_virDomainInfo' type='struct'/>
156
     <exports symbol='_virConnectAuth' type='struct'/>
157
     <exports symbol='_virVcpuInfo' type='struct'/>
158
     <exports symbol='_virDomainInterfaceStats' type='struct'/>
159
     <exports symbol='_virStoragePoolInfo' type='struct'/>
160
     <exports symbol='_virConnectCredential' type='struct'/>
161
     <exports symbol='_virSecurityLabel' type='struct'/>
162
     <exports symbol='_virStorageVolInfo' type='struct'/>
163
     <exports symbol='_virSecurityModel' type='struct'/>
164 165
     <exports symbol='_virDomainBlockStats' type='struct'/>
     <exports symbol='_virNodeInfo' type='struct'/>
166 167
     <exports symbol='_virSchedParameter' type='struct'/>
     <exports symbol='virConnectAuthPtrDefault' type='variable'/>
168
     <exports symbol='virStoragePoolGetXMLDesc' type='function'/>
169
     <exports symbol='virSecretGetUUIDString' type='function'/>
170
     <exports symbol='virStorageVolGetKey' type='function'/>
171
     <exports symbol='virEventUpdateTimeoutFunc' type='function'/>
172
     <exports symbol='virDomainUndefine' type='function'/>
173 174
     <exports symbol='virDomainDefineXML' type='function'/>
     <exports symbol='virDomainShutdown' type='function'/>
175
     <exports symbol='virConnectListDefinedInterfaces' type='function'/>
176
     <exports symbol='virGetVersion' type='function'/>
177
     <exports symbol='virNodeGetCellsFreeMemory' type='function'/>
178
     <exports symbol='virInitialize' type='function'/>
D
Daniel P. Berrange 已提交
179
     <exports symbol='virNodeDeviceGetName' type='function'/>
180
     <exports symbol='virConnectNumOfSecrets' type='function'/>
181
     <exports symbol='virStoragePoolSetAutostart' type='function'/>
182
     <exports symbol='virConnectDomainXMLFromNative' type='function'/>
183 184
     <exports symbol='virNodeDeviceDettach' type='function'/>
     <exports symbol='virDomainGetSecurityLabel' type='function'/>
185
     <exports symbol='virConnectDomainEventDeregister' type='function'/>
186 187 188
     <exports symbol='virDomainGetSchedulerParameters' type='function'/>
     <exports symbol='virDomainLookupByUUIDString' type='function'/>
     <exports symbol='virConnectNumOfDefinedNetworks' type='function'/>
189
     <exports symbol='virConnectListStoragePools' type='function'/>
190
     <exports symbol='virNetworkGetUUID' type='function'/>
191
     <exports symbol='virInterfaceGetXMLDesc' type='function'/>
192 193 194
     <exports symbol='virStoragePoolGetConnect' type='function'/>
     <exports symbol='virConnectGetVersion' type='function'/>
     <exports symbol='virDomainFree' type='function'/>
195
     <exports symbol='virStorageVolRef' type='function'/>
196 197 198 199 200
     <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'/>
201
     <exports symbol='virNetworkCreate' type='function'/>
202
     <exports symbol='virDomainSetMaxMemory' type='function'/>
203
     <exports symbol='virEventRegisterImpl' type='function'/>
204
     <exports symbol='virInterfaceDefineXML' type='function'/>
205 206
     <exports symbol='virDomainMigrate' type='function'/>
     <exports symbol='virDomainSuspend' type='function'/>
207
     <exports symbol='virDomainCreateLinux' type='function'/>
D
Daniel P. Berrange 已提交
208
     <exports symbol='virNodeDeviceGetXMLDesc' type='function'/>
209
     <exports symbol='virEventUpdateHandleFunc' type='function'/>
210 211 212
     <exports symbol='virDomainDestroy' type='function'/>
     <exports symbol='virConnectNumOfNetworks' type='function'/>
     <exports symbol='virStoragePoolLookupByUUIDString' type='function'/>
213
     <exports symbol='virSecretGetConnect' type='function'/>
214
     <exports symbol='virInterfaceCreate' type='function'/>
215 216
     <exports symbol='virDomainGetXMLDesc' type='function'/>
     <exports symbol='virStoragePoolGetUUID' type='function'/>
D
Daniel P. Berrange 已提交
217
     <exports symbol='virNodeDeviceFree' type='function'/>
218
     <exports symbol='virStorageVolGetInfo' type='function'/>
219
     <exports symbol='virDomainGetInfo' type='function'/>
220
     <exports symbol='virNodeDeviceCreateXML' type='function'/>
221 222
     <exports symbol='virNetworkDestroy' type='function'/>
     <exports symbol='virStoragePoolLookupByName' type='function'/>
D
Daniel P. Berrange 已提交
223
     <exports symbol='virStoragePoolCreateXML' type='function'/>
224
     <exports symbol='virNetworkGetAutostart' type='function'/>
225
     <exports symbol='virNetworkGetBridgeName' type='function'/>
226
     <exports symbol='virStorageVolGetXMLDesc' type='function'/>
227
     <exports symbol='virConnectDomainXMLToNative' type='function'/>
228
     <exports symbol='virDomainSetSchedulerParameters' type='function'/>
229
     <exports symbol='virConnectGetType' type='function'/>
230
     <exports symbol='virStorageVolCreateXML' type='function'/>
231
     <exports symbol='virDomainSave' type='function'/>
232 233
     <exports symbol='virDomainCreate' type='function'/>
     <exports symbol='virConnectListDomains' type='function'/>
D
Daniel Veillard 已提交
234
     <exports symbol='virDomainCoreDump' type='function'/>
235
     <exports symbol='virDomainSetMemory' type='function'/>
236
     <exports symbol='virInterfaceGetName' type='function'/>
237
     <exports symbol='virStoragePoolCreate' type='function'/>
238
     <exports symbol='virNodeGetInfo' type='function'/>
239
     <exports symbol='virNetworkSetAutostart' type='function'/>
240
     <exports symbol='virSecretLookupByUUIDString' type='function'/>
D
Daniel Veillard 已提交
241
     <exports symbol='virDomainGetMaxMemory' type='function'/>
242
     <exports symbol='virStoragePoolFree' type='function'/>
D
Daniel Veillard 已提交
243
     <exports symbol='virConnectNumOfDefinedInterfaces' type='function'/>
D
Daniel P. Berrange 已提交
244
     <exports symbol='virFreeCallback' type='function'/>
245
     <exports symbol='virNetworkDefineXML' type='function'/>
D
Daniel P. Berrange 已提交
246
     <exports symbol='virNodeDeviceListCaps' type='function'/>
247
     <exports symbol='virDomainBlockStats' type='function'/>
248
     <exports symbol='virConnectOpenAuth' type='function'/>
249
     <exports symbol='virStoragePoolDelete' type='function'/>
250
     <exports symbol='virDomainResume' type='function'/>
251 252
     <exports symbol='virStorageVolGetName' type='function'/>
     <exports symbol='virStoragePoolGetAutostart' type='function'/>
253
     <exports symbol='virDomainGetAutostart' type='function'/>
254
     <exports symbol='virStoragePoolListVolumes' type='function'/>
255
     <exports symbol='virConnectGetHostname' type='function'/>
256
     <exports symbol='virEventRemoveTimeoutFunc' type='function'/>
257
     <exports symbol='virDomainGetName' type='function'/>
258
     <exports symbol='virStoragePoolRef' type='function'/>
259 260
     <exports symbol='virNetworkGetXMLDesc' type='function'/>
     <exports symbol='virConnectNumOfStoragePools' type='function'/>
261
     <exports symbol='virInterfaceGetConnect' type='function'/>
262
     <exports symbol='virNetworkGetName' type='function'/>
263
     <exports symbol='virSecretGetXMLDesc' type='function'/>
264 265 266
     <exports symbol='virConnectListDefinedDomains' type='function'/>
     <exports symbol='virConnectGetCapabilities' type='function'/>
     <exports symbol='virDomainLookupByName' type='function'/>
267
     <exports symbol='virConnectFindStoragePoolSources' type='function'/>
268
     <exports symbol='virStorageVolFree' type='function'/>
269
     <exports symbol='virDomainPinVcpu' type='function'/>
270
     <exports symbol='virNodeGetSecurityModel' type='function'/>
271
     <exports symbol='virDomainRestore' type='function'/>
D
Daniel Veillard 已提交
272
     <exports symbol='virNodeDeviceDestroy' type='function'/>
273 274
     <exports symbol='virStorageVolGetPath' type='function'/>
     <exports symbol='virNetworkLookupByUUIDString' type='function'/>
275
     <exports symbol='virConnectDomainEventCallback' type='function'/>
276
     <exports symbol='virDomainLookupByID' type='function'/>
277
     <exports symbol='virStorageVolDelete' type='function'/>
278
     <exports symbol='virSecretUndefine' type='function'/>
279
     <exports symbol='virConnectListInterfaces' type='function'/>
280
     <exports symbol='virDomainMemoryPeek' type='function'/>
281 282
     <exports symbol='virNetworkLookupByUUID' type='function'/>
     <exports symbol='virConnectListDefinedNetworks' type='function'/>
283
     <exports symbol='virConnectRef' type='function'/>
284 285
     <exports symbol='virDomainGetUUID' type='function'/>
     <exports symbol='virNetworkCreateXML' type='function'/>
D
Daniel Veillard 已提交
286
     <exports symbol='virNetworkUndefine' type='function'/>
287
     <exports symbol='virConnectDomainEventRegister' type='function'/>
288
     <exports symbol='virDomainGetVcpus' type='function'/>
D
Daniel P. Berrange 已提交
289
     <exports symbol='virNodeDeviceLookupByName' type='function'/>
290
     <exports symbol='virStoragePoolGetInfo' type='function'/>
291
     <exports symbol='virEventRemoveHandleFunc' type='function'/>
292 293
     <exports symbol='virInterfaceRef' type='function'/>
     <exports symbol='virInterfaceGetMACString' type='function'/>
D
Daniel Veillard 已提交
294
     <exports symbol='virConnectNumOfDomains' type='function'/>
295 296
     <exports symbol='virStoragePoolRefresh' type='function'/>
     <exports symbol='virConnectNumOfDefinedDomains' type='function'/>
297
     <exports symbol='virStorageVolCreateXMLFrom' type='function'/>
298
     <exports symbol='virConnectClose' type='function'/>
299 300 301 302
     <exports symbol='virDomainReboot' type='function'/>
     <exports symbol='virNetworkGetUUIDString' type='function'/>
     <exports symbol='virNetworkLookupByName' type='function'/>
     <exports symbol='virDomainGetMaxVcpus' type='function'/>
303
     <exports symbol='virEventHandleCallback' type='function'/>
304
     <exports symbol='virDomainGetSchedulerType' type='function'/>
305
     <exports symbol='virNodeDeviceReset' type='function'/>
306 307 308
     <exports symbol='virDomainDetachDevice' type='function'/>
     <exports symbol='virStoragePoolNumOfVolumes' type='function'/>
     <exports symbol='virStoragePoolGetUUIDString' type='function'/>
309
     <exports symbol='virNodeDeviceReAttach' type='function'/>
310
     <exports symbol='virStoragePoolUndefine' type='function'/>
311
     <exports symbol='virConnectAuthCallbackPtr' type='function'/>
312
     <exports symbol='virDomainAttachDevice' type='function'/>
313
     <exports symbol='virConnectGetURI' type='function'/>
314
     <exports symbol='virConnectOpenReadOnly' type='function'/>
315
     <exports symbol='virSecretDefineXML' type='function'/>
316 317
     <exports symbol='virNetworkFree' type='function'/>
     <exports symbol='virStoragePoolLookupByUUID' type='function'/>
318
     <exports symbol='virEventAddHandleFunc' type='function'/>
D
Daniel Veillard 已提交
319
     <exports symbol='virNetworkRef' type='function'/>
320
     <exports symbol='virConnectListDefinedStoragePools' type='function'/>
321
     <exports symbol='virEventTimeoutCallback' type='function'/>
322
     <exports symbol='virInterfaceFree' type='function'/>
D
Daniel P. Berrange 已提交
323
     <exports symbol='virNodeDeviceNumOfCaps' type='function'/>
324
     <exports symbol='virInterfaceLookupByMACString' type='function'/>
325 326
     <exports symbol='virNetworkGetConnect' type='function'/>
     <exports symbol='virNodeGetFreeMemory' type='function'/>
327
     <exports symbol='virInterfaceDestroy' type='function'/>
328
     <exports symbol='virSecretSetValue' type='function'/>
329
     <exports symbol='virStorageVolGetConnect' type='function'/>
D
Daniel P. Berrange 已提交
330
     <exports symbol='virNodeNumOfDevices' type='function'/>
331 332 333 334 335 336 337 338 339
     <exports symbol='virStoragePoolDestroy' type='function'/>
     <exports symbol='virStoragePoolLookupByVolume' type='function'/>
     <exports symbol='virDomainLookupByUUID' type='function'/>
     <exports symbol='virDomainGetOSType' type='function'/>
     <exports symbol='virStoragePoolBuild' type='function'/>
     <exports symbol='virConnectGetMaxVcpus' type='function'/>
     <exports symbol='virDomainGetUUIDString' type='function'/>
     <exports symbol='virDomainGetConnect' type='function'/>
     <exports symbol='virConnectNumOfDefinedStoragePools' type='function'/>
340
     <exports symbol='virSecretFree' type='function'/>
341
     <exports symbol='virNodeListDevices' type='function'/>
D
Daniel P. Berrange 已提交
342
     <exports symbol='virNodeDeviceGetParent' type='function'/>
343
     <exports symbol='virConnectOpen' type='function'/>
344
     <exports symbol='virDomainCreateXML' type='function'/>
345
     <exports symbol='virNodeDeviceRef' type='function'/>
346
     <exports symbol='virInterfaceUndefine' type='function'/>
347
     <exports symbol='virDomainSetVcpus' type='function'/>
348
     <exports symbol='virDomainRef' type='function'/>
349
     <exports symbol='virConnectListSecrets' type='function'/>
350
     <exports symbol='virConnectNumOfInterfaces' type='function'/>
351
     <exports symbol='virDomainGetID' type='function'/>
352
     <exports symbol='virSecretRef' type='function'/>
353
     <exports symbol='virDomainBlockPeek' type='function'/>
354
     <exports symbol='virEventAddTimeoutFunc' type='function'/>
355
     <exports symbol='virInterfaceLookupByName' type='function'/>
356 357
     <exports symbol='virDomainInterfaceStats' type='function'/>
     <exports symbol='virConnectListNetworks' type='function'/>
358
     <exports symbol='virSecretGetValue' type='function'/>
359
     <exports symbol='virStorageVolLookupByKey' type='function'/>
360 361 362 363 364 365
    </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'/>
366
     <exports symbol='VIR_FROM_ONE' type='enum'/>
367
     <exports symbol='VIR_FROM_NETWORK' type='enum'/>
D
Daniel P. Berrange 已提交
368
     <exports symbol='VIR_ERR_NO_NODE_DEVICE' type='enum'/>
369
     <exports symbol='VIR_ERR_NO_MEMORY' type='enum'/>
D
Daniel P. Berrange 已提交
370
     <exports symbol='VIR_WAR_NO_NODE' type='enum'/>
371
     <exports symbol='VIR_ERR_NO_STORAGE_VOL' type='enum'/>
372
     <exports symbol='VIR_FROM_XML' type='enum'/>
373
     <exports symbol='VIR_FROM_CONF' type='enum'/>
374
     <exports symbol='VIR_ERR_INVALID_NETWORK' type='enum'/>
375
     <exports symbol='VIR_ERR_PARSE_FAILED' type='enum'/>
376 377
     <exports symbol='VIR_ERR_POST_FAILED' type='enum'/>
     <exports symbol='VIR_ERR_INVALID_CONN' type='enum'/>
378 379 380
     <exports symbol='VIR_ERR_GET_FAILED' type='enum'/>
     <exports symbol='VIR_ERR_NO_SOURCE' type='enum'/>
     <exports symbol='VIR_ERR_NETWORK_EXIST' type='enum'/>
381
     <exports symbol='VIR_ERR_NONE' type='enum'/>
382 383 384 385 386 387
     <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 已提交
388
     <exports symbol='VIR_FROM_ESX' type='enum'/>
389 390
     <exports symbol='VIR_FROM_VBOX' type='enum'/>
     <exports symbol='VIR_FROM_TEST' type='enum'/>
D
Daniel Veillard 已提交
391
     <exports symbol='VIR_ERR_MULTIPLE_INTERFACES' type='enum'/>
392 393 394 395 396 397 398 399 400
     <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'/>
401
     <exports symbol='VIR_WAR_NO_SECRET' type='enum'/>
402 403
     <exports symbol='VIR_WAR_NO_NETWORK' type='enum'/>
     <exports symbol='VIR_FROM_UML' type='enum'/>
404 405 406
     <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 已提交
407
     <exports symbol='VIR_FROM_NODEDEV' type='enum'/>
408
     <exports symbol='VIR_ERR_NO_TARGET' type='enum'/>
409
     <exports symbol='VIR_FROM_SECURITY' type='enum'/>
410
     <exports symbol='VIR_ERR_CONF_SYNTAX' type='enum'/>
411
     <exports symbol='VIR_ERR_NO_SUPPORT' type='enum'/>
412
     <exports symbol='VIR_ERR_NO_SECURITY_MODEL' type='enum'/>
D
Daniel Veillard 已提交
413
     <exports symbol='VIR_FROM_PHYP' type='enum'/>
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
     <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_ERR_INVALID_INTERFACE' type='enum'/>
     <exports symbol='VIR_FROM_STORAGE' type='enum'/>
429
     <exports symbol='VIR_FROM_PROXY' type='enum'/>
430 431
     <exports symbol='VIR_ERR_DRIVER_FULL' type='enum'/>
     <exports symbol='VIR_FROM_DOMAIN' type='enum'/>
432
     <exports symbol='VIR_ERR_INVALID_SECRET' type='enum'/>
433 434
     <exports symbol='VIR_ERR_OPERATION_DENIED' type='enum'/>
     <exports symbol='VIR_ERR_INVALID_STORAGE_POOL' type='enum'/>
435
     <exports symbol='VIR_FROM_SECRET' type='enum'/>
436
     <exports symbol='VIR_ERR_NO_DOMAIN' type='enum'/>
437
     <exports symbol='VIR_FROM_XEN' type='enum'/>
438 439 440
     <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 已提交
441
     <exports symbol='VIR_ERR_CALL_FAILED' type='enum'/>
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
     <exports symbol='VIR_ERR_ERROR' type='enum'/>
     <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'/>
459 460 461 462 463 464 465 466
     <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'/>
467
     <exports symbol='virFreeError' type='function'/>
468 469 470 471 472 473 474 475 476 477 478
     <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'/>
479
     <exports symbol='virSaveLastError' type='function'/>
480
    </file>
481 482
  </files>
  <symbols>
483 484 485
    <macro name='LIBVIR_VERSION_NUMBER' file='libvirt'>
      <info>Macro providing the version of the library as version * 1,000,000 + minor * 1000 + micro</info>
    </macro>
486
    <macro name='VIR_COPY_CPUMAP' file='libvirt'>
487
      <info>This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_COPY_CPUMAP macro extract the cpumap of the specified vcpu from cpumaps array and copy it into cpumap to be used later by virDomainPinVcpu() API.</info>
488 489 490 491 492 493
      <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'>
494
      <info>This macro is to be used in conjunction with virDomainPinVcpu() API. It returns the length (in bytes) required to store the complete CPU map between a single virtual &amp; all physical CPUs of a domain.</info>
495
      <arg name='cpu' info='number of physical CPUs'/>
496 497
    </macro>
    <macro name='VIR_CPU_USABLE' file='libvirt'>
498
      <info>This macro is to be used in conjunction with virDomainGetVcpus() API. VIR_CPU_USABLE macro returns a non zero value (true) if the cpu is usable by the vcpu, and 0 otherwise.</info>
499 500 501 502 503
      <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>
504 505 506
    <macro name='VIR_DOMAIN_SCHED_FIELD_LENGTH' file='libvirt'>
      <info>Macro providing the field length of virSchedParameter</info>
    </macro>
507
    <macro name='VIR_GET_CPUMAP' file='libvirt'>
508
      <info>This macro is to be used in conjunction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_GET_CPUMAP macro returns a pointer to the cpumap of the specified vcpu from cpumaps array.</info>
509 510 511 512 513
      <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'>
514
      <info>This macro is to calculate the total number of CPUs supported but not necessary active in the host.</info>
515 516
      <arg name='nodeinfo' info='virNodeInfo instance'/>
    </macro>
517 518 519 520 521 522 523 524 525
    <macro name='VIR_SECURITY_DOI_BUFLEN' file='libvirt'>
      <info>Macro providing the maximum length of the virSecurityModel doi string.</info>
    </macro>
    <macro name='VIR_SECURITY_LABEL_BUFLEN' file='libvirt'>
      <info>Macro providing the maximum length of the virSecurityLabel label string. Note that this value is based on that used by Labeled NFS.</info>
    </macro>
    <macro name='VIR_SECURITY_MODEL_BUFLEN' file='libvirt'>
      <info>Macro providing the maximum length of the virSecurityModel model string.</info>
    </macro>
526
    <macro name='VIR_UNUSE_CPU' file='libvirt'>
527
      <info>This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro reset the bit (CPU not usable) of the related cpu in cpumap.</info>
528 529 530 531
      <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'>
532
      <info>This macro is to be used in conjunction with virDomainPinVcpu() API. USE_CPU macro set the bit (CPU usable) of the related cpu in cpumap.</info>
533 534 535
      <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>
536
    <macro name='VIR_UUID_BUFLEN' file='libvirt'>
537
      <info>This macro provides the length of the buffer required for virDomainGetUUID()</info>
538 539 540 541
    </macro>
    <macro name='VIR_UUID_STRING_BUFLEN' file='libvirt'>
      <info>This macro provides the length of the buffer required for virDomainGetUUIDString()</info>
    </macro>
542 543 544 545 546 547 548 549 550 551
    <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'/>
552 553
    <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'/>
554 555 556
    <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'/>
557
    <enum name='VIR_DOMAIN_EVENT_RESUMED' file='libvirt' value='4' type='virDomainEventType'/>
558 559
    <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'/>
560
    <enum name='VIR_DOMAIN_EVENT_STARTED' file='libvirt' value='2' type='virDomainEventType'/>
561 562 563
    <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'/>
564
    <enum name='VIR_DOMAIN_EVENT_STOPPED' file='libvirt' value='5' type='virDomainEventType'/>
565 566 567 568 569 570
    <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'/>
571
    <enum name='VIR_DOMAIN_EVENT_SUSPENDED' file='libvirt' value='3' type='virDomainEventType'/>
572 573 574 575
    <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'/>
576 577 578 579
    <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'/>
580 581 582 583 584 585
    <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'/>
586 587
    <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'/>
588 589
    <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'/>
590
    <enum name='VIR_ERR_AUTH_FAILED' file='virterror' value='45' type='virErrorNumber' info='authentication failed'/>
591
    <enum name='VIR_ERR_CALL_FAILED' file='virterror' value='26' type='virErrorNumber' info='not supported by the drivers (DEPRECATED)'/>
592
    <enum name='VIR_ERR_CONF_SYNTAX' file='virterror' value='33' type='virErrorNumber' info='failed to parse the syntax of a conf file'/>
593
    <enum name='VIR_ERR_DOM_EXIST' file='virterror' value='28' type='virErrorNumber' info='the domain already exist'/>
594 595 596
    <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'/>
597
    <enum name='VIR_ERR_GNUTLS_ERROR' file='virterror' value='40' type='virErrorNumber' info='error from a GNUTLS call'/>
598 599 600 601 602
    <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 已提交
603
    <enum name='VIR_ERR_INVALID_INTERFACE' file='virterror' value='58' type='virErrorNumber' info='invalid interface object'/>
604
    <enum name='VIR_ERR_INVALID_MAC' file='virterror' value='44' type='virErrorNumber' info='invalid MAC address'/>
605
    <enum name='VIR_ERR_INVALID_NETWORK' file='virterror' value='36' type='virErrorNumber' info='invalid network object'/>
D
Daniel P. Berrange 已提交
606
    <enum name='VIR_ERR_INVALID_NODE_DEVICE' file='virterror' value='52' type='virErrorNumber' info='invalid node device object'/>
607
    <enum name='VIR_ERR_INVALID_SECRET' file='virterror' value='61' type='virErrorNumber' info=' invalid secret'/>
608 609
    <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'/>
610
    <enum name='VIR_ERR_MULTIPLE_INTERFACES' file='virterror' value='59' type='virErrorNumber' info='more than one matching interface found'/>
611
    <enum name='VIR_ERR_NETWORK_EXIST' file='virterror' value='37' type='virErrorNumber' info='the network already exist'/>
612 613 614
    <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'/>
615
    <enum name='VIR_ERR_NO_DOMAIN' file='virterror' value='42' type='virErrorNumber' info='domain not found or unexpectedly disappeared'/>
616
    <enum name='VIR_ERR_NO_INTERFACE' file='virterror' value='57' type='virErrorNumber' info='interface driver not running'/>
617 618 619
    <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'/>
620
    <enum name='VIR_ERR_NO_NETWORK' file='virterror' value='43' type='virErrorNumber' info='network not found'/>
621
    <enum name='VIR_ERR_NO_NODE_DEVICE' file='virterror' value='53' type='virErrorNumber' info='node device not found'/>
622 623
    <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'/>
624
    <enum name='VIR_ERR_NO_SECURITY_MODEL' file='virterror' value='54' type='virErrorNumber' info='security model not found'/>
625
    <enum name='VIR_ERR_NO_SOURCE' file='virterror' value='19' type='virErrorNumber' info='missing source device information'/>
626
    <enum name='VIR_ERR_NO_STORAGE_POOL' file='virterror' value='49' type='virErrorNumber' info='storage pool not found'/>
D
Daniel P. Berrange 已提交
627
    <enum name='VIR_ERR_NO_STORAGE_VOL' file='virterror' value='50' type='virErrorNumber' info='storage pool not found'/>
628
    <enum name='VIR_ERR_NO_SUPPORT' file='virterror' value='3' type='virErrorNumber' info='no support for this function'/>
629 630 631 632
    <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'/>
633 634
    <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'/>
635
    <enum name='VIR_ERR_OPERATION_FAILED' file='virterror' value='9' type='virErrorNumber' info='a command to hypervisor failed'/>
636
    <enum name='VIR_ERR_OPERATION_INVALID' file='virterror' value='55' type='virErrorNumber' info='operation is not applicable at this time'/>
637
    <enum name='VIR_ERR_OS_TYPE' file='virterror' value='16' type='virErrorNumber' info='unknown OS type'/>
638
    <enum name='VIR_ERR_PARSE_FAILED' file='virterror' value='32' type='virErrorNumber' info='failed to parse a conf file'/>
639
    <enum name='VIR_ERR_POST_FAILED' file='virterror' value='11' type='virErrorNumber' info='a HTTP POST command to failed'/>
640
    <enum name='VIR_ERR_READ_FAILED' file='virterror' value='31' type='virErrorNumber' info='failed to read a conf file'/>
641
    <enum name='VIR_ERR_RPC' file='virterror' value='39' type='virErrorNumber' info='some sort of RPC error'/>
642
    <enum name='VIR_ERR_SEXPR_SERIAL' file='virterror' value='13' type='virErrorNumber' info='failure to serialize an S-Expr'/>
643
    <enum name='VIR_ERR_SYSTEM_ERROR' file='virterror' value='38' type='virErrorNumber' info='general system call failure'/>
644 645
    <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'/>
646
    <enum name='VIR_ERR_WRITE_FAILED' file='virterror' value='34' type='virErrorNumber' info='failed to write a conf file'/>
647
    <enum name='VIR_ERR_XEN_CALL' file='virterror' value='15' type='virErrorNumber' info='failure doing an hypervisor call'/>
648
    <enum name='VIR_ERR_XML_DETAIL' file='virterror' value='35' type='virErrorNumber' info='detail of an XML error'/>
649
    <enum name='VIR_ERR_XML_ERROR' file='virterror' value='27' type='virErrorNumber' info='an XML description is not well formed or broken'/>
650 651 652 653
    <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'/>
654
    <enum name='VIR_FROM_CONF' file='virterror' value='9' type='virErrorDomain' info='Error in the configuration file handling'/>
655
    <enum name='VIR_FROM_DOM' file='virterror' value='6' type='virErrorDomain' info='Error when operating on a domain'/>
D
Daniel P. Berrange 已提交
656
    <enum name='VIR_FROM_DOMAIN' file='virterror' value='20' type='virErrorDomain' info='Error from domain config'/>
D
Daniel Veillard 已提交
657
    <enum name='VIR_FROM_ESX' file='virterror' value='28' type='virErrorDomain' info='Error from ESX driver'/>
658
    <enum name='VIR_FROM_INTERFACE' file='virterror' value='26' type='virErrorDomain' info='Error when operating on an interface'/>
D
Daniel Veillard 已提交
659
    <enum name='VIR_FROM_LXC' file='virterror' value='17' type='virErrorDomain' info='Error from Linux Container driver'/>
660
    <enum name='VIR_FROM_NET' file='virterror' value='11' type='virErrorDomain' info='Error when operating on a network'/>
661
    <enum name='VIR_FROM_NETWORK' file='virterror' value='19' type='virErrorDomain' info='Error from network config'/>
D
Daniel Veillard 已提交
662
    <enum name='VIR_FROM_NODEDEV' file='virterror' value='22' type='virErrorDomain' info='Error from node device monitor'/>
663
    <enum name='VIR_FROM_NONE' file='virterror' value='0' type='virErrorDomain'/>
D
Daniel Veillard 已提交
664
    <enum name='VIR_FROM_ONE' file='virterror' value='27' type='virErrorDomain' info='Error from OpenNebula driver'/>
R
Richard W.M. Jones 已提交
665
    <enum name='VIR_FROM_OPENVZ' file='virterror' value='14' type='virErrorDomain' info='Error from OpenVZ driver'/>
666
    <enum name='VIR_FROM_PHYP' file='virterror' value='29' type='virErrorDomain' info='Error from IBM power hypervisor'/>
667
    <enum name='VIR_FROM_PROXY' file='virterror' value='8' type='virErrorDomain' info='Error in the proxy code'/>
668
    <enum name='VIR_FROM_QEMU' file='virterror' value='10' type='virErrorDomain' info='Error at the QEMU daemon'/>
669
    <enum name='VIR_FROM_REMOTE' file='virterror' value='13' type='virErrorDomain' info='Error from remote driver'/>
670
    <enum name='VIR_FROM_RPC' file='virterror' value='7' type='virErrorDomain' info='Error in the XML-RPC code'/>
671
    <enum name='VIR_FROM_SECRET' file='virterror' value='30' type='virErrorDomain' info=' Error from secret storage'/>
672
    <enum name='VIR_FROM_SECURITY' file='virterror' value='24' type='virErrorDomain' info='Error from security framework'/>
673
    <enum name='VIR_FROM_SEXPR' file='virterror' value='4' type='virErrorDomain' info='Error in the S-Expression code'/>
674
    <enum name='VIR_FROM_STATS_LINUX' file='virterror' value='16' type='virErrorDomain' info='Error in the Linux Stats code'/>
675
    <enum name='VIR_FROM_STORAGE' file='virterror' value='18' type='virErrorDomain' info='Error from storage driver'/>
676
    <enum name='VIR_FROM_TEST' file='virterror' value='12' type='virErrorDomain' info='Error from test driver'/>
D
Daniel P. Berrange 已提交
677
    <enum name='VIR_FROM_UML' file='virterror' value='21' type='virErrorDomain' info='Error at the UML driver'/>
678
    <enum name='VIR_FROM_VBOX' file='virterror' value='25' type='virErrorDomain' info='Error from VirtualBox driver'/>
679 680 681
    <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 已提交
682
    <enum name='VIR_FROM_XENXM' file='virterror' value='15' type='virErrorDomain' info='Error at Xen XM layer'/>
683
    <enum name='VIR_FROM_XEN_INOTIFY' file='virterror' value='23' type='virErrorDomain' info='Error from xen inotify layer'/>
684
    <enum name='VIR_FROM_XML' file='virterror' value='5' type='virErrorDomain' info='Error in the XML code'/>
D
Daniel Veillard 已提交
685 686
    <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'/>
687
    <enum name='VIR_MIGRATE_LIVE' file='libvirt' value='1' type='virDomainMigrateFlags' info=' live migration'/>
688 689 690 691 692 693 694 695 696 697 698 699 700
    <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'/>
701 702 703
    <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'/>
704
    <enum name='VIR_WAR_NO_INTERFACE' file='virterror' value='56' type='virErrorNumber' info='failed to start interface driver'/>
705
    <enum name='VIR_WAR_NO_NETWORK' file='virterror' value='41' type='virErrorNumber' info='failed to start network'/>
D
Daniel P. Berrange 已提交
706
    <enum name='VIR_WAR_NO_NODE' file='virterror' value='51' type='virErrorNumber' info='failed to start node driver'/>
707
    <enum name='VIR_WAR_NO_SECRET' file='virterror' value='60' type='virErrorNumber' info='failed to start secret storage'/>
708
    <enum name='VIR_WAR_NO_STORAGE' file='virterror' value='48' type='virErrorNumber' info='failed to start storage'/>
709
    <struct name='virConnect' file='libvirt' type='struct _virConnect'/>
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
    <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'/>
728
    <typedef name='virConnectPtr' file='libvirt' type='virConnect *'>
729
      <info>a virConnectPtr is pointer to a virConnect private structure, this is the type used to reference a connection to the Hypervisor in the API.</info>
730 731
    </typedef>
    <struct name='virDomain' file='libvirt' type='struct _virDomain'/>
732 733 734 735
    <typedef name='virDomainBlockStatsPtr' file='libvirt' type='virDomainBlockStatsStruct *'>
      <info>A pointer to a virDomainBlockStats structure</info>
    </typedef>
    <struct name='virDomainBlockStatsStruct' file='libvirt' type='struct _virDomainBlockStats'>
736 737 738
      <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'/>
739
      <field name='wr_bytes' type='long long' info=' number of written bytes'/>
740 741
      <field name='errs' type='long long' info=' In Xen this returns the mysterious &apos;oo_req&apos;.'/>
    </struct>
742
    <typedef name='virDomainCreateFlags' file='libvirt' type='enum'/>
743 744 745 746 747
    <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'/>
748
    <typedef name='virDomainEventType' file='libvirt' type='enum'/>
749
    <typedef name='virDomainEventUndefinedDetailType' file='libvirt' type='enum'/>
750
    <struct name='virDomainInfo' file='libvirt' type='struct _virDomainInfo'>
751
      <field name='state' type='unsigned char' info=' the running state, one of virDomainState'/>
752 753 754 755 756 757 758 759
      <field name='maxMem' type='unsigned long' info=' the maximum memory in KBytes allowed'/>
      <field name='memory' type='unsigned long' info=' the memory in KBytes used by the domain'/>
      <field name='nrVirtCpu' type='unsigned short' info=' the number of virtual CPUs for the domain'/>
      <field name='cpuTime' type='unsigned long long' info=' the CPU time used in nanoseconds'/>
    </struct>
    <typedef name='virDomainInfoPtr' file='libvirt' type='virDomainInfo *'>
      <info>a virDomainInfoPtr is a pointer to a virDomainInfo structure.</info>
    </typedef>
760
    <typedef name='virDomainInterfaceStatsPtr' file='libvirt' type='virDomainInterfaceStatsStruct *'>
761
      <info>A pointer to a virDomainInterfaceStats structure</info>
762 763 764 765 766 767 768 769 770 771 772
    </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>
773
    <typedef name='virDomainMemoryFlags' file='libvirt' type='enum'/>
774
    <typedef name='virDomainMigrateFlags' file='libvirt' type='enum'/>
775
    <typedef name='virDomainPtr' file='libvirt' type='virDomain *'>
776
      <info>a virDomainPtr is pointer to a virDomain private structure, this is the type used to reference a domain in the API.</info>
777 778
    </typedef>
    <typedef name='virDomainState' file='libvirt' type='enum'/>
779
    <typedef name='virDomainXMLFlags' file='libvirt' type='enum'/>
780 781 782 783 784
    <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'/>
785 786 787
      <field name='conn' type='virConnectPtr' info=' connection if available, deprecated
see note above'/>
      <field name='dom' type='virDomainPtr' info=' domain if available, deprecated
788
see note above'/>
789 790 791 792 793
      <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'/>
794 795
      <field name='net' type='virNetworkPtr' info=' network if available, deprecated
see note above'/>
796 797 798 799 800
    </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 *'/>
801
    <typedef name='virEventHandleType' file='libvirt' type='enum'/>
802 803 804 805
    <struct name='virInterface' file='libvirt' type='struct _virInterface'/>
    <typedef name='virInterfacePtr' file='libvirt' type='virInterface *'>
      <info>a virInterfacePtr is pointer to a virInterface private structure, this is the type used to reference a virtual interface in the API.</info>
    </typedef>
806 807 808 809
    <struct name='virNetwork' file='libvirt' type='struct _virNetwork'/>
    <typedef name='virNetworkPtr' file='libvirt' type='virNetwork *'>
      <info>a virNetworkPtr is pointer to a virNetwork private structure, this is the type used to reference a virtual network in the API.</info>
    </typedef>
D
Daniel P. Berrange 已提交
810 811 812 813
    <struct name='virNodeDevice' file='libvirt' type='struct _virNodeDevice'/>
    <typedef name='virNodeDevicePtr' file='libvirt' type='virNodeDevice *'>
      <info>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>
    </typedef>
814 815 816 817 818 819 820 821 822 823 824 825 826
    <struct name='virNodeInfo' file='libvirt' type='struct _virNodeInfo'>
      <field name='model' type='charmodel[32]' info=' string indicating the CPU model'/>
      <field name='memory' type='unsigned long' info=' memory size in kilobytes'/>
      <field name='cpus' type='unsigned int' info=' the number of active CPUs'/>
      <field name='mhz' type='unsigned int' info=' expected CPU frequency'/>
      <field name='nodes' type='unsigned int' info=' the number of NUMA cell, 1 for uniform mem access'/>
      <field name='sockets' type='unsigned int' info=' number of CPU socket per node'/>
      <field name='cores' type='unsigned int' info=' number of core per socket'/>
      <field name='threads' type='unsigned int' info=' number of threads per core'/>
    </struct>
    <typedef name='virNodeInfoPtr' file='libvirt' type='virNodeInfo *'>
      <info>a virNodeInfoPtr is a pointer to a virNodeInfo structure.</info>
    </typedef>
827 828 829 830 831 832 833 834
    <struct name='virSchedParameter' file='libvirt' type='struct _virSchedParameter'>
      <field name='field' type='charfield[VIR_DOMAIN_SCHED_FIELD_LENGTH]' info=' parameter name'/>
      <field name='type' type='int' info=' parameter type'/>
    </struct>
    <typedef name='virSchedParameterPtr' file='libvirt' type='virSchedParameter *'>
      <info>a virSchedParameterPtr is a pointer to a virSchedParameter structure.</info>
    </typedef>
    <typedef name='virSchedParameterType' file='libvirt' type='enum'/>
835 836
    <struct name='virSecret' file='libvirt' type='struct _virSecret'/>
    <typedef name='virSecretPtr' file='libvirt' type='virSecret *'/>
837 838 839 840 841 842 843 844
    <struct name='virSecurityLabel' file='libvirt' type='struct _virSecurityLabel'/>
    <typedef name='virSecurityLabelPtr' file='libvirt' type='virSecurityLabel *'>
      <info>a virSecurityLabelPtr is a pointer to a virSecurityLabel.</info>
    </typedef>
    <struct name='virSecurityModel' file='libvirt' type='struct _virSecurityModel'/>
    <typedef name='virSecurityModelPtr' file='libvirt' type='virSecurityModel *'>
      <info>a virSecurityModelPtr is a pointer to a virSecurityModel.</info>
    </typedef>
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
    <struct name='virStoragePool' file='libvirt' type='struct _virStoragePool'/>
    <typedef name='virStoragePoolBuildFlags' file='libvirt' type='enum'/>
    <typedef name='virStoragePoolDeleteFlags' file='libvirt' type='enum'/>
    <struct name='virStoragePoolInfo' file='libvirt' type='struct _virStoragePoolInfo'>
      <field name='state' type='int' info=' virStoragePoolState flags'/>
      <field name='capacity' type='unsigned long long' info=' Logical size bytes'/>
      <field name='allocation' type='unsigned long long' info=' Current allocation bytes'/>
      <field name='available' type='unsigned long long' info=' Remaining free space bytes'/>
    </struct>
    <typedef name='virStoragePoolInfoPtr' file='libvirt' type='virStoragePoolInfo *'/>
    <typedef name='virStoragePoolPtr' file='libvirt' type='virStoragePool *'>
      <info>a virStoragePoolPtr is pointer to a virStoragePool private structure, this is the type used to reference a storage pool in the API.</info>
    </typedef>
    <typedef name='virStoragePoolState' file='libvirt' type='enum'/>
    <struct name='virStorageVol' file='libvirt' type='struct _virStorageVol'/>
    <typedef name='virStorageVolDeleteFlags' file='libvirt' type='enum'/>
    <struct name='virStorageVolInfo' file='libvirt' type='struct _virStorageVolInfo'>
      <field name='type' type='int' info=' virStorageVolType flags'/>
      <field name='capacity' type='unsigned long long' info=' Logical size bytes'/>
      <field name='allocation' type='unsigned long long' info=' Current allocation bytes'/>
    </struct>
    <typedef name='virStorageVolInfoPtr' file='libvirt' type='virStorageVolInfo *'/>
    <typedef name='virStorageVolPtr' file='libvirt' type='virStorageVol *'>
      <info>a virStorageVolPtr is pointer to a virStorageVol private structure, this is the type used to reference a storage volume in the API.</info>
    </typedef>
    <typedef name='virStorageVolType' file='libvirt' type='enum'/>
871 872 873 874 875 876 877 878
    <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'/>
879
    <variable name='virConnectAuthPtrDefault' file='libvirt' type='virConnectAuthPtr'/>
880
    <function name='virConnCopyLastError' file='virterror' module='virterror'>
881
      <info>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>
882 883 884 885 886
      <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'>
887
      <info>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>
888
      <return type='virErrorPtr' info='a pointer to the last error or NULL if none occurred.'/>
889 890 891
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
    <function name='virConnResetLastError' file='virterror' module='virterror'>
892
      <info>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>
893 894 895 896 897 898 899 900 901 902
      <return type='void'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
    <function name='virConnSetErrorFunc' file='virterror' module='virterror'>
      <info>Set a connection error handling function, if @handler is NULL it will reset to default which is to pass error back to the global library handler.</info>
      <return type='void'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='userData' type='void *' info='pointer to the user data provided in the handler callback'/>
      <arg name='handler' type='virErrorFunc' info='the function to get called in case of error or NULL'/>
    </function>
903 904 905 906 907 908 909
    <functype name='virConnectAuthCallbackPtr' file='libvirt' module='libvirt'>
      <info></info>
      <return type='int' info=''/>
      <arg name='cred' type='virConnectCredentialPtr' info=''/>
      <arg name='ncred' type='unsigned int' info=''/>
      <arg name='cbdata' type='void *' info=''/>
    </functype>
910 911 912 913 914
    <function name='virConnectClose' file='libvirt' module='libvirt'>
      <info>This function closes the connection to the Hypervisor. This should not be called if further interaction with the Hypervisor are needed especially if there is running domain which need further monitoring by the application.</info>
      <return type='int' info='0 in case of success or -1 in case of error.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
915 916 917 918 919 920
    <functype name='virConnectDomainEventCallback' file='libvirt' module='libvirt'>
      <info>A callback function to be registered, and called when a domain event occurs</info>
      <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'/>
921
      <arg name='detail' type='int' info='event specific detail information'/>
922 923 924 925 926 927 928 929 930
      <arg name='opaque' type='void *' info='opaque user data'/>
    </functype>
    <function name='virConnectDomainEventDeregister' file='libvirt' module='libvirt'>
      <info>Removes a Domain Event Callback. De-registering for a domain callback will disable delivery of this event type</info>
      <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'>
931 932
      <info>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>
      <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'/>
933 934 935
      <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 已提交
936
      <arg name='freecb' type='virFreeCallback' info='optional function to deallocate opaque when not used anymore'/>
937
    </function>
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
    <function name='virConnectDomainXMLFromNative' file='libvirt' module='libvirt'>
      <info>Reads native configuration data  describing a domain, and generates libvirt domain XML. The format of the native data is hypervisor dependant.</info>
      <return type='char *' info='a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. the caller must free() the returned value.'/>
      <arg name='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'>
      <info>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>
      <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>
954 955 956 957 958 959 960 961
    <function name='virConnectFindStoragePoolSources' file='libvirt' module='libvirt'>
      <info>Talks to a storage backend and attempts to auto-discover the set of available storage pool sources. e.g. For iSCSI this would be a set of iSCSI targets. For NFS this would be a list of exported paths.  The srcSpec (optional for some storage pool types, e.g. local ones) is an instance of the storage pool&apos;s source element specifying where to look for the pools.  srcSpec is not required for some types (e.g., those querying local storage resources only)</info>
      <return type='char *' info='an xml document consisting of a SourceList element containing a source document appropriate to the given pool type for each discovered source.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='type' type='const char *' info='type of storage pool sources to discover'/>
      <arg name='srcSpec' type='const char *' info='XML document specifying discovery source'/>
      <arg name='flags' type='unsigned int' info='flags for discovery (unused, pass 0)'/>
    </function>
962 963
    <function name='virConnectGetCapabilities' file='libvirt' module='libvirt'>
      <info>Provides capabilities of the hypervisor / driver.</info>
964
      <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.'/>
965 966
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
967 968 969 970 971
    <function name='virConnectGetHostname' file='libvirt' module='libvirt'>
      <info>This returns the system hostname on which the hypervisor is running (the result of the gethostname(2) system call).  If we are connected to a remote system, then this returns the hostname of the remote system.</info>
      <return type='char *' info='the hostname which must be freed by the caller, or NULL if there was an error.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to a hypervisor connection'/>
    </function>
972
    <function name='virConnectGetMaxVcpus' file='libvirt' module='libvirt'>
973 974
      <info>Provides the maximum number of virtual CPUs supported for a guest VM of a specific type. The &apos;type&apos; parameter here corresponds to the &apos;type&apos; attribute in the &lt;domain&gt; element of the XML.</info>
      <return type='int' info='the maximum of virtual CPU or -1 in case of error.'/>
975 976 977
      <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>
978 979
    <function name='virConnectGetType' file='libvirt' module='libvirt'>
      <info>Get the name of the Hypervisor software used.</info>
980
      <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'/>
981 982
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
983 984 985 986 987
    <function name='virConnectGetURI' file='libvirt' module='libvirt'>
      <info>This returns the URI (name) of the hypervisor connection. Normally this is the same as or similar to the string passed to the virConnectOpen/virConnectOpenReadOnly call, but the driver may make the URI canonical.  If name == NULL was passed to virConnectOpen, then the driver will return a non-NULL URI which can be used to connect to the same hypervisor later.</info>
      <return type='char *' info='the URI string which must be freed by the caller, or NULL if there was an error.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to a hypervisor connection'/>
    </function>
988
    <function name='virConnectGetVersion' file='libvirt' module='libvirt'>
989
      <info>Get the version level of the Hypervisor running. This may work only with hypervisor call, i.e. with privileged access to the hypervisor, not with a Read-Only connection.</info>
990 991 992 993 994
      <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'>
995
      <info>list the defined but inactive domains, stores the pointers to the names in @names</info>
996 997
      <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'/>
998
      <arg name='names' type='char ** const' info='pointer to an array to store the names'/>
999 1000
      <arg name='maxnames' type='int' info='size of the array'/>
    </function>
D
Daniel Veillard 已提交
1001 1002 1003 1004 1005 1006 1007
    <function name='virConnectListDefinedInterfaces' file='libvirt' module='libvirt'>
      <info>Collect the list of defined (inactive) physical host interfaces, and store their names in @names.</info>
      <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>
1008 1009 1010 1011
    <function name='virConnectListDefinedNetworks' file='libvirt' module='libvirt'>
      <info>list the inactive networks, stores the pointers to the names in @names</info>
      <return type='int' info='the number of names provided in the array or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
1012
      <arg name='names' type='char ** const' info='pointer to an array to store the names'/>
1013 1014
      <arg name='maxnames' type='int' info='size of the array'/>
    </function>
1015 1016 1017 1018 1019 1020 1021
    <function name='virConnectListDefinedStoragePools' file='libvirt' module='libvirt'>
      <info>Provides the list of names of inactive storage pools upto maxnames. If there are more than maxnames, the remaining names will be silently ignored.</info>
      <return type='int' info='0 on success, -1 on error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='names' type='char ** const' info='array of char * to fill with pool names (allocated by caller)'/>
      <arg name='maxnames' type='int' info='size of the names array'/>
    </function>
1022 1023 1024 1025 1026 1027 1028
    <function name='virConnectListDomains' file='libvirt' module='libvirt'>
      <info>Collect the list of active domains, and store their ID in @maxids</info>
      <return type='int' info='the number of domain found or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='ids' type='int *' info='array to collect the list of IDs of active domains'/>
      <arg name='maxids' type='int' info='size of @ids'/>
    </function>
1029
    <function name='virConnectListInterfaces' file='libvirt' module='libvirt'>
D
Daniel Veillard 已提交
1030
      <info>Collect the list of active physical host interfaces, and store their names in @names</info>
1031 1032 1033 1034 1035
      <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>
1036 1037 1038 1039
    <function name='virConnectListNetworks' file='libvirt' module='libvirt'>
      <info>Collect the list of active networks, and store their names in @names</info>
      <return type='int' info='the number of networks found or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
1040
      <arg name='names' type='char ** const' info='array to collect the list of names of active networks'/>
1041 1042
      <arg name='maxnames' type='int' info='size of @names'/>
    </function>
1043 1044 1045 1046 1047 1048 1049
    <function name='virConnectListSecrets' file='libvirt' module='libvirt'>
      <info>List UUIDs of defined secrets, store pointers to names in uuids.</info>
      <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>
1050 1051 1052 1053 1054 1055 1056
    <function name='virConnectListStoragePools' file='libvirt' module='libvirt'>
      <info>Provides the list of names of active storage pools upto maxnames. If there are more than maxnames, the remaining names will be silently ignored.</info>
      <return type='int' info='0 on success, -1 on error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='names' type='char ** const' info='array of char * to fill with pool names (allocated by caller)'/>
      <arg name='maxnames' type='int' info='size of the names array'/>
    </function>
1057
    <function name='virConnectNumOfDefinedDomains' file='libvirt' module='libvirt'>
1058
      <info>Provides the number of defined but inactive domains.</info>
1059 1060 1061
      <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 已提交
1062 1063 1064 1065 1066
    <function name='virConnectNumOfDefinedInterfaces' file='libvirt' module='libvirt'>
      <info>Provides the number of defined (inactive) interfaces on the physical host.</info>
      <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>
1067 1068 1069 1070 1071
    <function name='virConnectNumOfDefinedNetworks' file='libvirt' module='libvirt'>
      <info>Provides the number of inactive networks.</info>
      <return type='int' info='the number of networks found or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
1072 1073 1074 1075 1076
    <function name='virConnectNumOfDefinedStoragePools' file='libvirt' module='libvirt'>
      <info>Provides the number of inactive storage pools</info>
      <return type='int' info='the number of pools found, or -1 on error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
    </function>
1077 1078 1079 1080 1081
    <function name='virConnectNumOfDomains' file='libvirt' module='libvirt'>
      <info>Provides the number of active domains.</info>
      <return type='int' info='the number of domain found or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
1082
    <function name='virConnectNumOfInterfaces' file='libvirt' module='libvirt'>
D
Daniel Veillard 已提交
1083 1084
      <info>Provides the number of active interfaces on the physical host.</info>
      <return type='int' info='the number of active interfaces found or -1 in case of error'/>
1085 1086
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
1087 1088 1089 1090 1091
    <function name='virConnectNumOfNetworks' file='libvirt' module='libvirt'>
      <info>Provides the number of active networks.</info>
      <return type='int' info='the number of network found or -1 in case of error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
1092 1093 1094 1095 1096
    <function name='virConnectNumOfSecrets' file='libvirt' module='libvirt'>
      <info>Fetch number of currently defined secrets.</info>
      <return type='int' info='the number currently defined secrets.'/>
      <arg name='conn' type='virConnectPtr' info='virConnect connection'/>
    </function>
1097 1098 1099 1100 1101
    <function name='virConnectNumOfStoragePools' file='libvirt' module='libvirt'>
      <info>Provides the number of active storage pools</info>
      <return type='int' info='the number of pools found, or -1 on error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
    </function>
1102 1103
    <function name='virConnectOpen' file='libvirt' module='libvirt'>
      <info>This function should be called first to get a connection to the Hypervisor and xen store</info>
D
Daniel Veillard 已提交
1104
      <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'/>
1105
      <arg name='name' type='const char *' info='URI of the hypervisor'/>
1106
    </function>
1107
    <function name='virConnectOpenAuth' file='libvirt' module='libvirt'>
D
Daniel Veillard 已提交
1108
      <info>This function should be called first to get a connection to the Hypervisor. If necessary, authentication will be performed fetching credentials via the callback  See virConnectOpen for notes about environment variables which can have an effect on opening drivers</info>
1109 1110 1111 1112 1113
      <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>
1114
    <function name='virConnectOpenReadOnly' file='libvirt' module='libvirt'>
D
Daniel Veillard 已提交
1115
      <info>This function should be called first to get a restricted connection to the library functionalities. The set of APIs usable are then restricted on the available methods to control the domains.  See virConnectOpen for notes about environment variables which can have an effect on opening drivers</info>
1116 1117
      <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'/>
1118
    </function>
1119 1120
    <function name='virConnectRef' file='libvirt' module='libvirt'>
      <info>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 已提交
1121
      <return type='int' info='0 in case of success, -1 in case of failure'/>
1122 1123
      <arg name='conn' type='virConnectPtr' info='the connection to hold a reference on'/>
    </function>
1124
    <function name='virCopyLastError' file='virterror' module='virterror'>
1125
      <info>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>
1126 1127 1128 1129 1130 1131 1132 1133
      <return type='int' info='0 if no error was found and the error code otherwise and -1 in case of parameter error.'/>
      <arg name='to' type='virErrorPtr' info='target to receive the copy'/>
    </function>
    <function name='virDefaultErrorFunc' file='virterror' module='virterror'>
      <info>Default routine reporting an error to stderr.</info>
      <return type='void'/>
      <arg name='err' type='virErrorPtr' info='pointer to the error.'/>
    </function>
D
Daniel Veillard 已提交
1134 1135 1136 1137
    <function name='virDomainAttachDevice' file='libvirt' module='libvirt'>
      <info>Create a virtual device attachment to backend.</info>
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
1138
      <arg name='xml' type='const char *' info='pointer to XML description of one device'/>
D
Daniel Veillard 已提交
1139
    </function>
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
    <function name='virDomainBlockPeek' file='libvirt' module='libvirt'>
      <info>This function allows you to read the contents of a domain&apos;s disk device.  Typical uses for this are to determine if the domain has written a Master Boot Record (indicating that the domain has completed installation), or to try to work out the state of the domain&apos;s filesystems.  (Note that in the local case you might try to open the block device or file directly, but that won&apos;t work in the remote case, nor if you don&apos;t have sufficient permission. Hence the need for this call).  &apos;path&apos; must be a device or file corresponding to the domain. In other words it must be the precise string returned in a &lt;disk&gt;&lt;source dev=&apos;...&apos;/&gt;&lt;/disk&gt; from virDomainGetXMLDesc.  &apos;offset&apos; and &apos;size&apos; represent an area which must lie entirely within the device or file.  &apos;size&apos; may be 0 to test if the call would succeed.  &apos;buffer&apos; is the return buffer and must be at least &apos;size&apos; bytes.  NB. The remote driver imposes a 64K byte limit on &apos;size&apos;. For your program to be able to work reliably over a remote connection you should split large requests to &lt;= 65536 bytes.</info>
      <return type='int' info='0 in case of success or -1 in case of failure. really 64 bits'/>
      <arg name='dom' type='virDomainPtr' info='pointer to the domain object'/>
      <arg name='path' type='const char *' info='path to the block device'/>
      <arg name='offset' type='unsigned long long' info='offset within block device'/>
      <arg name='size' type='size_t' info='size to read'/>
      <arg name='buffer' type='void *' info='return buffer (must be at least size bytes)'/>
      <arg name='flags' type='unsigned int' info='unused, always pass 0'/>
    </function>
1150 1151 1152 1153 1154 1155 1156 1157
    <function name='virDomainBlockStats' file='libvirt' module='libvirt'>
      <info>This function returns block device (disk) stats for block devices attached to the domain.  The path parameter is the name of the block device.  Get this by calling virDomainGetXMLDesc and finding the &lt;target dev=&apos;...&apos;&gt; attribute within //domain/devices/disk.  (For example, &quot;xvda&quot;).  Domains may have more than one block device.  To get stats for each you should make multiple calls to this function.  Individual fields within the stats structure may be returned as -1, which indicates that the hypervisor does not support that particular statistic.</info>
      <return type='int' info='0 in case of success or -1 in case of failure.'/>
      <arg name='dom' type='virDomainPtr' info='pointer to the domain object'/>
      <arg name='path' type='const char *' info='path to the block device'/>
      <arg name='stats' type='virDomainBlockStatsPtr' info='block device stats (returned)'/>
      <arg name='size' type='size_t' info='size of stats structure'/>
    </function>
D
Daniel Veillard 已提交
1158 1159 1160 1161 1162 1163 1164
    <function name='virDomainCoreDump' file='libvirt' module='libvirt'>
      <info>This method will dump the core of a domain on a given file for analysis. Note that for remote Xen Daemon the file path will be interpreted in the remote host.</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='to' type='const char *' info='path for the core file'/>
      <arg name='flags' type='int' info='extra flags, currently unused'/>
    </function>
1165 1166 1167 1168 1169 1170
    <function name='virDomainCreate' file='libvirt' module='libvirt'>
      <info>launch a defined domain. If the call succeed the domain moves from the defined to the running domains pools.</info>
      <return type='int' info='0 in case of success, -1 in case of error'/>
      <arg name='domain' type='virDomainPtr' info='pointer to a defined domain'/>
    </function>
    <function name='virDomainCreateLinux' file='libvirt' module='libvirt'>
1171 1172 1173 1174 1175 1176 1177 1178
      <info>Deprecated after 0.4.6. Renamed to virDomainCreateXML() providing identical functionality. This existing name will left indefinitely for API compatability.</info>
      <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'>
      <info>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>
1179 1180
      <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 已提交
1181
      <arg name='xmlDesc' type='const char *' info='string containing an XML description of the domain'/>
1182
      <arg name='flags' type='unsigned int' info='callers should always pass 0'/>
1183 1184
    </function>
    <function name='virDomainDefineXML' file='libvirt' module='libvirt'>
1185
      <info>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>
1186 1187 1188 1189 1190
      <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'>
1191
      <info>Destroy the domain object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. This does not free the associated virDomainPtr object. This function may require privileged access</info>
1192 1193 1194
      <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 已提交
1195 1196 1197 1198
    <function name='virDomainDetachDevice' file='libvirt' module='libvirt'>
      <info>Destroy a virtual device attachment to backend.</info>
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
1199
      <arg name='xml' type='const char *' info='pointer to XML description of one device'/>
D
Daniel Veillard 已提交
1200
    </function>
1201 1202 1203 1204 1205
    <function name='virDomainFree' file='libvirt' module='libvirt'>
      <info>Free the domain object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
1206
    <function name='virDomainGetAutostart' file='libvirt' module='libvirt'>
1207 1208
      <info>Provides a boolean value indicating whether the domain configured to be automatically started when the host machine boots.</info>
      <return type='int' info='-1 in case of error, 0 in case of success'/>
1209
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
1210
      <arg name='autostart' type='int *' info='the value returned'/>
1211
    </function>
1212
    <function name='virDomainGetConnect' file='libvirt' module='libvirt'>
1213
      <info>Provides the connection pointer associated with a domain.  The reference counter on the connection is not increased by this call.  WARNING: When writing libvirt bindings in other languages, do not use this function.  Instead, store the connection and the domain object together.</info>
1214
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
1215 1216
      <arg name='dom' type='virDomainPtr' info='pointer to a domain'/>
    </function>
1217 1218 1219 1220 1221 1222
    <function name='virDomainGetID' file='libvirt' module='libvirt'>
      <info>Get the hypervisor ID number for the domain</info>
      <return type='unsigned int' info='the domain ID number or (unsigned int) -1 in case of error'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
    <function name='virDomainGetInfo' file='libvirt' module='libvirt'>
1223
      <info>Extract information about a domain. Note that if the connection used to get the domain is limited only a partial set of the information can be extracted.</info>
1224 1225 1226 1227 1228 1229 1230 1231 1232
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='info' type='virDomainInfoPtr' info='pointer to a virDomainInfo structure allocated by the user'/>
    </function>
    <function name='virDomainGetMaxMemory' file='libvirt' module='libvirt'>
      <info>Retrieve the maximum amount of physical memory allocated to a domain. If domain is NULL, then this get the amount of memory reserved to Domain0 i.e. the domain where the application runs.</info>
      <return type='unsigned long' info='the memory size in kilobytes or 0 in case of error.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object or NULL'/>
    </function>
1233
    <function name='virDomainGetMaxVcpus' file='libvirt' module='libvirt'>
1234 1235
      <info>Provides the maximum number of virtual CPUs supported for the guest VM. If the guest is inactive, this is basically the same as virConnectGetMaxVcpus. If the guest is running this will reflect the maximum number of virtual CPUs the guest was booted with.</info>
      <return type='int' info='the maximum of virtual CPU or -1 in case of error.'/>
1236 1237
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
    </function>
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
    <function name='virDomainGetName' file='libvirt' module='libvirt'>
      <info>Get the public name for that domain</info>
      <return type='const char *' info='a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the domain object.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
    <function name='virDomainGetOSType' file='libvirt' module='libvirt'>
      <info>Get the type of domain operation system.</info>
      <return type='char *' info='the new string or NULL in case of error, the string must be freed by the caller.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
    <function name='virDomainGetSchedulerParameters' file='libvirt' module='libvirt'>
      <info>Get the scheduler parameters, the @params array will be filled with the values.</info>
      <return type='int' info='-1 in case of error, 0 in case of success.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
      <arg name='params' type='virSchedParameterPtr' info='pointer to scheduler parameter object (return value)'/>
      <arg name='nparams' type='int *' info='pointer to number of scheduler parameter (this value should be same than the returned value nparams of virDomainGetSchedulerType)'/>
    </function>
    <function name='virDomainGetSchedulerType' file='libvirt' module='libvirt'>
      <info>Get the scheduler type.</info>
      <return type='char *' info='NULL in case of error. The caller must free the returned string.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
      <arg name='nparams' type='int *' info='number of scheduler parameters(return value)'/>
    </function>
1261
    <function name='virDomainGetSecurityLabel' file='libvirt' module='libvirt'>
1262 1263
      <info>Extract security label of an active domain. The &apos;label&apos; field in the @seclabel argument will be initialized to the empty string if the domain is not running under a security model.</info>
      <return type='int' info='0 in case of success, -1 in case of failure'/>
1264 1265 1266
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='seclabel' type='virSecurityLabelPtr' info='pointer to a virSecurityLabel structure'/>
    </function>
1267 1268 1269 1270
    <function name='virDomainGetUUID' file='libvirt' module='libvirt'>
      <info>Get the UUID for a domain</info>
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
1271
      <arg name='uuid' type='unsigned char *' info='pointer to a VIR_UUID_BUFLEN bytes array'/>
1272 1273 1274 1275 1276
    </function>
    <function name='virDomainGetUUIDString' file='libvirt' module='libvirt'>
      <info>Get the UUID for a domain as string. For more information about UUID see RFC4122.</info>
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
1277
      <arg name='buf' type='char *' info='pointer to a VIR_UUID_STRING_BUFLEN bytes array'/>
1278
    </function>
1279
    <function name='virDomainGetVcpus' file='libvirt' module='libvirt'>
D
Daniel Veillard 已提交
1280
      <info>Extract information about virtual CPUs of domain, store it in info array and also in cpumaps if this pointer isn&apos;t NULL.</info>
1281 1282 1283 1284
      <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 已提交
1285
      <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.'/>
1286 1287
      <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>
1288
    <function name='virDomainGetXMLDesc' file='libvirt' module='libvirt'>
1289
      <info>Provide an XML description of the domain. The description may be reused later to relaunch the domain with virDomainCreateXML().</info>
1290 1291
      <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'/>
1292
      <arg name='flags' type='int' info='an OR&apos;ed set of virDomainXMLFlags'/>
1293
    </function>
1294 1295 1296 1297 1298 1299 1300 1301
    <function name='virDomainInterfaceStats' file='libvirt' module='libvirt'>
      <info>This function returns network interface stats for interfaces attached to the domain.  The path parameter is the name of the network interface.  Domains may have more than network interface.  To get stats for each you should make multiple calls to this function.  Individual fields within the stats structure may be returned as -1, which indicates that the hypervisor does not support that particular statistic.</info>
      <return type='int' info='0 in case of success or -1 in case of failure.'/>
      <arg name='dom' type='virDomainPtr' info='pointer to the domain object'/>
      <arg name='path' type='const char *' info='path to the interface'/>
      <arg name='stats' type='virDomainInterfaceStatsPtr' info='network interface stats (returned)'/>
      <arg name='size' type='size_t' info='size of stats structure'/>
    </function>
1302
    <function name='virDomainLookupByID' file='libvirt' module='libvirt'>
1303
      <info>Try to find a domain based on the hypervisor ID number Note that this won&apos;t work for inactive domains which have an ID of -1, in that case a lookup based on the Name or UUId need to be done instead.</info>
1304
      <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.'/>
1305 1306 1307 1308 1309
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='id' type='int' info='the domain ID number'/>
    </function>
    <function name='virDomainLookupByName' file='libvirt' module='libvirt'>
      <info>Try to lookup a domain on the given hypervisor based on its name.</info>
1310
      <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.'/>
1311 1312 1313 1314 1315
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='name' type='const char *' info='name for the domain'/>
    </function>
    <function name='virDomainLookupByUUID' file='libvirt' module='libvirt'>
      <info>Try to lookup a domain on the given hypervisor based on its UUID.</info>
1316
      <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.'/>
1317 1318 1319 1320 1321
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='uuid' type='const unsigned char *' info='the raw UUID for the domain'/>
    </function>
    <function name='virDomainLookupByUUIDString' file='libvirt' module='libvirt'>
      <info>Try to lookup a domain on the given hypervisor based on its UUID.</info>
1322
      <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.'/>
1323 1324 1325
      <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>
1326 1327 1328 1329 1330 1331 1332 1333 1334
    <function name='virDomainMemoryPeek' file='libvirt' module='libvirt'>
      <info>This function allows you to read the contents of a domain&apos;s memory.  The memory which is read is controlled by the &apos;start&apos;, &apos;size&apos; and &apos;flags&apos; parameters.  If &apos;flags&apos; is VIR_MEMORY_VIRTUAL then the &apos;start&apos; and &apos;size&apos; parameters are interpreted as virtual memory addresses for whichever task happens to be running on the domain at the moment.  Although this sounds haphazard it is in fact what you want in order to read Linux kernel state, because it ensures that pointers in the kernel image can be interpreted coherently.  &apos;buffer&apos; is the return buffer and must be at least &apos;size&apos; bytes. &apos;size&apos; may be 0 to test if the call would succeed.  NB. The remote driver imposes a 64K byte limit on &apos;size&apos;. For your program to be able to work reliably over a remote connection you should split large requests to &lt;= 65536 bytes.</info>
      <return type='int' info='0 in case of success or -1 in case of failure. really 64 bits'/>
      <arg name='dom' type='virDomainPtr' info='pointer to the domain object'/>
      <arg name='start' type='unsigned long long' info='start of memory to peek'/>
      <arg name='size' type='size_t' info='size of memory to peek'/>
      <arg name='buffer' type='void *' info='return buffer (must be at least size bytes)'/>
      <arg name='flags' type='unsigned int' info='flags, see below'/>
    </function>
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344
    <function name='virDomainMigrate' file='libvirt' module='libvirt'>
      <info>Migrate the domain object from its current host to the destination host given by dconn (a connection to the destination host).  Flags may be one of more of the following: VIR_MIGRATE_LIVE   Attempt a live migration.  If a hypervisor supports renaming domains during migration, then you may set the dname parameter to the new name (otherwise it keeps the same name).  If this is not supported by the hypervisor, dname must be NULL or else you will get an error.  Since typically the two hypervisors connect directly to each other in order to perform the migration, you may need to specify a path from the source to the destination.  This is the purpose of the uri parameter.  If uri is NULL, then libvirt will try to find the best method.  Uri may specify the hostname or IP address of the destination host as seen from the source.  Or uri may be a URI giving transport, hostname, user, port, etc. in the usual form.  Refer to driver documentation for the particular URIs supported.  The maximum bandwidth (in Mbps) that will be used to do migration can be specified with the bandwidth parameter.  If set to 0, libvirt will choose a suitable default.  Some hypervisors do not support this feature and will return an error if bandwidth is not 0.  To see which features are supported by the current hypervisor, see virConnectGetCapabilities, /capabilities/host/migration_features.  There are many limitations on migration imposed by the underlying technology - for example it may not be possible to migrate between different processors even with the same architecture, or between different types of hypervisor.</info>
      <return type='virDomainPtr' info='the new domain object if the migration was successful, or NULL in case of error.  Note that the new domain object exists in the scope of the destination connection (dconn).'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='dconn' type='virConnectPtr' info='destination host (a connection object)'/>
      <arg name='flags' type='unsigned long' info='flags'/>
      <arg name='dname' type='const char *' info='(optional) rename domain to this at destination'/>
      <arg name='uri' type='const char *' info='(optional) dest hostname/URI as seen from the source host'/>
      <arg name='bandwidth' type='unsigned long' info='(optional) specify migration bandwidth limit in Mbps'/>
    </function>
1345
    <function name='virDomainPinVcpu' file='libvirt' module='libvirt'>
1346
      <info>Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires privileged access to the hypervisor.</info>
1347 1348 1349 1350 1351 1352
      <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>
1353 1354 1355 1356 1357 1358
    <function name='virDomainReboot' file='libvirt' module='libvirt'>
      <info>Reboot a domain, the domain object is still usable there after but the domain OS is being stopped for a restart. Note that the guest OS may ignore the request.</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='flags' type='unsigned int' info='extra flags for the reboot operation, not used yet'/>
    </function>
1359 1360
    <function name='virDomainRef' file='libvirt' module='libvirt'>
      <info>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 已提交
1361 1362
      <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'/>
1363
    </function>
1364 1365 1366 1367 1368 1369 1370
    <function name='virDomainRestore' file='libvirt' module='libvirt'>
      <info>This method will restore a domain saved to disk by virDomainSave().</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='from' type='const char *' info='path to the'/>
    </function>
    <function name='virDomainResume' file='libvirt' module='libvirt'>
1371
      <info>Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires privileged access</info>
1372 1373 1374 1375 1376 1377 1378 1379 1380
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
    <function name='virDomainSave' file='libvirt' module='libvirt'>
      <info>This method will suspend a domain and save its memory contents to a file on disk. After the call, if successful, the domain is not listed as running anymore (this may be a problem). Use virDomainRestore() to restore a domain after saving.</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='to' type='const char *' info='path for the output file'/>
    </function>
1381 1382 1383 1384
    <function name='virDomainSetAutostart' file='libvirt' module='libvirt'>
      <info>Configure the domain to be automatically started when the host machine boots.</info>
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
1385
      <arg name='autostart' type='int' info='whether the domain should be automatically started 0 or 1'/>
1386
    </function>
1387
    <function name='virDomainSetMaxMemory' file='libvirt' module='libvirt'>
1388
      <info>Dynamically change the maximum amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function requires privileged access to the hypervisor.</info>
1389 1390 1391 1392 1393
      <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'>
1394
      <info>Dynamically change the target amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs. This function may requires privileged access to the hypervisor.</info>
1395 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 or NULL'/>
      <arg name='memory' type='unsigned long' info='the memory size in kilobytes'/>
    </function>
1399 1400 1401 1402 1403 1404 1405
    <function name='virDomainSetSchedulerParameters' file='libvirt' module='libvirt'>
      <info>Change the scheduler parameters</info>
      <return type='int' info='-1 in case of error, 0 in case of success.'/>
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
      <arg name='params' type='virSchedParameterPtr' info='pointer to scheduler parameter objects'/>
      <arg name='nparams' type='int' info='number of scheduler parameter (this value should be same or less than the returned value nparams of virDomainGetSchedulerType)'/>
    </function>
1406
    <function name='virDomainSetVcpus' file='libvirt' module='libvirt'>
1407
      <info>Dynamically change the number of virtual CPUs used by the domain. Note that this call may fail if the underlying virtualization hypervisor does not support it or if growing the number is arbitrary limited. This function requires privileged access to the hypervisor.</info>
1408 1409 1410 1411
      <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>
1412 1413 1414 1415 1416 1417
    <function name='virDomainShutdown' file='libvirt' module='libvirt'>
      <info>Shutdown a domain, the domain object is still usable there after but the domain OS is being stopped. Note that the guest OS may ignore the request.  TODO: should we add an option for reboot, knowing it may not be doable in the general case ?</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
    </function>
    <function name='virDomainSuspend' file='libvirt' module='libvirt'>
1418
      <info>Suspends an active domain, the process is frozen without further access to CPU resources and I/O but the memory used by the domain at the hypervisor level will stay allocated. Use virDomainResume() to reactivate the domain. This function may requires privileged access.</info>
1419 1420 1421 1422
      <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'>
1423
      <info>Undefine a domain but does not stop it if it is running</info>
1424 1425 1426 1427 1428 1429 1430 1431 1432
      <return type='int' info='0 in case of success, -1 in case of error'/>
      <arg name='domain' type='virDomainPtr' info='pointer to a defined domain'/>
    </function>
    <functype name='virErrorFunc' file='virterror' module='virterror'>
      <info>Signature of a function to use when there is an error raised by the library.</info>
      <return type='void'/>
      <arg name='userData' type='void *' info='user provided data for the error callback'/>
      <arg name='error' type='virErrorPtr' info='the error being raised.'/>
    </functype>
1433
    <functype name='virEventAddHandleFunc' file='libvirt' module='libvirt'>
D
Daniel P. Berrange 已提交
1434 1435
      <info>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&apos;ing when the handle is unregistered, then a 2nd callback can be supplied for this purpose.</info>
      <return type='int' info='a handle watch number to be used for updating and unregistering for events'/>
1436 1437
      <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 已提交
1438
      <arg name='cb' type='virEventHandleCallback' info='the callback to be called when an event occurrs'/>
1439
      <arg name='opaque' type='void *' info='user data to pass to the callback'/>
D
Daniel P. Berrange 已提交
1440
      <arg name='ff' type='virFreeCallback' info='the callback invoked to free opaque data blob'/>
1441 1442
    </functype>
    <functype name='virEventAddTimeoutFunc' file='libvirt' module='libvirt'>
D
Daniel P. Berrange 已提交
1443
      <info>Part of the EventImpl, this user-defined callback handles adding an event timeout.  If the opaque user data requires free&apos;ing when the handle is unregistered, then a 2nd callback can be supplied for this purpose.</info>
1444 1445 1446 1447
      <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 已提交
1448
      <arg name='ff' type='virFreeCallback' info='the callback invoked to free opaque data blob'/>
1449 1450
    </functype>
    <functype name='virEventHandleCallback' file='libvirt' module='libvirt'>
D
Daniel P. Berrange 已提交
1451
      <info>Callback for receiving file handle events. The callback will be invoked once for each event which is pending.</info>
1452
      <return type='void'/>
D
Daniel P. Berrange 已提交
1453
      <arg name='watch' type='int' info='watch on which the event occurred'/>
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468
      <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'>
      <info></info>
      <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'>
D
Daniel P. Berrange 已提交
1469
      <info>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>
1470
      <return type='int' info=''/>
D
Daniel P. Berrange 已提交
1471
      <arg name='watch' type='int' info='file descriptor watch to stop listening on'/>
1472 1473
    </functype>
    <functype name='virEventRemoveTimeoutFunc' file='libvirt' module='libvirt'>
D
Daniel P. Berrange 已提交
1474
      <info>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>
1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486
      <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'>
      <info>callback for receiving timer events</info>
      <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'>
      <info>Part of the EventImpl, this user-provided callback is notified when events to listen on change</info>
      <return type='void'/>
D
Daniel P. Berrange 已提交
1487
      <arg name='watch' type='int' info='file descriptor watch to modify'/>
1488 1489 1490 1491 1492 1493 1494 1495
      <arg name='event' type='int' info='new events to listen on'/>
    </functype>
    <functype name='virEventUpdateTimeoutFunc' file='libvirt' module='libvirt'>
      <info>Part of the EventImpl, this user-defined callback updates an event timeout.</info>
      <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 已提交
1496 1497 1498 1499 1500
    <functype name='virFreeCallback' file='libvirt' module='libvirt'>
      <info></info>
      <return type='void'/>
      <arg name='opaque' type='void *' info=''/>
    </functype>
1501 1502 1503 1504 1505
    <function name='virFreeError' file='virterror' module='virterror'>
      <info>Resets and frees the given error.</info>
      <return type='void'/>
      <arg name='err' type='virErrorPtr' info='error to free'/>
    </function>
1506
    <function name='virGetLastError' file='virterror' module='virterror'>
1507
      <info>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>
1508
      <return type='virErrorPtr' info='a pointer to the last error or NULL if none occurred.'/>
1509 1510
    </function>
    <function name='virGetVersion' file='libvirt' module='libvirt'>
D
Daniel Veillard 已提交
1511
      <info>Provides two information back, @libVer is the version of the library while @typeVer will be the version of the hypervisor type @type against which the library was compiled. If @type is NULL, &quot;Xen&quot; is assumed, if @type is unknown or not available, an error code will be returned and @typeVer will be 0.</info>
1512 1513 1514 1515 1516 1517 1518 1519 1520
      <return type='int' info='-1 in case of failure, 0 otherwise, and values for @libVer and @typeVer have the format major * 1,000,000 + minor * 1,000 + release.'/>
      <arg name='libVer' type='unsigned long *' info='return value for the library version (OUT)'/>
      <arg name='type' type='const char *' info='the type of connection/driver looked at'/>
      <arg name='typeVer' type='unsigned long *' info='return value for the version of the hypervisor (OUT)'/>
    </function>
    <function name='virInitialize' file='libvirt' module='libvirt'>
      <info>Initialize the library. It&apos;s better to call this routine at startup in multithreaded applications to avoid potential race when initializing the library.</info>
      <return type='int' info='0 in case of success, -1 in case of error'/>
    </function>
1521 1522 1523
    <function name='virInterfaceCreate' file='libvirt' module='libvirt'>
      <info>Activate an interface (ie call &quot;ifup&quot;)</info>
      <return type='int' info='0 in case of success, -1 in case of error'/>
1524
      <arg name='iface' type='virInterfacePtr' info='pointer to a defined interface'/>
1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536
      <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'>
      <info>Define an interface (or modify existing interface configuration)</info>
      <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'>
      <info>deactivate an interface (ie call &quot;ifdown&quot;) This does not remove the interface from the config, and does not free the associated virInterfacePtr object.</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
1537
      <arg name='iface' type='virInterfacePtr' info='an interface object'/>
1538 1539 1540 1541 1542
      <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'>
      <info>Free the interface object. The interface itself is unaltered. The data structure is freed and should not be used thereafter.</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
1543
      <arg name='iface' type='virInterfacePtr' info='a interface object'/>
1544 1545 1546 1547
    </function>
    <function name='virInterfaceGetConnect' file='libvirt' module='libvirt'>
      <info>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>
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
D
Daniel Veillard 已提交
1548
      <arg name='iface' type='virInterfacePtr' info='pointer to a interface'/>
1549 1550 1551 1552
    </function>
    <function name='virInterfaceGetMACString' file='libvirt' module='libvirt'>
      <info>Get the MAC for a interface as string. For more information about MAC see RFC4122.</info>
      <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.'/>
1553
      <arg name='iface' type='virInterfacePtr' info='a interface object'/>
1554 1555 1556 1557
    </function>
    <function name='virInterfaceGetName' file='libvirt' module='libvirt'>
      <info>Get the public name for that interface</info>
      <return type='const char *' info='a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the interface object.'/>
1558
      <arg name='iface' type='virInterfacePtr' info='a interface object'/>
1559 1560 1561 1562
    </function>
    <function name='virInterfaceGetXMLDesc' file='libvirt' module='libvirt'>
      <info>Provide an XML description of the interface. The description may be reused later to recreate the interface with virInterfaceCreateXML().</info>
      <return type='char *' info='a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. the caller must free() the returned value.'/>
1563
      <arg name='iface' type='virInterfacePtr' info='a interface object'/>
1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580
      <arg name='flags' type='unsigned int' info='and OR&apos;ed set of extraction flags, not used yet'/>
    </function>
    <function name='virInterfaceLookupByMACString' file='libvirt' module='libvirt'>
      <info>Try to lookup an interface on the given hypervisor based on its MAC.</info>
      <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'>
      <info>Try to lookup an interface on the given hypervisor based on its name.</info>
      <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'>
      <info>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 a interface would increment the reference count.</info>
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
1581
      <arg name='iface' type='virInterfacePtr' info='the interface to hold a reference on'/>
1582 1583 1584 1585
    </function>
    <function name='virInterfaceUndefine' file='libvirt' module='libvirt'>
      <info>Undefine an interface, ie remove it from the config. This does not free the associated virInterfacePtr object.</info>
      <return type='int' info='0 in case of success, -1 in case of error'/>
1586
      <arg name='iface' type='virInterfacePtr' info='pointer to a defined interface'/>
1587
    </function>
1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605
    <function name='virNetworkCreate' file='libvirt' module='libvirt'>
      <info>Create and start a defined network. If the call succeed the network moves from the defined to the running networks pools.</info>
      <return type='int' info='0 in case of success, -1 in case of error'/>
      <arg name='network' type='virNetworkPtr' info='pointer to a defined network'/>
    </function>
    <function name='virNetworkCreateXML' file='libvirt' module='libvirt'>
      <info>Create and start a new virtual network, based on an XML description similar to the one returned by virNetworkGetXMLDesc()</info>
      <return type='virNetworkPtr' info='a new network object or NULL in case of failure'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='xmlDesc' type='const char *' info='an XML description of the network'/>
    </function>
    <function name='virNetworkDefineXML' file='libvirt' module='libvirt'>
      <info>Define a network, but does not create it</info>
      <return type='virNetworkPtr' info='NULL in case of error, a pointer to the network otherwise'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='xml' type='const char *' info='the XML description for the network, preferably in UTF-8'/>
    </function>
    <function name='virNetworkDestroy' file='libvirt' module='libvirt'>
1606
      <info>Destroy the network object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. This does not free the associated virNetworkPtr object. This function may require privileged access</info>
1607 1608 1609 1610 1611 1612 1613 1614
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='network' type='virNetworkPtr' info='a network object'/>
    </function>
    <function name='virNetworkFree' file='libvirt' module='libvirt'>
      <info>Free the network object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='network' type='virNetworkPtr' info='a network object'/>
    </function>
1615
    <function name='virNetworkGetAutostart' file='libvirt' module='libvirt'>
1616 1617
      <info>Provides a boolean value indicating whether the network configured to be automatically started when the host machine boots.</info>
      <return type='int' info='-1 in case of error, 0 in case of success'/>
1618
      <arg name='network' type='virNetworkPtr' info='a network object'/>
1619
      <arg name='autostart' type='int *' info='the value returned'/>
1620
    </function>
1621
    <function name='virNetworkGetBridgeName' file='libvirt' module='libvirt'>
1622 1623
      <info>Provides a bridge interface name to which a domain may connect a network interface in order to join the network.</info>
      <return type='char *' info='a 0 terminated interface name, or NULL in case of error. the caller must free() the returned value.'/>
1624 1625
      <arg name='network' type='virNetworkPtr' info='a network object'/>
    </function>
1626
    <function name='virNetworkGetConnect' file='libvirt' module='libvirt'>
1627
      <info>Provides the connection pointer associated with a network.  The reference counter on the connection is not increased by this call.  WARNING: When writing libvirt bindings in other languages, do not use this function.  Instead, store the connection and the network object together.</info>
1628
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
1629 1630
      <arg name='net' type='virNetworkPtr' info='pointer to a network'/>
    </function>
1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655
    <function name='virNetworkGetName' file='libvirt' module='libvirt'>
      <info>Get the public name for that network</info>
      <return type='const char *' info='a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the network object.'/>
      <arg name='network' type='virNetworkPtr' info='a network object'/>
    </function>
    <function name='virNetworkGetUUID' file='libvirt' module='libvirt'>
      <info>Get the UUID for a network</info>
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='network' type='virNetworkPtr' info='a network object'/>
      <arg name='uuid' type='unsigned char *' info='pointer to a VIR_UUID_BUFLEN bytes array'/>
    </function>
    <function name='virNetworkGetUUIDString' file='libvirt' module='libvirt'>
      <info>Get the UUID for a network as string. For more information about UUID see RFC4122.</info>
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='network' type='virNetworkPtr' info='a network object'/>
      <arg name='buf' type='char *' info='pointer to a VIR_UUID_STRING_BUFLEN bytes array'/>
    </function>
    <function name='virNetworkGetXMLDesc' file='libvirt' module='libvirt'>
      <info>Provide an XML description of the network. The description may be reused later to relaunch the network with virNetworkCreateXML().</info>
      <return type='char *' info='a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. the caller must free() the returned value.'/>
      <arg name='network' type='virNetworkPtr' info='a network object'/>
      <arg name='flags' type='int' info='and OR&apos;ed set of extraction flags, not used yet'/>
    </function>
    <function name='virNetworkLookupByName' file='libvirt' module='libvirt'>
      <info>Try to lookup a network on the given hypervisor based on its name.</info>
1656
      <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.'/>
1657 1658 1659 1660 1661
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='name' type='const char *' info='name for the network'/>
    </function>
    <function name='virNetworkLookupByUUID' file='libvirt' module='libvirt'>
      <info>Try to lookup a network on the given hypervisor based on its UUID.</info>
1662
      <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.'/>
1663 1664 1665 1666 1667
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='uuid' type='const unsigned char *' info='the raw UUID for the network'/>
    </function>
    <function name='virNetworkLookupByUUIDString' file='libvirt' module='libvirt'>
      <info>Try to lookup a network on the given hypervisor based on its UUID.</info>
1668
      <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.'/>
1669 1670 1671
      <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>
1672 1673
    <function name='virNetworkRef' file='libvirt' module='libvirt'>
      <info>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 已提交
1674 1675
      <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'/>
1676
    </function>
1677 1678 1679 1680
    <function name='virNetworkSetAutostart' file='libvirt' module='libvirt'>
      <info>Configure the network to be automatically started when the host machine boots.</info>
      <return type='int' info='-1 in case of error, 0 in case of success'/>
      <arg name='network' type='virNetworkPtr' info='a network object'/>
1681
      <arg name='autostart' type='int' info='whether the network should be automatically started 0 or 1'/>
1682
    </function>
1683 1684 1685 1686 1687
    <function name='virNetworkUndefine' file='libvirt' module='libvirt'>
      <info>Undefine a network but does not stop it if it is running</info>
      <return type='int' info='0 in case of success, -1 in case of error'/>
      <arg name='network' type='virNetworkPtr' info='pointer to a defined network'/>
    </function>
D
Daniel Veillard 已提交
1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699
    <function name='virNodeDeviceCreateXML' file='libvirt' module='libvirt'>
      <info>Create a new device on the VM host machine, for example, virtual HBAs created using vport_create.</info>
      <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'>
      <info>Destroy the device object. The virtual device is removed from the host operating system. This function may require privileged access</info>
      <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>
1700
    <function name='virNodeDeviceDettach' file='libvirt' module='libvirt'>
D
Daniel Veillard 已提交
1701 1702 1703
      <info>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>
      <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'/>
1704
    </function>
D
Daniel P. Berrange 已提交
1705 1706 1707 1708 1709 1710
    <function name='virNodeDeviceFree' file='libvirt' module='libvirt'>
      <info>Drops a reference to the node device, freeing it if this was the last reference.</info>
      <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'>
D
Daniel Veillard 已提交
1711 1712
      <info>Just return the device name</info>
      <return type='const char *' info='the device name or NULL in case of error'/>
D
Daniel P. Berrange 已提交
1713 1714 1715
      <arg name='dev' type='virNodeDevicePtr' info='the device'/>
    </function>
    <function name='virNodeDeviceGetParent' file='libvirt' module='libvirt'>
D
Daniel Veillard 已提交
1716
      <info>Accessor for the parent of the device</info>
D
Daniel P. Berrange 已提交
1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739
      <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'>
      <info>Fetch an XML document describing all aspects of the device.</info>
      <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'>
      <info>Lists the names of the capabilities supported by the device.</info>
      <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'>
      <info>Lookup a node device by its name.</info>
      <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'>
D
Daniel Veillard 已提交
1740
      <info>Accessor for the number of capabilities supported by the device.</info>
D
Daniel P. Berrange 已提交
1741 1742 1743
      <return type='int' info='the number of capabilities supported by the device.'/>
      <arg name='dev' type='virNodeDevicePtr' info='the device'/>
    </function>
1744 1745
    <function name='virNodeDeviceReAttach' file='libvirt' module='libvirt'>
      <info>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 已提交
1746
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
1747 1748
      <arg name='dev' type='virNodeDevicePtr' info='pointer to the node device'/>
    </function>
1749 1750
    <function name='virNodeDeviceRef' file='libvirt' module='libvirt'>
      <info>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 已提交
1751 1752
      <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'/>
1753
    </function>
1754 1755
    <function name='virNodeDeviceReset' file='libvirt' module='libvirt'>
      <info>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 已提交
1756
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
1757 1758
      <arg name='dev' type='virNodeDevicePtr' info='pointer to the node device'/>
    </function>
1759
    <function name='virNodeGetCellsFreeMemory' file='libvirt' module='libvirt'>
1760
      <info>This call returns the amount of free memory in one or more NUMA cells. The @freeMems array must be allocated by the caller and will be filled with the amount of free memory in 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>
1761 1762 1763 1764 1765 1766
      <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>
1767
    <function name='virNodeGetFreeMemory' file='libvirt' module='libvirt'>
1768 1769
      <info>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>
      <return type='unsigned long long' info='the available free memory in bytes or 0 in case of error'/>
1770 1771
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
1772 1773 1774 1775 1776 1777
    <function name='virNodeGetInfo' file='libvirt' module='libvirt'>
      <info>Extract hardware information about the node.</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='info' type='virNodeInfoPtr' info='pointer to a virNodeInfo structure allocated by the user'/>
    </function>
1778
    <function name='virNodeGetSecurityModel' file='libvirt' module='libvirt'>
1779 1780
      <info>Extract the security model of a hypervisor. The &apos;model&apos; field in the @secmodel argument may be initialized to the empty string if the driver has not activated a security model.</info>
      <return type='int' info='0 in case of success, -1 in case of failure'/>
1781 1782 1783
      <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 已提交
1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799
    <function name='virNodeListDevices' file='libvirt' module='libvirt'>
      <info>Collect the list of node devices, and store their names in @names  If the optional &apos;cap&apos;  argument is non-NULL, then the count will be restricted to devices with the specified capability</info>
      <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'>
      <info>Provides the number of node devices.  If the optional &apos;cap&apos;  argument is non-NULL, then the count will be restricted to devices with the specified capability</info>
      <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>
1800 1801 1802 1803 1804 1805
    <function name='virResetError' file='virterror' module='virterror'>
      <info>Reset the error being pointed to</info>
      <return type='void'/>
      <arg name='err' type='virErrorPtr' info='pointer to the virError to clean up'/>
    </function>
    <function name='virResetLastError' file='virterror' module='virterror'>
1806
      <info>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>
1807 1808
      <return type='void'/>
    </function>
1809 1810 1811 1812
    <function name='virSaveLastError' file='virterror' module='virterror'>
      <info>Save the last error into a new error object.</info>
      <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>
1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871
    <function name='virSecretDefineXML' file='libvirt' module='libvirt'>
      <info>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>
      <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'>
      <info>Release the secret handle. The underlying secret continues to exist.</info>
      <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'>
      <info>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>
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
      <arg name='secret' type='virSecretPtr' info='A virSecret secret'/>
    </function>
    <function name='virSecretGetUUIDString' file='libvirt' module='libvirt'>
      <info>Fetches the UUID of the secret.</info>
      <return type='char *' info='ID of the secret (not necessarily in the UUID format) on success, NULL on failure.  The caller must free() the ID.'/>
      <arg name='secret' type='virSecretPtr' info='A virSecret secret'/>
    </function>
    <function name='virSecretGetValue' file='libvirt' module='libvirt'>
      <info>Fetches the value of a secret.</info>
      <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'>
      <info>Fetches an XML document describing attributes of the secret.</info>
      <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>
    <function name='virSecretLookupByUUIDString' file='libvirt' module='libvirt'>
      <info>Fetches a secret based on uuid.</info>
      <return type='virSecretPtr' info='the secret on success, or NULL on failure.'/>
      <arg name='conn' type='virConnectPtr' info='virConnect connection'/>
      <arg name='uuid' type='const char *' info='ID of a secret'/>
    </function>
    <function name='virSecretRef' file='libvirt' module='libvirt'>
      <info>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>
      <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'>
      <info>Sets the value of a secret.</info>
      <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'>
      <info>Deletes the specified secret.  This does not free the associated virSecretPtr object.</info>
      <return type='int' info='0 on success, -1 on failure.'/>
      <arg name='secret' type='virSecretPtr' info='A virSecret secret'/>
    </function>
1872 1873 1874 1875 1876 1877
    <function name='virSetErrorFunc' file='virterror' module='virterror'>
      <info>Set a library global error handling function, if @handler is NULL, it will reset to default printing on stderr. The error raised there are those for which no handler at the connection level could caught.</info>
      <return type='void'/>
      <arg name='userData' type='void *' info='pointer to the user data provided in the handler callback'/>
      <arg name='handler' type='virErrorFunc' info='the function to get called in case of error or NULL'/>
    </function>
1878 1879 1880 1881
    <function name='virStoragePoolBuild' file='libvirt' module='libvirt'>
      <info>Build the underlying storage pool</info>
      <return type='int' info='0 on success, or -1 upon failure'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
1882
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
1883 1884 1885 1886 1887
    </function>
    <function name='virStoragePoolCreate' file='libvirt' module='libvirt'>
      <info>Starts an inactive storage pool</info>
      <return type='int' info='0 on success, or -1 if it could not be started'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
1888
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
1889 1890
    </function>
    <function name='virStoragePoolCreateXML' file='libvirt' module='libvirt'>
D
Daniel Veillard 已提交
1891
      <info>Create a new storage based on its XML description. The pool is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted</info>
1892 1893 1894
      <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'/>
1895
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
1896 1897
    </function>
    <function name='virStoragePoolDefineXML' file='libvirt' module='libvirt'>
D
Daniel Veillard 已提交
1898
      <info>Define a new inactive storage pool based on its XML description. The pool is persistent, until explicitly undefined.</info>
1899 1900 1901
      <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'/>
1902
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928
    </function>
    <function name='virStoragePoolDelete' file='libvirt' module='libvirt'>
      <info>Delete the underlying pool resources. This is a non-recoverable operation. The virStoragePoolPtr object itself is not free&apos;d.</info>
      <return type='int' info='0 on success, or -1 if it could not be obliterate'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='flags' type='unsigned int' info='flags for obliteration process'/>
    </function>
    <function name='virStoragePoolDestroy' file='libvirt' module='libvirt'>
      <info>Destroy an active storage pool. This will deactivate the pool on the host, but keep any persistent config associated with it. If it has a persistent config it can later be restarted with virStoragePoolCreate(). This does not free the associated virStoragePoolPtr object.</info>
      <return type='int' info='0 on success, or -1 if it could not be destroyed'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
    </function>
    <function name='virStoragePoolFree' file='libvirt' module='libvirt'>
      <info>Free a storage pool object, releasing all memory associated with it. Does not change the state of the pool on the host.</info>
      <return type='int' info='0 on success, or -1 if it could not be free&apos;d.'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
    </function>
    <function name='virStoragePoolGetAutostart' file='libvirt' module='libvirt'>
      <info>Fetches the value of the autostart flag, which determines whether the pool is automatically started at boot time</info>
      <return type='int' info='0 on success, -1 on failure'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='autostart' type='int *' info='location in which to store autostart flag'/>
    </function>
    <function name='virStoragePoolGetConnect' file='libvirt' module='libvirt'>
      <info>Provides the connection pointer associated with a storage pool.  The reference counter on the connection is not increased by this call.  WARNING: When writing libvirt bindings in other languages, do not use this function.  Instead, store the connection and the pool object together.</info>
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
1929
      <arg name='pool' type='virStoragePoolPtr' info='pointer to a pool'/>
1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957
    </function>
    <function name='virStoragePoolGetInfo' file='libvirt' module='libvirt'>
      <info>Get volatile information about the storage pool such as free space / usage summary</info>
      <return type='int' info='0 on success, or -1 on failure.'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='info' type='virStoragePoolInfoPtr' info='pointer at which to store info'/>
    </function>
    <function name='virStoragePoolGetName' file='libvirt' module='libvirt'>
      <info>Fetch the locally unique name of the storage pool</info>
      <return type='const char *' info='the name of the pool, or NULL on error'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
    </function>
    <function name='virStoragePoolGetUUID' file='libvirt' module='libvirt'>
      <info>Fetch the globally unique ID of the storage pool</info>
      <return type='int' info='0 on success, or -1 on error;'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='uuid' type='unsigned char *' info='buffer of VIR_UUID_BUFLEN bytes in size'/>
    </function>
    <function name='virStoragePoolGetUUIDString' file='libvirt' module='libvirt'>
      <info>Fetch the globally unique ID of the storage pool as a string</info>
      <return type='int' info='0 on success, or -1 on error;'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='buf' type='char *' info='buffer of VIR_UUID_STRING_BUFLEN bytes in size'/>
    </function>
    <function name='virStoragePoolGetXMLDesc' file='libvirt' module='libvirt'>
      <info>Fetch an XML document describing all aspects of the storage pool. This is suitable for later feeding back into the virStoragePoolCreateXML method.</info>
      <return type='char *' info='a XML document, or NULL on error'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
1958
      <arg name='flags' type='unsigned int' info='flags for XML format options (set of virDomainXMLFlags)'/>
1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994
    </function>
    <function name='virStoragePoolListVolumes' file='libvirt' module='libvirt'>
      <info>Fetch list of storage volume names, limiting to at most maxnames.</info>
      <return type='int' info='the number of names fetched, or -1 on error'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='names' type='char ** const' info='array in which to storage volume names'/>
      <arg name='maxnames' type='int' info='size of names array'/>
    </function>
    <function name='virStoragePoolLookupByName' file='libvirt' module='libvirt'>
      <info>Fetch a storage pool based on its unique name</info>
      <return type='virStoragePoolPtr' info='a virStoragePoolPtr object, or NULL if no matching pool is found'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='name' type='const char *' info='name of pool to fetch'/>
    </function>
    <function name='virStoragePoolLookupByUUID' file='libvirt' module='libvirt'>
      <info>Fetch a storage pool based on its globally unique id</info>
      <return type='virStoragePoolPtr' info='a virStoragePoolPtr object, or NULL if no matching pool is found'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='uuid' type='const unsigned char *' info='globally unique id of pool to fetch'/>
    </function>
    <function name='virStoragePoolLookupByUUIDString' file='libvirt' module='libvirt'>
      <info>Fetch a storage pool based on its globally unique id</info>
      <return type='virStoragePoolPtr' info='a virStoragePoolPtr object, or NULL if no matching pool is found'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='uuidstr' type='const char *' info='globally unique id of pool to fetch'/>
    </function>
    <function name='virStoragePoolLookupByVolume' file='libvirt' module='libvirt'>
      <info>Fetch a storage pool which contains a particular volume</info>
      <return type='virStoragePoolPtr' info='a virStoragePoolPtr object, or NULL if no matching pool is found'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
    </function>
    <function name='virStoragePoolNumOfVolumes' file='libvirt' module='libvirt'>
      <info>Fetch the number of storage volumes within a pool</info>
      <return type='int' info='the number of storage pools, or -1 on failure'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
    </function>
1995 1996
    <function name='virStoragePoolRef' file='libvirt' module='libvirt'>
      <info>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 已提交
1997 1998
      <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'/>
1999
    </function>
2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013
    <function name='virStoragePoolRefresh' file='libvirt' module='libvirt'>
      <info>Request that the pool refresh its list of volumes. This may involve communicating with a remote server, and/or initializing new devices at the OS layer</info>
      <return type='int' info='0 if the volume list was refreshed, -1 on failure'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='flags' type='unsigned int' info='flags to control refresh behaviour (currently unused, use 0)'/>
    </function>
    <function name='virStoragePoolSetAutostart' file='libvirt' module='libvirt'>
      <info>Sets the autostart flag</info>
      <return type='int' info='0 on success, -1 on failure'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='autostart' type='int' info='new flag setting'/>
    </function>
    <function name='virStoragePoolUndefine' file='libvirt' module='libvirt'>
      <info>Undefine an inactive storage pool</info>
D
Daniel Veillard 已提交
2014
      <return type='int' info='0 on success, -1 on failure'/>
2015 2016 2017 2018 2019 2020 2021 2022 2023
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
    </function>
    <function name='virStorageVolCreateXML' file='libvirt' module='libvirt'>
      <info>Create a storage volume within a pool based on an XML description. Not all pools support creation of volumes</info>
      <return type='virStorageVolPtr' info='the storage volume, or NULL on error'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='xmldesc' type='const char *' info='description of volume to create'/>
      <arg name='flags' type='unsigned int' info='flags for creation (unused, pass 0)'/>
    </function>
2024 2025 2026 2027 2028 2029 2030 2031
    <function name='virStorageVolCreateXMLFrom' file='libvirt' module='libvirt'>
      <info>Create a storage volume in the parent pool, using the &apos;clonevol&apos; volume as input. Information for the new volume (name, perms)  are passed via a typical volume XML description.</info>
      <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>
2032 2033 2034 2035
    <function name='virStorageVolDelete' file='libvirt' module='libvirt'>
      <info>Delete the storage volume from the pool</info>
      <return type='int' info='0 on success, or -1 on error'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
2036
      <arg name='flags' type='unsigned int' info='future flags, use 0 for now'/>
2037 2038
    </function>
    <function name='virStorageVolFree' file='libvirt' module='libvirt'>
D
Daniel Veillard 已提交
2039
      <info>Release the storage volume handle. The underlying storage volume continues to exist.</info>
2040 2041 2042 2043 2044 2045
      <return type='int' info='0 on success, or -1 on error'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
    </function>
    <function name='virStorageVolGetConnect' file='libvirt' module='libvirt'>
      <info>Provides the connection pointer associated with a storage volume.  The reference counter on the connection is not increased by this call.  WARNING: When writing libvirt bindings in other languages, do not use this function.  Instead, store the connection and the volume object together.</info>
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
2046
      <arg name='vol' type='virStorageVolPtr' info='pointer to a pool'/>
2047 2048 2049 2050 2051 2052 2053 2054
    </function>
    <function name='virStorageVolGetInfo' file='libvirt' module='libvirt'>
      <info>Fetches volatile information about the storage volume such as its current allocation</info>
      <return type='int' info='0 on success, or -1 on failure'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
      <arg name='info' type='virStorageVolInfoPtr' info='pointer at which to store info'/>
    </function>
    <function name='virStorageVolGetKey' file='libvirt' module='libvirt'>
2055
      <info>Fetch the storage volume key. This is globally unique, so the same volume will have the same key no matter what host it is accessed from</info>
2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092
      <return type='const char *' info='the volume key, or NULL on error'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
    </function>
    <function name='virStorageVolGetName' file='libvirt' module='libvirt'>
      <info>Fetch the storage volume name. This is unique within the scope of a pool</info>
      <return type='const char *' info='the volume name, or NULL on error'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
    </function>
    <function name='virStorageVolGetPath' file='libvirt' module='libvirt'>
      <info>Fetch the storage volume path. Depending on the pool configuration this is either persistent across hosts, or dynamically assigned at pool startup. Consult pool documentation for information on getting the persistent naming</info>
      <return type='char *' info='the storage volume path, or NULL on error'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
    </function>
    <function name='virStorageVolGetXMLDesc' file='libvirt' module='libvirt'>
      <info>Fetch an XML document describing all aspects of the storage volume</info>
      <return type='char *' info='the XML document, or NULL on error'/>
      <arg name='vol' type='virStorageVolPtr' info='pointer to storage volume'/>
      <arg name='flags' type='unsigned int' info='flags for XML generation (unused, pass 0)'/>
    </function>
    <function name='virStorageVolLookupByKey' file='libvirt' module='libvirt'>
      <info>Fetch a pointer to a storage volume based on its globally unique key</info>
      <return type='virStorageVolPtr' info='a storage volume, or NULL if not found / error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='key' type='const char *' info='globally unique key'/>
    </function>
    <function name='virStorageVolLookupByName' file='libvirt' module='libvirt'>
      <info>Fetch a pointer to a storage volume based on its name within a pool</info>
      <return type='virStorageVolPtr' info='a storage volume, or NULL if not found / error'/>
      <arg name='pool' type='virStoragePoolPtr' info='pointer to storage pool'/>
      <arg name='name' type='const char *' info='name of storage volume'/>
    </function>
    <function name='virStorageVolLookupByPath' file='libvirt' module='libvirt'>
      <info>Fetch a pointer to a storage volume based on its locally (host) unique path</info>
      <return type='virStorageVolPtr' info='a storage volume, or NULL if not found / error'/>
      <arg name='conn' type='virConnectPtr' info='pointer to hypervisor connection'/>
      <arg name='path' type='const char *' info='locally unique path'/>
    </function>
2093 2094
    <function name='virStorageVolRef' file='libvirt' module='libvirt'>
      <info>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 已提交
2095 2096
      <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'/>
2097
    </function>
2098 2099
  </symbols>
</api>