libvirt-api.xml 79.0 KB
Newer Older
1
<?xml version="1.0" encoding="ISO-8859-1"?>
D
Daniel Veillard 已提交
2
<api name='libvirt'>
3
  <files>
4 5 6 7
    <file name='libvirt'>
     <summary>core interfaces for the libvirt library</summary>
     <description>Provides the interfaces of the libvirt library to handle Xen domains from a process running in domain 0 </description>
     <author>Daniel Veillard &lt;veillard@redhat.com&gt; </author>
8
     <exports symbol='VIR_NODEINFO_MAXCPUS' type='macro'/>
9
     <exports symbol='LIBVIR_VERSION_NUMBER' type='macro'/>
10 11
     <exports symbol='VIR_USE_CPU' type='macro'/>
     <exports symbol='VIR_CPU_MAPLEN' type='macro'/>
12
     <exports symbol='VIR_UUID_BUFLEN' type='macro'/>
13 14
     <exports symbol='VIR_CPU_USABLE' type='macro'/>
     <exports symbol='VIR_COPY_CPUMAP' type='macro'/>
15
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_LENGTH' type='macro'/>
16
     <exports symbol='VIR_UUID_STRING_BUFLEN' type='macro'/>
17 18
     <exports symbol='VIR_GET_CPUMAP' type='macro'/>
     <exports symbol='VIR_UNUSE_CPU' type='macro'/>
19 20 21 22
     <exports symbol='VIR_DOMAIN_SHUTDOWN' type='enum'/>
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_UINT' type='enum'/>
     <exports symbol='VIR_VCPU_RUNNING' type='enum'/>
     <exports symbol='VIR_DOMAIN_CRASHED' type='enum'/>
23
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_DOUBLE' type='enum'/>
24
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_LLONG' type='enum'/>
25 26 27 28 29
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_ULLONG' type='enum'/>
     <exports symbol='VIR_DOMAIN_DESTROY' type='enum'/>
     <exports symbol='VIR_DOMAIN_RESTART' type='enum'/>
     <exports symbol='VIR_DOMAIN_PRESERVE' type='enum'/>
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_BOOLEAN' type='enum'/>
30
     <exports symbol='VIR_MIGRATE_LIVE' type='enum'/>
31
     <exports symbol='VIR_VCPU_OFFLINE' type='enum'/>
32 33 34 35
     <exports symbol='VIR_DOMAIN_RUNNING' type='enum'/>
     <exports symbol='VIR_DOMAIN_BLOCKED' type='enum'/>
     <exports symbol='VIR_DOMAIN_SHUTOFF' type='enum'/>
     <exports symbol='VIR_VCPU_BLOCKED' type='enum'/>
36
     <exports symbol='VIR_DOMAIN_SCHED_FIELD_INT' type='enum'/>
37
     <exports symbol='VIR_DOMAIN_PAUSED' type='enum'/>
38
     <exports symbol='VIR_DOMAIN_NONE' type='enum'/>
39
     <exports symbol='VIR_DOMAIN_NOSTATE' type='enum'/>
40
     <exports symbol='VIR_DOMAIN_RENAME_RESTART' type='enum'/>
41
     <exports symbol='virDomainBlockStatsStruct' type='typedef'/>
42
     <exports symbol='virDomainMigrateFlags' type='typedef'/>
43 44
     <exports symbol='virNodeInfo' type='typedef'/>
     <exports symbol='virNetwork' type='typedef'/>
45
     <exports symbol='virDomainBlockStatsPtr' type='typedef'/>
46
     <exports symbol='virSchedParameterType' type='typedef'/>
47 48 49
     <exports symbol='virConnect' type='typedef'/>
     <exports symbol='virVcpuInfo' type='typedef'/>
     <exports symbol='virDomainInfo' type='typedef'/>
50
     <exports symbol='virDomainInterfaceStatsStruct' type='typedef'/>
51 52
     <exports symbol='virDomainState' type='typedef'/>
     <exports symbol='virDomain' type='typedef'/>
53
     <exports symbol='virDomainInterfaceStatsPtr' type='typedef'/>
54
     <exports symbol='virDomainRestart' type='typedef'/>
55
     <exports symbol='virSchedParameterPtr' type='typedef'/>
56 57 58 59
     <exports symbol='virNodeInfoPtr' type='typedef'/>
     <exports symbol='virNetworkPtr' type='typedef'/>
     <exports symbol='virDomainInfoPtr' type='typedef'/>
     <exports symbol='virConnectPtr' type='typedef'/>
60
     <exports symbol='virSchedParameter' type='typedef'/>
61
     <exports symbol='virVcpuState' type='typedef'/>
62
     <exports symbol='virVcpuInfoPtr' type='typedef'/>
63 64
     <exports symbol='virDomainPtr' type='typedef'/>
     <exports symbol='virDomainCreateFlags' type='typedef'/>
65
     <exports symbol='_virDomainInfo' type='struct'/>
66
     <exports symbol='_virDomainInterfaceStats' type='struct'/>
67
     <exports symbol='_virVcpuInfo' type='struct'/>
68
     <exports symbol='_virSchedParameter' type='struct'/>
69 70
     <exports symbol='_virDomainBlockStats' type='struct'/>
     <exports symbol='_virNodeInfo' type='struct'/>
71
     <exports symbol='virDomainGetInfo' type='function'/>
72 73 74
     <exports symbol='virNetworkFree' type='function'/>
     <exports symbol='virNetworkGetName' type='function'/>
     <exports symbol='virDomainGetName' type='function'/>
75
     <exports symbol='virNetworkGetAutostart' type='function'/>
76 77
     <exports symbol='virDomainDefineXML' type='function'/>
     <exports symbol='virDomainShutdown' type='function'/>
78
     <exports symbol='virNetworkUndefine' type='function'/>
79 80
     <exports symbol='virGetVersion' type='function'/>
     <exports symbol='virConnectListDefinedDomains' type='function'/>
81
     <exports symbol='virConnectGetCapabilities' type='function'/>
82
     <exports symbol='virInitialize' type='function'/>
83
     <exports symbol='virDomainLookupByName' type='function'/>
84
     <exports symbol='virNetworkLookupByUUID' type='function'/>
85
     <exports symbol='virNetworkGetBridgeName' type='function'/>
86
     <exports symbol='virDomainPinVcpu' type='function'/>
87 88
     <exports symbol='virDomainRestore' type='function'/>
     <exports symbol='virConnectGetType' type='function'/>
89
     <exports symbol='virNetworkLookupByName' type='function'/>
90
     <exports symbol='virDomainGetSchedulerParameters' type='function'/>
91 92
     <exports symbol='virDomainCreate' type='function'/>
     <exports symbol='virConnectListDomains' type='function'/>
93
     <exports symbol='virNetworkLookupByUUIDString' type='function'/>
D
Daniel Veillard 已提交
94
     <exports symbol='virDomainCoreDump' type='function'/>
95 96
     <exports symbol='virDomainLookupByUUID' type='function'/>
     <exports symbol='virDomainLookupByUUIDString' type='function'/>
97 98
     <exports symbol='virConnectNumOfDefinedNetworks' type='function'/>
     <exports symbol='virDomainUndefine' type='function'/>
99
     <exports symbol='virDomainGetOSType' type='function'/>
100
     <exports symbol='virConnectListDefinedNetworks' type='function'/>
101 102
     <exports symbol='virNodeGetInfo' type='function'/>
     <exports symbol='virDomainGetUUID' type='function'/>
103
     <exports symbol='virDomainSetMemory' type='function'/>
104
     <exports symbol='virNetworkSetAutostart' type='function'/>
105 106
     <exports symbol='virConnectNumOfDomains' type='function'/>
     <exports symbol='virDomainGetUUIDString' type='function'/>
107
     <exports symbol='virDomainGetConnect' type='function'/>
D
Daniel Veillard 已提交
108 109
     <exports symbol='virDomainGetMaxMemory' type='function'/>
     <exports symbol='virDomainAttachDevice' type='function'/>
110
     <exports symbol='virDomainGetMaxVcpus' type='function'/>
111 112
     <exports symbol='virDomainFree' type='function'/>
     <exports symbol='virConnectOpen' type='function'/>
113
     <exports symbol='virDomainSetAutostart' type='function'/>
114
     <exports symbol='virDomainSuspend' type='function'/>
115
     <exports symbol='virConnectGetMaxVcpus' type='function'/>
116
     <exports symbol='virNetworkGetConnect' type='function'/>
117 118
     <exports symbol='virConnectNumOfDefinedDomains' type='function'/>
     <exports symbol='virNetworkCreateXML' type='function'/>
119 120
     <exports symbol='virNetworkDefineXML' type='function'/>
     <exports symbol='virNetworkCreate' type='function'/>
121
     <exports symbol='virDomainSetSchedulerParameters' type='function'/>
122 123
     <exports symbol='virConnectClose' type='function'/>
     <exports symbol='virDomainReboot' type='function'/>
124
     <exports symbol='virDomainBlockStats' type='function'/>
125
     <exports symbol='virDomainSetVcpus' type='function'/>
126
     <exports symbol='virDomainLookupByID' type='function'/>
127
     <exports symbol='virNetworkGetUUIDString' type='function'/>
128
     <exports symbol='virDomainMigrate' type='function'/>
129
     <exports symbol='virNetworkGetXMLDesc' type='function'/>
130 131 132
     <exports symbol='virDomainGetID' type='function'/>
     <exports symbol='virDomainResume' type='function'/>
     <exports symbol='virDomainCreateLinux' type='function'/>
133
     <exports symbol='virDomainGetSchedulerType' type='function'/>
134
     <exports symbol='virNetworkDestroy' type='function'/>
135
     <exports symbol='virDomainDestroy' type='function'/>
136
     <exports symbol='virConnectNumOfNetworks' type='function'/>
D
Daniel Veillard 已提交
137
     <exports symbol='virDomainDetachDevice' type='function'/>
138
     <exports symbol='virDomainGetAutostart' type='function'/>
D
Daniel Veillard 已提交
139
     <exports symbol='virDomainGetVcpus' type='function'/>
140 141
     <exports symbol='virNetworkGetUUID' type='function'/>
     <exports symbol='virConnectGetHostname' type='function'/>
142
     <exports symbol='virDomainGetXMLDesc' type='function'/>
143
     <exports symbol='virDomainSetMaxMemory' type='function'/>
144
     <exports symbol='virDomainInterfaceStats' type='function'/>
D
Daniel Veillard 已提交
145
     <exports symbol='virConnectGetVersion' type='function'/>
146
     <exports symbol='virConnectListNetworks' type='function'/>
147
     <exports symbol='virConnectGetURI' type='function'/>
148
     <exports symbol='virDomainSave' type='function'/>
149 150 151 152 153 154
     <exports symbol='virConnectOpenReadOnly' type='function'/>
    </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>
155
     <exports symbol='VIR_FROM_XML' type='enum'/>
156
     <exports symbol='VIR_ERR_RPC' type='enum'/>
157
     <exports symbol='VIR_ERR_SYSTEM_ERROR' type='enum'/>
158
     <exports symbol='VIR_FROM_TEST' type='enum'/>
159
     <exports symbol='VIR_ERR_WARNING' type='enum'/>
160
     <exports symbol='VIR_FROM_OPENVZ' type='enum'/>
161 162 163
     <exports symbol='VIR_ERR_NO_XEN' type='enum'/>
     <exports symbol='VIR_ERR_INVALID_ARG' type='enum'/>
     <exports symbol='VIR_ERR_ERROR' type='enum'/>
164
     <exports symbol='VIR_ERR_NO_OS' type='enum'/>
165 166 167 168
     <exports symbol='VIR_ERR_NO_DEVICE' type='enum'/>
     <exports symbol='VIR_ERR_NO_MEMORY' type='enum'/>
     <exports symbol='VIR_FROM_SEXPR' type='enum'/>
     <exports symbol='VIR_FROM_RPC' type='enum'/>
169
     <exports symbol='VIR_ERR_INVALID_MAC' type='enum'/>
170 171
     <exports symbol='VIR_ERR_XML_ERROR' type='enum'/>
     <exports symbol='VIR_FROM_NONE' type='enum'/>
172
     <exports symbol='VIR_ERR_DOM_EXIST' type='enum'/>
173 174 175
     <exports symbol='VIR_ERR_NO_XENSTORE' type='enum'/>
     <exports symbol='VIR_FROM_DOM' type='enum'/>
     <exports symbol='VIR_ERR_INVALID_DOMAIN' type='enum'/>
176
     <exports symbol='VIR_FROM_QEMU' type='enum'/>
177
     <exports symbol='VIR_FROM_CONF' type='enum'/>
178 179
     <exports symbol='VIR_ERR_INVALID_NETWORK' type='enum'/>
     <exports symbol='VIR_ERR_OPERATION_DENIED' type='enum'/>
180
     <exports symbol='VIR_ERR_NO_KERNEL' type='enum'/>
181
     <exports symbol='VIR_ERR_GNUTLS_ERROR' type='enum'/>
182 183
     <exports symbol='VIR_ERR_POST_FAILED' type='enum'/>
     <exports symbol='VIR_ERR_OS_TYPE' type='enum'/>
184
     <exports symbol='VIR_WAR_NO_NETWORK' type='enum'/>
185 186 187
     <exports symbol='VIR_ERR_INVALID_CONN' type='enum'/>
     <exports symbol='VIR_ERR_NONE' type='enum'/>
     <exports symbol='VIR_ERR_OK' type='enum'/>
188
     <exports symbol='VIR_ERR_XML_DETAIL' type='enum'/>
189
     <exports symbol='VIR_FROM_NET' type='enum'/>
190 191 192 193 194
     <exports symbol='VIR_ERR_NO_NAME' type='enum'/>
     <exports symbol='VIR_ERR_NO_ROOT' type='enum'/>
     <exports symbol='VIR_ERR_OPERATION_FAILED' type='enum'/>
     <exports symbol='VIR_ERR_GET_FAILED' type='enum'/>
     <exports symbol='VIR_ERR_DRIVER_FULL' type='enum'/>
195
     <exports symbol='VIR_ERR_HTTP_ERROR' type='enum'/>
196
     <exports symbol='VIR_ERR_PARSE_FAILED' type='enum'/>
197 198
     <exports symbol='VIR_ERR_NO_SOURCE' type='enum'/>
     <exports symbol='VIR_ERR_NO_TARGET' type='enum'/>
199
     <exports symbol='VIR_ERR_NETWORK_EXIST' type='enum'/>
200
     <exports symbol='VIR_ERR_WRITE_FAILED' type='enum'/>
201
     <exports symbol='VIR_ERR_INTERNAL_ERROR' type='enum'/>
202
     <exports symbol='VIR_ERR_CONF_SYNTAX' type='enum'/>
203
     <exports symbol='VIR_FROM_REMOTE' type='enum'/>
204 205 206
     <exports symbol='VIR_ERR_NO_SUPPORT' type='enum'/>
     <exports symbol='VIR_FROM_XEND' type='enum'/>
     <exports symbol='VIR_FROM_PROXY' type='enum'/>
207 208
     <exports symbol='VIR_ERR_NO_NETWORK' type='enum'/>
     <exports symbol='VIR_ERR_NO_DOMAIN' type='enum'/>
209
     <exports symbol='VIR_ERR_READ_FAILED' type='enum'/>
210 211 212
     <exports symbol='VIR_ERR_SEXPR_SERIAL' type='enum'/>
     <exports symbol='VIR_FROM_XENSTORE' type='enum'/>
     <exports symbol='VIR_FROM_XEN' type='enum'/>
213
     <exports symbol='VIR_ERR_OPEN_FAILED' type='enum'/>
214 215 216
     <exports symbol='VIR_ERR_XEN_CALL' type='enum'/>
     <exports symbol='VIR_ERR_UNKNOWN_HOST' type='enum'/>
     <exports symbol='VIR_ERR_NO_CONNECT' type='enum'/>
217
     <exports symbol='VIR_ERR_CALL_FAILED' type='enum'/>
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
     <exports symbol='virErrorPtr' type='typedef'/>
     <exports symbol='virErrorLevel' type='typedef'/>
     <exports symbol='virErrorDomain' type='typedef'/>
     <exports symbol='virErrorNumber' type='typedef'/>
     <exports symbol='virError' type='typedef'/>
     <exports symbol='_virError' type='struct'/>
     <exports symbol='virCopyLastError' type='function'/>
     <exports symbol='virConnSetErrorFunc' type='function'/>
     <exports symbol='virResetLastError' type='function'/>
     <exports symbol='virErrorFunc' type='function'/>
     <exports symbol='virResetError' type='function'/>
     <exports symbol='virConnGetLastError' type='function'/>
     <exports symbol='virDefaultErrorFunc' type='function'/>
     <exports symbol='virGetLastError' type='function'/>
     <exports symbol='virSetErrorFunc' type='function'/>
     <exports symbol='virConnCopyLastError' type='function'/>
     <exports symbol='virConnResetLastError' type='function'/>
    </file>
236 237
  </files>
  <symbols>
238 239 240
    <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>
241 242 243 244 245 246 247 248
    <macro name='VIR_COPY_CPUMAP' file='libvirt'>
      <info>This macro is to be used in conjonction 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>
      <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'>
249 250
      <info>This macro is to be used in conjonction 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>
      <arg name='cpu' info='number of physical CPUs'/>
251 252 253 254 255 256 257 258
    </macro>
    <macro name='VIR_CPU_USABLE' file='libvirt'>
      <info>This macro is to be used in conjonction 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>
      <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>
259 260 261
    <macro name='VIR_DOMAIN_SCHED_FIELD_LENGTH' file='libvirt'>
      <info>Macro providing the field length of virSchedParameter</info>
    </macro>
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
    <macro name='VIR_GET_CPUMAP' file='libvirt'>
      <info>This macro is to be used in conjonction with virDomainGetVcpus() and virDomainPinVcpu() APIs. VIR_GET_CPUMAP macro returns a pointer to the cpumap of the specified vcpu from cpumaps array.</info>
      <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'>
      <info>This macro is to calculate the total number of CPUs supported but not neccessarily active in the host.</info>
      <arg name='nodeinfo' info='virNodeInfo instance'/>
    </macro>
    <macro name='VIR_UNUSE_CPU' file='libvirt'>
      <info>This macro is to be used in conjonction with virDomainPinVcpu() API. USE_CPU macro reset the bit (CPU not usable) of the related cpu in cpumap.</info>
      <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'>
      <info>This macro is to be used in conjonction with virDomainPinVcpu() API. USE_CPU macro set the bit (CPU usable) of the related cpu in cpumap.</info>
      <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>
282
    <macro name='VIR_UUID_BUFLEN' file='libvirt'>
283
      <info>This macro provides the length of the buffer required for virDomainGetUUID()</info>
284 285 286 287
    </macro>
    <macro name='VIR_UUID_STRING_BUFLEN' file='libvirt'>
      <info>This macro provides the length of the buffer required for virDomainGetUUIDString()</info>
    </macro>
288 289 290 291 292 293 294 295 296 297
    <enum name='VIR_DOMAIN_BLOCKED' file='libvirt' value='2' type='virDomainState' info='the domain is blocked on resource'/>
    <enum name='VIR_DOMAIN_CRASHED' file='libvirt' value='6' type='virDomainState' info=' the domain is crashed'/>
    <enum name='VIR_DOMAIN_DESTROY' file='libvirt' value='1' type='virDomainRestart' info='destroy the domain'/>
    <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_PRESERVE' file='libvirt' value='3' type='virDomainRestart' info='keep as is, need manual destroy, for debug'/>
    <enum name='VIR_DOMAIN_RENAME_RESTART' file='libvirt' value='4' type='virDomainRestart' info=' restart under an new unique name'/>
    <enum name='VIR_DOMAIN_RESTART' file='libvirt' value='2' type='virDomainRestart' info='restart the domain'/>
    <enum name='VIR_DOMAIN_RUNNING' file='libvirt' value='1' type='virDomainState' info='the domain is running'/>
298 299 300 301 302 303
    <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'/>
304 305
    <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'/>
306
    <enum name='VIR_ERR_CALL_FAILED' file='virterror' value='26' type='virErrorNumber' info='not supported by the drivers (DEPRECATED)'/>
307
    <enum name='VIR_ERR_CONF_SYNTAX' file='virterror' value='33' type='virErrorNumber' info='failed to parse the syntax of a conf file'/>
308
    <enum name='VIR_ERR_DOM_EXIST' file='virterror' value='28' type='virErrorNumber' info='the domain already exist'/>
309 310 311
    <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'/>
312
    <enum name='VIR_ERR_GNUTLS_ERROR' file='virterror' value='40' type='virErrorNumber' info='error from a GNUTLS call'/>
313 314 315 316 317
    <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'/>
318
    <enum name='VIR_ERR_INVALID_MAC' file='virterror' value='44' type='virErrorNumber' info=' invalid MAC adress'/>
319
    <enum name='VIR_ERR_INVALID_NETWORK' file='virterror' value='36' type='virErrorNumber' info='invalid network object'/>
320
    <enum name='VIR_ERR_NETWORK_EXIST' file='virterror' value='37' type='virErrorNumber' info='the network already exist'/>
321 322 323
    <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'/>
324
    <enum name='VIR_ERR_NO_DOMAIN' file='virterror' value='42' type='virErrorNumber' info='domain not found or unexpectedly disappeared'/>
325 326 327
    <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'/>
328
    <enum name='VIR_ERR_NO_NETWORK' file='virterror' value='43' type='virErrorNumber' info='network not found'/>
329 330 331
    <enum name='VIR_ERR_NO_OS' file='virterror' value='22' type='virErrorNumber' info='missing domain OS information'/>
    <enum name='VIR_ERR_NO_ROOT' file='virterror' value='18' type='virErrorNumber' info='missing root device information'/>
    <enum name='VIR_ERR_NO_SOURCE' file='virterror' value='19' type='virErrorNumber' info='missing source device information'/>
332
    <enum name='VIR_ERR_NO_SUPPORT' file='virterror' value='3' type='virErrorNumber' info='no support for this function'/>
333 334 335 336
    <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'/>
337 338
    <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'/>
339 340
    <enum name='VIR_ERR_OPERATION_FAILED' file='virterror' value='9' type='virErrorNumber' info='a command to hypervisor failed'/>
    <enum name='VIR_ERR_OS_TYPE' file='virterror' value='16' type='virErrorNumber' info='unknown OS type'/>
341
    <enum name='VIR_ERR_PARSE_FAILED' file='virterror' value='32' type='virErrorNumber' info='failed to parse a conf file'/>
342
    <enum name='VIR_ERR_POST_FAILED' file='virterror' value='11' type='virErrorNumber' info='a HTTP POST command to failed'/>
343
    <enum name='VIR_ERR_READ_FAILED' file='virterror' value='31' type='virErrorNumber' info='failed to read a conf file'/>
344
    <enum name='VIR_ERR_RPC' file='virterror' value='39' type='virErrorNumber' info='some sort of RPC error'/>
345
    <enum name='VIR_ERR_SEXPR_SERIAL' file='virterror' value='13' type='virErrorNumber' info='failure to serialize an S-Expr'/>
346
    <enum name='VIR_ERR_SYSTEM_ERROR' file='virterror' value='38' type='virErrorNumber' info='general system call failure'/>
347 348
    <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'/>
349
    <enum name='VIR_ERR_WRITE_FAILED' file='virterror' value='34' type='virErrorNumber' info='failed to write a conf file'/>
350
    <enum name='VIR_ERR_XEN_CALL' file='virterror' value='15' type='virErrorNumber' info='failure doing an hypervisor call'/>
351
    <enum name='VIR_ERR_XML_DETAIL' file='virterror' value='35' type='virErrorNumber' info='detail of an XML error'/>
352
    <enum name='VIR_ERR_XML_ERROR' file='virterror' value='27' type='virErrorNumber' info='an XML description is not well formed or broken'/>
353
    <enum name='VIR_FROM_CONF' file='virterror' value='9' type='virErrorDomain' info='Error in the configuration file handling'/>
354
    <enum name='VIR_FROM_DOM' file='virterror' value='6' type='virErrorDomain' info='Error when operating on a domain'/>
355
    <enum name='VIR_FROM_NET' file='virterror' value='11' type='virErrorDomain' info='Error when operating on a network'/>
356
    <enum name='VIR_FROM_NONE' file='virterror' value='0' type='virErrorDomain'/>
357
    <enum name='VIR_FROM_OPENVZ' file='virterror' value='14' type='virErrorDomain' info=' Error from OpenVZ driver'/>
358
    <enum name='VIR_FROM_PROXY' file='virterror' value='8' type='virErrorDomain' info='Error in the proxy code'/>
359
    <enum name='VIR_FROM_QEMU' file='virterror' value='10' type='virErrorDomain' info='Error at the QEMU daemon'/>
360
    <enum name='VIR_FROM_REMOTE' file='virterror' value='13' type='virErrorDomain' info='Error from remote driver'/>
361 362
    <enum name='VIR_FROM_RPC' file='virterror' value='7' type='virErrorDomain' info='Error in the XML-RPC code'/>
    <enum name='VIR_FROM_SEXPR' file='virterror' value='4' type='virErrorDomain' info='Error in the S-Epression code'/>
363
    <enum name='VIR_FROM_TEST' file='virterror' value='12' type='virErrorDomain' info='Error from test driver'/>
364 365 366 367
    <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'/>
    <enum name='VIR_FROM_XML' file='virterror' value='5' type='virErrorDomain' info='Error in the XML code'/>
368
    <enum name='VIR_MIGRATE_LIVE' file='libvirt' value='1' type='virDomainMigrateFlags' info=' live migration'/>
369 370 371
    <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'/>
372
    <enum name='VIR_WAR_NO_NETWORK' file='virterror' value='41' type='virErrorNumber' info='failed to start network'/>
373 374 375 376 377
    <struct name='virConnect' file='libvirt' type='struct _virConnect'/>
    <typedef name='virConnectPtr' file='libvirt' type='virConnect *'>
      <info>a virConnectPtr is pointer to a virConnect private structure, this is the type used to reference a connection to the Xen Hypervisor in the API.</info>
    </typedef>
    <struct name='virDomain' file='libvirt' type='struct _virDomain'/>
378 379 380 381 382 383 384 385 386 387
    <typedef name='virDomainBlockStatsPtr' file='libvirt' type='virDomainBlockStatsStruct *'>
      <info>A pointer to a virDomainBlockStats structure</info>
    </typedef>
    <struct name='virDomainBlockStatsStruct' file='libvirt' type='struct _virDomainBlockStats'>
      <field name='rd_req' type='long long' info=''/>
      <field name='rd_bytes' type='long long' info=''/>
      <field name='wr_req' type='long long' info=''/>
      <field name='wr_bytes' type='long long' info=''/>
      <field name='errs' type='long long' info=' In Xen this returns the mysterious &apos;oo_req&apos;.'/>
    </struct>
388 389 390 391 392 393 394 395 396 397 398
    <typedef name='virDomainCreateFlags' file='libvirt' type='enum'/>
    <struct name='virDomainInfo' file='libvirt' type='struct _virDomainInfo'>
      <field name='state' type='unsigned char' info=' the running state, one of virDomainFlags'/>
      <field name='maxMem' type='unsigned long' info=' the maximum memory in KBytes allowed'/>
      <field name='memory' type='unsigned long' info=' the memory in KBytes used by the domain'/>
      <field name='nrVirtCpu' type='unsigned short' info=' the number of virtual CPUs for the domain'/>
      <field name='cpuTime' type='unsigned long long' info=' the CPU time used in nanoseconds'/>
    </struct>
    <typedef name='virDomainInfoPtr' file='libvirt' type='virDomainInfo *'>
      <info>a virDomainInfoPtr is a pointer to a virDomainInfo structure.</info>
    </typedef>
399 400 401 402 403 404 405 406 407 408 409 410 411
    <typedef name='virDomainInterfaceStatsPtr' file='libvirt' type='virDomainInterfaceStatsStruct *'>
      <info>A pointe to a virDomainInterfaceStats structure</info>
    </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>
412
    <typedef name='virDomainMigrateFlags' file='libvirt' type='enum'/>
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
    <typedef name='virDomainPtr' file='libvirt' type='virDomain *'>
      <info>a virDomainPtr is pointer to a virDomain private structure, this is the type used to reference a Xen domain in the API.</info>
    </typedef>
    <typedef name='virDomainRestart' file='libvirt' type='enum'/>
    <typedef name='virDomainState' file='libvirt' type='enum'/>
    <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'/>
      <field name='conn' type='virConnectPtr' info=' the connection if available'/>
      <field name='dom' type='virDomainPtr' info=' the domain if available'/>
      <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'/>
430
      <field name='net' type='virNetworkPtr' info=' the network if available'/>
431 432 433 434 435
    </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 *'/>
436 437 438 439
    <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>
440 441 442 443 444 445 446 447 448 449 450 451 452
    <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>
453 454 455 456 457 458 459 460
    <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'/>
461 462 463 464 465 466 467 468
    <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'/>
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
    <function name='virConnCopyLastError' file='virterror' module='virterror'>
      <info>Copy the content of the last error caught on that connection One will need to free the result with virResetError()</info>
      <return type='int' info='0 if no error was found and the error code otherwise and -1 in case of parameter error.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='to' type='virErrorPtr' info='target to receive the copy'/>
    </function>
    <function name='virConnGetLastError' file='virterror' module='virterror'>
      <info>Provide a pointer to the last error caught on that connection Simpler but may not be suitable for multithreaded accesses, in which case use virConnCopyLastError()</info>
      <return type='virErrorPtr' info='a pointer to the last error or NULL if none occured.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
    <function name='virConnResetLastError' file='virterror' module='virterror'>
      <info>Reset the last error caught on that connection</info>
      <return type='void'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
    <function name='virConnSetErrorFunc' file='virterror' module='virterror'>
      <info>Set a connection error handling function, if @handler is NULL it will reset to default which is to pass error back to the global library handler.</info>
      <return type='void'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='userData' type='void *' info='pointer to the user data provided in the handler callback'/>
      <arg name='handler' type='virErrorFunc' info='the function to get called in case of error or NULL'/>
    </function>
    <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>
497 498
    <function name='virConnectGetCapabilities' file='libvirt' module='libvirt'>
      <info>Provides capabilities of the hypervisor / driver.</info>
499
      <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.'/>
500 501
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
502 503 504 505 506
    <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>
507
    <function name='virConnectGetMaxVcpus' file='libvirt' module='libvirt'>
508 509
      <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.'/>
510 511 512
      <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>
513 514
    <function name='virConnectGetType' file='libvirt' module='libvirt'>
      <info>Get the name of the Hypervisor software used.</info>
515
      <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'/>
516 517
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
    </function>
518 519 520 521 522
    <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>
523 524 525 526 527 528 529 530 531 532
    <function name='virConnectGetVersion' file='libvirt' module='libvirt'>
      <info>Get the version level of the Hypervisor running. This may work only with hypervisor call, i.e. with priviledged access to the hypervisor, not with a Read-Only connection.</info>
      <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'>
      <info>list the defined domains, 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'/>
533
      <arg name='names' type='char ** const' info='pointer to an array to store the names'/>
534 535
      <arg name='maxnames' type='int' info='size of the array'/>
    </function>
536 537 538 539
    <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'/>
540
      <arg name='names' type='char ** const' info='pointer to an array to store the names'/>
541 542
      <arg name='maxnames' type='int' info='size of the array'/>
    </function>
543 544 545 546 547 548 549
    <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>
550 551 552 553
    <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'/>
554
      <arg name='names' type='char ** const' info='array to collect the list of names of active networks'/>
555 556
      <arg name='maxnames' type='int' info='size of @names'/>
    </function>
557
    <function name='virConnectNumOfDefinedDomains' file='libvirt' module='libvirt'>
558
      <info>Provides the number of inactive domains.</info>
559 560 561
      <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>
562 563 564 565 566
    <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>
567 568 569 570 571
    <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>
572 573 574 575 576
    <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>
577 578
    <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>
579 580
      <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'/>
581 582 583
    </function>
    <function name='virConnectOpenReadOnly' file='libvirt' module='libvirt'>
      <info>This function should be called first to get a restricted connection to the libbrary functionalities. The set of APIs usable are then restricted on the available methods to control the domains.</info>
584 585
      <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'/>
586 587 588 589 590 591 592 593 594 595 596
    </function>
    <function name='virCopyLastError' file='virterror' module='virterror'>
      <info>Copy the content of the last error caught at the library level One will need to free the result with virResetError()</info>
      <return type='int' info='0 if no error was found and the error code otherwise and -1 in case of parameter error.'/>
      <arg name='to' type='virErrorPtr' info='target to receive the copy'/>
    </function>
    <function name='virDefaultErrorFunc' file='virterror' module='virterror'>
      <info>Default routine reporting an error to stderr.</info>
      <return type='void'/>
      <arg name='err' type='virErrorPtr' info='pointer to the error.'/>
    </function>
D
Daniel Veillard 已提交
597 598 599 600 601 602
    <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'/>
      <arg name='xml' type='char *' info='pointer to XML description of one device'/>
    </function>
603 604 605 606 607 608 609 610
    <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 已提交
611 612 613 614 615 616 617
    <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>
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
    <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'>
      <info>Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires priviledged access to the hypervisor.</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='an XML description of the domain'/>
      <arg name='flags' type='unsigned int' info='an optional set of virDomainFlags'/>
    </function>
    <function name='virDomainDefineXML' file='libvirt' module='libvirt'>
      <info>define a domain, but does not start it</info>
      <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'>
      <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. The data structure is freed and should not be used thereafter if the call does not return an error. This function may requires priviledged access</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>
D
Daniel Veillard 已提交
641 642 643 644 645 646
    <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'/>
      <arg name='xml' type='char *' info='pointer to XML description of one device'/>
    </function>
647 648 649 650 651
    <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>
652
    <function name='virDomainGetAutostart' file='libvirt' module='libvirt'>
653 654
      <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'/>
655
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
656
      <arg name='autostart' type='int *' info='the value returned'/>
657
    </function>
658
    <function name='virDomainGetConnect' file='libvirt' module='libvirt'>
659
      <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>
660
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
661 662
      <arg name='dom' type='virDomainPtr' info='pointer to a domain'/>
    </function>
663 664 665 666 667 668
    <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'>
669
      <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>
670 671 672 673 674 675 676 677 678
      <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>
679
    <function name='virDomainGetMaxVcpus' file='libvirt' module='libvirt'>
680 681
      <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.'/>
682 683
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
    </function>
684 685 686 687 688 689 690 691 692 693
    <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>
694 695 696 697 698 699 700 701 702 703 704 705 706
    <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>
707 708 709 710
    <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'/>
711
      <arg name='uuid' type='unsigned char *' info='pointer to a VIR_UUID_BUFLEN bytes array'/>
712 713 714 715 716
    </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'/>
717
      <arg name='buf' type='char *' info='pointer to a VIR_UUID_STRING_BUFLEN bytes array'/>
718
    </function>
719 720 721 722 723 724 725 726 727
    <function name='virDomainGetVcpus' file='libvirt' module='libvirt'>
      <info>Extract information about virtual CPUs of domain, store it in info array and also in cpumaps if this pointer is&apos;nt NULL.</info>
      <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'/>
      <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 cupmap 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.'/>
      <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>
728 729 730 731 732 733
    <function name='virDomainGetXMLDesc' file='libvirt' module='libvirt'>
      <info>Provide an XML description of the domain. The description may be reused later to relaunch the domain with virDomainCreateLinux().</info>
      <return type='char *' info='a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. the caller must free() the returned value.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='flags' type='int' info='and OR&apos;ed set of extraction flags, not used yet'/>
    </function>
734 735 736 737 738 739 740 741
    <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>
742 743
    <function name='virDomainLookupByID' file='libvirt' module='libvirt'>
      <info>Try to find a domain based on the hypervisor ID number</info>
744
      <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.'/>
745 746 747 748 749
      <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>
750
      <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.'/>
751 752 753 754 755
      <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>
756
      <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.'/>
757 758 759 760 761
      <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>
762
      <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.'/>
763 764 765
      <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>
766 767 768 769 770 771 772 773 774 775
    <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>
776 777 778 779 780 781 782 783
    <function name='virDomainPinVcpu' file='libvirt' module='libvirt'>
      <info>Dynamically change the real CPUs which can be allocated to a virtual CPU. This function requires priviledged access to the hypervisor.</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, 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>
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
    <function name='virDomainReboot' file='libvirt' module='libvirt'>
      <info>Reboot a domain, the domain object is still usable there after but the domain OS is being stopped for a restart. Note that the guest OS may ignore the request.</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
      <arg name='flags' type='unsigned int' info='extra flags for the reboot operation, not used yet'/>
    </function>
    <function name='virDomainRestore' file='libvirt' module='libvirt'>
      <info>This method will restore a domain saved to disk by virDomainSave().</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='from' type='const char *' info='path to the'/>
    </function>
    <function name='virDomainResume' file='libvirt' module='libvirt'>
      <info>Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires priviledged access</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='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>
807 808 809 810
    <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'/>
811
      <arg name='autostart' type='int' info='whether the domain should be automatically started 0 or 1'/>
812
    </function>
813 814 815 816 817 818 819 820 821 822 823 824
    <function name='virDomainSetMaxMemory' file='libvirt' module='libvirt'>
      <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 priviledged access to the hypervisor.</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 or NULL'/>
      <arg name='memory' type='unsigned long' info='the memory size in kilobytes'/>
    </function>
    <function name='virDomainSetMemory' file='libvirt' module='libvirt'>
      <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 priviledged access to the hypervisor.</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 or NULL'/>
      <arg name='memory' type='unsigned long' info='the memory size in kilobytes'/>
    </function>
825 826 827 828 829 830 831
    <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>
832 833 834 835 836 837
    <function name='virDomainSetVcpus' file='libvirt' module='libvirt'>
      <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 priviledged access to the hypervisor.</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, or NULL for Domain0'/>
      <arg name='nvcpus' type='unsigned int' info='the new number of virtual CPUs for this domain'/>
    </function>
838 839 840 841 842 843 844 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 871 872 873
    <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'>
      <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 priviledged access.</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='virDomainUndefine' file='libvirt' module='libvirt'>
      <info>undefine a domain 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='domain' type='virDomainPtr' info='pointer to a defined domain'/>
    </function>
    <functype name='virErrorFunc' file='virterror' module='virterror'>
      <info>Signature of a function to use when there is an error raised by the library.</info>
      <return type='void'/>
      <arg name='userData' type='void *' info='user provided data for the error callback'/>
      <arg name='error' type='virErrorPtr' info='the error being raised.'/>
    </functype>
    <function name='virGetLastError' file='virterror' module='virterror'>
      <info>Provide a pointer to the last error caught at the library level Simpler but may not be suitable for multithreaded accesses, in which case use virCopyLastError()</info>
      <return type='virErrorPtr' info='a pointer to the last error or NULL if none occured.'/>
    </function>
    <function name='virGetVersion' file='libvirt' module='libvirt'>
      <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 availble, an error code will be returned and @typeVer will be 0.</info>
      <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>
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
    <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'>
      <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. The data structure is freed and should not be used thereafter if the call does not return an error. This function may requires priviledged access</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>
    <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>
901
    <function name='virNetworkGetAutostart' file='libvirt' module='libvirt'>
902 903
      <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'/>
904
      <arg name='network' type='virNetworkPtr' info='a network object'/>
905
      <arg name='autostart' type='int *' info='the value returned'/>
906
    </function>
907
    <function name='virNetworkGetBridgeName' file='libvirt' module='libvirt'>
908 909
      <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.'/>
910 911
      <arg name='network' type='virNetworkPtr' info='a network object'/>
    </function>
912
    <function name='virNetworkGetConnect' file='libvirt' module='libvirt'>
913
      <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>
914
      <return type='virConnectPtr' info='the virConnectPtr or NULL in case of failure.'/>
915 916
      <arg name='net' type='virNetworkPtr' info='pointer to a network'/>
    </function>
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
    <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>
942
      <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.'/>
943 944 945 946 947
      <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>
948
      <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.'/>
949 950 951 952 953
      <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>
954
      <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.'/>
955 956 957
      <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>
958 959 960 961
    <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'/>
962
      <arg name='autostart' type='int' info='whether the network should be automatically started 0 or 1'/>
963
    </function>
964 965 966 967 968
    <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>
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
    <function name='virNodeGetInfo' file='libvirt' module='libvirt'>
      <info>Extract hardware information about the node.</info>
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
      <arg name='info' type='virNodeInfoPtr' info='pointer to a virNodeInfo structure allocated by the user'/>
    </function>
    <function name='virResetError' file='virterror' module='virterror'>
      <info>Reset the error being pointed to</info>
      <return type='void'/>
      <arg name='err' type='virErrorPtr' info='pointer to the virError to clean up'/>
    </function>
    <function name='virResetLastError' file='virterror' module='virterror'>
      <info>Reset the last error caught at the library level.</info>
      <return type='void'/>
    </function>
    <function name='virSetErrorFunc' file='virterror' module='virterror'>
      <info>Set a library global error handling function, if @handler is NULL, it will reset to default printing on stderr. The error raised there are those for which no handler at the connection level could caught.</info>
      <return type='void'/>
      <arg name='userData' type='void *' info='pointer to the user data provided in the handler callback'/>
      <arg name='handler' type='virErrorFunc' info='the function to get called in case of error or NULL'/>
    </function>
990 991
  </symbols>
</api>