← Back to branch summary

~serge-hallyn/ubuntu/raring/libvirt/libvirt-hugepages

« back to all changes in this revision

Viewing changes to docs/libvirt-api.xml

Tags: upstream-0.2.2
Import upstream version 0.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libvirt-api.xml
9
9
     <exports symbol='LIBVIR_VERSION_NUMBER' type='macro'/>
10
10
     <exports symbol='VIR_USE_CPU' type='macro'/>
11
11
     <exports symbol='VIR_CPU_MAPLEN' type='macro'/>
 
12
     <exports symbol='VIR_UUID_BUFLEN' type='macro'/>
12
13
     <exports symbol='VIR_CPU_USABLE' type='macro'/>
13
14
     <exports symbol='VIR_COPY_CPUMAP' type='macro'/>
 
15
     <exports symbol='VIR_UUID_STRING_BUFLEN' type='macro'/>
14
16
     <exports symbol='VIR_GET_CPUMAP' type='macro'/>
15
17
     <exports symbol='VIR_UNUSE_CPU' type='macro'/>
16
18
     <exports symbol='VIR_DOMAIN_SHUTOFF' type='enum'/>
33
35
     <exports symbol='VIR_DOMAIN_RUNNING' type='enum'/>
34
36
     <exports symbol='VIR_DOMAIN_NOSTATE' type='enum'/>
35
37
     <exports symbol='virNodeInfoPtr' type='typedef'/>
 
38
     <exports symbol='virNetworkPtr' type='typedef'/>
36
39
     <exports symbol='virDomainInfoPtr' type='typedef'/>
37
40
     <exports symbol='virDomainKernelPtr' type='typedef'/>
38
41
     <exports symbol='virConnectPtr' type='typedef'/>
39
42
     <exports symbol='virDomainKernel' type='typedef'/>
40
43
     <exports symbol='virNodeInfo' type='typedef'/>
 
44
     <exports symbol='virNetwork' type='typedef'/>
41
45
     <exports symbol='virDomainState' type='typedef'/>
42
46
     <exports symbol='virDeviceMode' type='typedef'/>
43
47
     <exports symbol='virDomain' type='typedef'/>
54
58
     <exports symbol='_virNodeInfo' type='struct'/>
55
59
     <exports symbol='_virVcpuInfo' type='struct'/>
56
60
     <exports symbol='virDomainGetInfo' type='function'/>
57
 
     <exports symbol='virDomainUndefine' type='function'/>
 
61
     <exports symbol='virNetworkFree' type='function'/>
 
62
     <exports symbol='virNetworkGetName' type='function'/>
 
63
     <exports symbol='virDomainGetName' type='function'/>
 
64
     <exports symbol='virNetworkGetAutostart' type='function'/>
58
65
     <exports symbol='virDomainDefineXML' type='function'/>
59
66
     <exports symbol='virDomainShutdown' type='function'/>
 
67
     <exports symbol='virNetworkUndefine' type='function'/>
60
68
     <exports symbol='virGetVersion' type='function'/>
61
69
     <exports symbol='virConnectListDefinedDomains' type='function'/>
 
70
     <exports symbol='virConnectGetCapabilities' type='function'/>
 
71
     <exports symbol='virNetworkGetUUID' type='function'/>
62
72
     <exports symbol='virDomainLookupByName' type='function'/>
 
73
     <exports symbol='virNetworkLookupByUUID' type='function'/>
 
74
     <exports symbol='virNetworkGetBridgeName' type='function'/>
63
75
     <exports symbol='virDomainPinVcpu' type='function'/>
64
76
     <exports symbol='virDomainRestore' type='function'/>
65
77
     <exports symbol='virConnectGetType' type='function'/>
66
78
     <exports symbol='virDomainSave' type='function'/>
67
79
     <exports symbol='virDomainCreate' type='function'/>
68
80
     <exports symbol='virConnectListDomains' type='function'/>
 
81
     <exports symbol='virNetworkLookupByUUIDString' type='function'/>
 
82
     <exports symbol='virDomainCoreDump' type='function'/>
69
83
     <exports symbol='virDomainLookupByUUID' type='function'/>
70
84
     <exports symbol='virDomainLookupByUUIDString' type='function'/>
71
 
     <exports symbol='virDomainLookupByID' type='function'/>
 
85
     <exports symbol='virConnectNumOfDefinedNetworks' type='function'/>
 
86
     <exports symbol='virDomainUndefine' type='function'/>
72
87
     <exports symbol='virDomainGetOSType' type='function'/>
 
88
     <exports symbol='virConnectListDefinedNetworks' type='function'/>
73
89
     <exports symbol='virNodeGetInfo' type='function'/>
74
90
     <exports symbol='virDomainGetUUID' type='function'/>
 
91
     <exports symbol='virNetworkCreateXML' type='function'/>
 
92
     <exports symbol='virNetworkSetAutostart' type='function'/>
75
93
     <exports symbol='virConnectNumOfDomains' type='function'/>
76
94
     <exports symbol='virDomainGetUUIDString' type='function'/>
77
 
     <exports symbol='virDomainGetVcpus' type='function'/>
78
 
     <exports symbol='virConnectGetVersion' type='function'/>
79
 
     <exports symbol='virDomainSetMaxMemory' type='function'/>
 
95
     <exports symbol='virDomainGetMaxMemory' type='function'/>
 
96
     <exports symbol='virDomainAttachDevice' type='function'/>
 
97
     <exports symbol='virDomainGetMaxVcpus' type='function'/>
80
98
     <exports symbol='virDomainFree' type='function'/>
81
99
     <exports symbol='virConnectOpen' type='function'/>
 
100
     <exports symbol='virDomainSetAutostart' type='function'/>
82
101
     <exports symbol='virDomainSuspend' type='function'/>
 
102
     <exports symbol='virConnectGetMaxVcpus' type='function'/>
83
103
     <exports symbol='virConnectNumOfDefinedDomains' type='function'/>
 
104
     <exports symbol='virNetworkDefineXML' type='function'/>
 
105
     <exports symbol='virNetworkCreate' type='function'/>
84
106
     <exports symbol='virConnectClose' type='function'/>
85
107
     <exports symbol='virDomainReboot' type='function'/>
86
108
     <exports symbol='virInitialize' type='function'/>
87
109
     <exports symbol='virDomainSetVcpus' type='function'/>
 
110
     <exports symbol='virNetworkGetUUIDString' type='function'/>
 
111
     <exports symbol='virNetworkLookupByName' type='function'/>
 
112
     <exports symbol='virNetworkGetXMLDesc' type='function'/>
88
113
     <exports symbol='virDomainGetID' type='function'/>
89
114
     <exports symbol='virDomainResume' type='function'/>
90
115
     <exports symbol='virDomainCreateLinux' type='function'/>
91
116
     <exports symbol='virDomainSetMemory' type='function'/>
 
117
     <exports symbol='virNetworkDestroy' type='function'/>
92
118
     <exports symbol='virDomainDestroy' type='function'/>
93
 
     <exports symbol='virDomainGetMaxMemory' type='function'/>
 
119
     <exports symbol='virConnectNumOfNetworks' type='function'/>
 
120
     <exports symbol='virDomainDetachDevice' type='function'/>
 
121
     <exports symbol='virDomainGetAutostart' type='function'/>
 
122
     <exports symbol='virDomainGetVcpus' type='function'/>
94
123
     <exports symbol='virDomainGetXMLDesc' type='function'/>
95
 
     <exports symbol='virDomainGetName' type='function'/>
 
124
     <exports symbol='virDomainSetMaxMemory' type='function'/>
 
125
     <exports symbol='virConnectGetVersion' type='function'/>
 
126
     <exports symbol='virConnectListNetworks' type='function'/>
 
127
     <exports symbol='virDomainLookupByID' type='function'/>
96
128
     <exports symbol='virConnectOpenReadOnly' type='function'/>
97
129
    </file>
98
130
    <file name='virterror'>
99
131
     <summary>error handling interfaces for the libvirt library</summary>
100
132
     <description>Provides the interfaces of the libvirt library to handle errors raised while using the library. </description>
101
133
     <author>Daniel Veillard &lt;veillard@redhat.com&gt; </author>
 
134
     <exports symbol='VIR_FROM_XML' type='enum'/>
102
135
     <exports symbol='VIR_ERR_CALL_FAILED' type='enum'/>
 
136
     <exports symbol='VIR_ERR_SYSTEM_ERROR' type='enum'/>
103
137
     <exports symbol='VIR_ERR_WARNING' type='enum'/>
104
138
     <exports symbol='VIR_ERR_NO_XEN' type='enum'/>
105
139
     <exports symbol='VIR_ERR_INVALID_ARG' type='enum'/>
114
148
     <exports symbol='VIR_ERR_NO_XENSTORE' type='enum'/>
115
149
     <exports symbol='VIR_FROM_DOM' type='enum'/>
116
150
     <exports symbol='VIR_ERR_INVALID_DOMAIN' type='enum'/>
117
 
     <exports symbol='VIR_FROM_XML' type='enum'/>
 
151
     <exports symbol='VIR_FROM_QEMU' type='enum'/>
118
152
     <exports symbol='VIR_FROM_CONF' type='enum'/>
119
 
     <exports symbol='VIR_ERR_PARSE_FAILED' type='enum'/>
 
153
     <exports symbol='VIR_ERR_INVALID_NETWORK' type='enum'/>
 
154
     <exports symbol='VIR_ERR_OPERATION_DENIED' type='enum'/>
120
155
     <exports symbol='VIR_ERR_NO_KERNEL' type='enum'/>
121
156
     <exports symbol='VIR_ERR_POST_FAILED' type='enum'/>
122
157
     <exports symbol='VIR_ERR_OS_TYPE' type='enum'/>
123
158
     <exports symbol='VIR_ERR_INVALID_CONN' type='enum'/>
124
159
     <exports symbol='VIR_ERR_NONE' type='enum'/>
125
160
     <exports symbol='VIR_ERR_OK' type='enum'/>
 
161
     <exports symbol='VIR_ERR_XML_DETAIL' type='enum'/>
 
162
     <exports symbol='VIR_FROM_NET' type='enum'/>
126
163
     <exports symbol='VIR_ERR_NO_NAME' type='enum'/>
127
164
     <exports symbol='VIR_ERR_NO_ROOT' type='enum'/>
128
165
     <exports symbol='VIR_ERR_OPERATION_FAILED' type='enum'/>
129
166
     <exports symbol='VIR_ERR_GET_FAILED' type='enum'/>
130
167
     <exports symbol='VIR_ERR_DRIVER_FULL' type='enum'/>
131
168
     <exports symbol='VIR_ERR_HTTP_ERROR' type='enum'/>
 
169
     <exports symbol='VIR_ERR_PARSE_FAILED' type='enum'/>
132
170
     <exports symbol='VIR_ERR_NO_SOURCE' type='enum'/>
133
171
     <exports symbol='VIR_ERR_NO_TARGET' type='enum'/>
134
 
     <exports symbol='VIR_ERR_OPERATION_DENIED' type='enum'/>
 
172
     <exports symbol='VIR_ERR_NETWORK_EXIST' type='enum'/>
135
173
     <exports symbol='VIR_ERR_WRITE_FAILED' type='enum'/>
136
174
     <exports symbol='VIR_ERR_INTERNAL_ERROR' type='enum'/>
137
175
     <exports symbol='VIR_ERR_CONF_SYNTAX' type='enum'/>
208
246
      <arg name='cpumap' info='pointer to a bit map of real CPUs (in 8-bit bytes) (IN/OUT)'/>
209
247
      <arg name='cpu' info='the physical CPU number'/>
210
248
    </macro>
 
249
    <macro name='VIR_UUID_BUFLEN' file='libvirt'>
 
250
      <info>This macro provides the length of the buffer required for virDomainGetUUID()</info>
 
251
    </macro>
 
252
    <macro name='VIR_UUID_STRING_BUFLEN' file='libvirt'>
 
253
      <info>This macro provides the length of the buffer required for virDomainGetUUIDString()</info>
 
254
    </macro>
211
255
    <enum name='VIR_DEVICE_DEFAULT' file='libvirt' value='0' type='virDeviceMode' info='Default mode'/>
212
256
    <enum name='VIR_DEVICE_RO' file='libvirt' value='1' type='virDeviceMode' info='Access read-only'/>
213
257
    <enum name='VIR_DEVICE_RW' file='libvirt' value='2' type='virDeviceMode' info='Access read-write'/>
235
279
    <enum name='VIR_ERR_INVALID_ARG' file='virterror' value='8' type='virErrorNumber' info='invalid function argument'/>
236
280
    <enum name='VIR_ERR_INVALID_CONN' file='virterror' value='6' type='virErrorNumber' info='invalid connection object'/>
237
281
    <enum name='VIR_ERR_INVALID_DOMAIN' file='virterror' value='7' type='virErrorNumber' info='invalid domain object'/>
 
282
    <enum name='VIR_ERR_INVALID_NETWORK' file='virterror' value='36' type='virErrorNumber' info='invalid network object'/>
 
283
    <enum name='VIR_ERR_NETWORK_EXIST' file='virterror' value='37' type='virErrorNumber' info='the network already exist'/>
238
284
    <enum name='VIR_ERR_NONE' file='virterror' value='0' type='virErrorLevel'/>
239
285
    <enum name='VIR_ERR_NO_CONNECT' file='virterror' value='5' type='virErrorNumber' info='can&apos;t connect to hypervisor'/>
240
286
    <enum name='VIR_ERR_NO_DEVICE' file='virterror' value='23' type='virErrorNumber' info='missing domain devices information'/>
257
303
    <enum name='VIR_ERR_POST_FAILED' file='virterror' value='11' type='virErrorNumber' info='a HTTP POST command to failed'/>
258
304
    <enum name='VIR_ERR_READ_FAILED' file='virterror' value='31' type='virErrorNumber' info='failed to read a conf file'/>
259
305
    <enum name='VIR_ERR_SEXPR_SERIAL' file='virterror' value='13' type='virErrorNumber' info='failure to serialize an S-Expr'/>
 
306
    <enum name='VIR_ERR_SYSTEM_ERROR' file='virterror' value='38' type='virErrorNumber' info=' general system call failure'/>
260
307
    <enum name='VIR_ERR_UNKNOWN_HOST' file='virterror' value='4' type='virErrorNumber' info='could not resolve hostname'/>
261
308
    <enum name='VIR_ERR_WARNING' file='virterror' value='1' type='virErrorLevel' info='A simple warning'/>
262
 
    <enum name='VIR_ERR_WRITE_FAILED' file='virterror' value='34' type='virErrorNumber' info=' failed to write a conf file'/>
 
309
    <enum name='VIR_ERR_WRITE_FAILED' file='virterror' value='34' type='virErrorNumber' info='failed to write a conf file'/>
263
310
    <enum name='VIR_ERR_XEN_CALL' file='virterror' value='15' type='virErrorNumber' info='failure doing an hypervisor call'/>
 
311
    <enum name='VIR_ERR_XML_DETAIL' file='virterror' value='35' type='virErrorNumber' info='detail of an XML error'/>
264
312
    <enum name='VIR_ERR_XML_ERROR' file='virterror' value='27' type='virErrorNumber' info='an XML description is not well formed or broken'/>
265
 
    <enum name='VIR_FROM_CONF' file='virterror' value='9' type='virErrorDomain' info=' Error in the configuration file handling'/>
 
313
    <enum name='VIR_FROM_CONF' file='virterror' value='9' type='virErrorDomain' info='Error in the configuration file handling'/>
266
314
    <enum name='VIR_FROM_DOM' file='virterror' value='6' type='virErrorDomain' info='Error when operating on a domain'/>
 
315
    <enum name='VIR_FROM_NET' file='virterror' value='11' type='virErrorDomain' info=' Error when operating on a network'/>
267
316
    <enum name='VIR_FROM_NONE' file='virterror' value='0' type='virErrorDomain'/>
268
317
    <enum name='VIR_FROM_PROXY' file='virterror' value='8' type='virErrorDomain' info='Error in the proxy code'/>
 
318
    <enum name='VIR_FROM_QEMU' file='virterror' value='10' type='virErrorDomain' info='Error at the QEMU daemon'/>
269
319
    <enum name='VIR_FROM_RPC' file='virterror' value='7' type='virErrorDomain' info='Error in the XML-RPC code'/>
270
320
    <enum name='VIR_FROM_SEXPR' file='virterror' value='4' type='virErrorDomain' info='Error in the S-Epression code'/>
271
321
    <enum name='VIR_FROM_XEN' file='virterror' value='1' type='virErrorDomain' info='Error at Xen hypervisor layer'/>
318
368
      <field name='str3' type='char *' info=' extra string information'/>
319
369
      <field name='int1' type='int' info=' extra number information'/>
320
370
      <field name='int2' type='int' info=' extra number information'/>
 
371
      <field name='net' type='virNetworkPtr' info=' the network if available'/>
321
372
    </struct>
322
373
    <typedef name='virErrorDomain' file='virterror' type='enum'/>
323
374
    <typedef name='virErrorLevel' file='virterror' type='enum'/>
324
375
    <typedef name='virErrorNumber' file='virterror' type='enum'/>
325
376
    <typedef name='virErrorPtr' file='virterror' type='virError *'/>
 
377
    <struct name='virNetwork' file='libvirt' type='struct _virNetwork'/>
 
378
    <typedef name='virNetworkPtr' file='libvirt' type='virNetwork *'>
 
379
      <info>a virNetworkPtr is pointer to a virNetwork private structure, this is the type used to reference a virtual network in the API.</info>
 
380
    </typedef>
326
381
    <struct name='virNodeInfo' file='libvirt' type='struct _virNodeInfo'>
327
382
      <field name='model' type='charmodel[32]' info=' string indicating the CPU model'/>
328
383
      <field name='memory' type='unsigned long' info=' memory size in kilobytes'/>
372
427
      <return type='int' info='0 in case of success or -1 in case of error.'/>
373
428
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
374
429
    </function>
 
430
    <function name='virConnectGetCapabilities' file='libvirt' module='libvirt'>
 
431
      <info>Provides capabilities of the hypervisor / driver.</info>
 
432
      <return type='char *' info='NULL in case of error, or a pointer to an opaque virCapabilities structure (virCapabilitiesPtr). The client must free the returned string after use.'/>
 
433
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 
434
    </function>
 
435
    <function name='virConnectGetMaxVcpus' file='libvirt' module='libvirt'>
 
436
      <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>
 
437
      <return type='int' info='the maximum of virtual CPU or -1 in case of error.'/>
 
438
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 
439
      <arg name='type' type='const char *' info='value of the &apos;type&apos; attribute in the &lt;domain&gt; element'/>
 
440
    </function>
375
441
    <function name='virConnectGetType' file='libvirt' module='libvirt'>
376
442
      <info>Get the name of the Hypervisor software used.</info>
377
443
      <return type='const char *' info='NULL in case of error, a static zero terminated string otherwise.'/>
387
453
      <info>list the defined domains, stores the pointers to the names in @names</info>
388
454
      <return type='int' info='the number of names provided in the array or -1 in case of error'/>
389
455
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
390
 
      <arg name='names' type='const char **' info='pointer to an array to store the names'/>
 
456
      <arg name='names' type='char ** const' info='pointer to an array to store the names'/>
 
457
      <arg name='maxnames' type='int' info='size of the array'/>
 
458
    </function>
 
459
    <function name='virConnectListDefinedNetworks' file='libvirt' module='libvirt'>
 
460
      <info>list the inactive networks, stores the pointers to the names in @names</info>
 
461
      <return type='int' info='the number of names provided in the array or -1 in case of error'/>
 
462
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 
463
      <arg name='names' type='char ** const' info='pointer to an array to store the names'/>
391
464
      <arg name='maxnames' type='int' info='size of the array'/>
392
465
    </function>
393
466
    <function name='virConnectListDomains' file='libvirt' module='libvirt'>
397
470
      <arg name='ids' type='int *' info='array to collect the list of IDs of active domains'/>
398
471
      <arg name='maxids' type='int' info='size of @ids'/>
399
472
    </function>
 
473
    <function name='virConnectListNetworks' file='libvirt' module='libvirt'>
 
474
      <info>Collect the list of active networks, and store their names in @names</info>
 
475
      <return type='int' info='the number of networks found or -1 in case of error'/>
 
476
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 
477
      <arg name='names' type='char ** const' info='array to collect the list of names of active networks'/>
 
478
      <arg name='maxnames' type='int' info='size of @names'/>
 
479
    </function>
400
480
    <function name='virConnectNumOfDefinedDomains' file='libvirt' module='libvirt'>
401
481
      <info>Provides the number of active domains.</info>
402
482
      <return type='int' info='the number of domain found or -1 in case of error'/>
403
483
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
404
484
    </function>
 
485
    <function name='virConnectNumOfDefinedNetworks' file='libvirt' module='libvirt'>
 
486
      <info>Provides the number of inactive networks.</info>
 
487
      <return type='int' info='the number of networks found or -1 in case of error'/>
 
488
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 
489
    </function>
405
490
    <function name='virConnectNumOfDomains' file='libvirt' module='libvirt'>
406
491
      <info>Provides the number of active domains.</info>
407
492
      <return type='int' info='the number of domain found or -1 in case of error'/>
408
493
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
409
494
    </function>
 
495
    <function name='virConnectNumOfNetworks' file='libvirt' module='libvirt'>
 
496
      <info>Provides the number of active networks.</info>
 
497
      <return type='int' info='the number of network found or -1 in case of error'/>
 
498
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 
499
    </function>
410
500
    <function name='virConnectOpen' file='libvirt' module='libvirt'>
411
501
      <info>This function should be called first to get a connection to the Hypervisor and xen store</info>
412
502
      <return type='virConnectPtr' info='a pointer to the hypervisor connection or NULL in case of error'/>
427
517
      <return type='void'/>
428
518
      <arg name='err' type='virErrorPtr' info='pointer to the error.'/>
429
519
    </function>
 
520
    <function name='virDomainAttachDevice' file='libvirt' module='libvirt'>
 
521
      <info>Create a virtual device attachment to backend.</info>
 
522
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
 
523
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 
524
      <arg name='xml' type='char *' info='pointer to XML description of one device'/>
 
525
    </function>
 
526
    <function name='virDomainCoreDump' file='libvirt' module='libvirt'>
 
527
      <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>
 
528
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
 
529
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
 
530
      <arg name='to' type='const char *' info='path for the core file'/>
 
531
      <arg name='flags' type='int' info='extra flags, currently unused'/>
 
532
    </function>
430
533
    <function name='virDomainCreate' file='libvirt' module='libvirt'>
431
534
      <info>launch a defined domain. If the call succeed the domain moves from the defined to the running domains pools.</info>
432
535
      <return type='int' info='0 in case of success, -1 in case of error'/>
450
553
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
451
554
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
452
555
    </function>
 
556
    <function name='virDomainDetachDevice' file='libvirt' module='libvirt'>
 
557
      <info>Destroy a virtual device attachment to backend.</info>
 
558
      <return type='int' info='0 in case of success, -1 in case of failure.'/>
 
559
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 
560
      <arg name='xml' type='char *' info='pointer to XML description of one device'/>
 
561
    </function>
453
562
    <function name='virDomainFree' file='libvirt' module='libvirt'>
454
563
      <info>Free the domain object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</info>
455
564
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
456
565
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
457
566
    </function>
 
567
    <function name='virDomainGetAutostart' file='libvirt' module='libvirt'>
 
568
      <info>Provides a boolean value indicating whether the domain configured to be automatically started when the host machine boots.</info>
 
569
      <return type='int' info='-1 in case of error, 0 in case of success'/>
 
570
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
 
571
      <arg name='autostart' type='int *' info='the value returned'/>
 
572
    </function>
458
573
    <function name='virDomainGetID' file='libvirt' module='libvirt'>
459
574
      <info>Get the hypervisor ID number for the domain</info>
460
575
      <return type='unsigned int' info='the domain ID number or (unsigned int) -1 in case of error'/>
471
586
      <return type='unsigned long' info='the memory size in kilobytes or 0 in case of error.'/>
472
587
      <arg name='domain' type='virDomainPtr' info='a domain object or NULL'/>
473
588
    </function>
 
589
    <function name='virDomainGetMaxVcpus' file='libvirt' module='libvirt'>
 
590
      <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>
 
591
      <return type='int' info='the maximum of virtual CPU or -1 in case of error.'/>
 
592
      <arg name='domain' type='virDomainPtr' info='pointer to domain object'/>
 
593
    </function>
474
594
    <function name='virDomainGetName' file='libvirt' module='libvirt'>
475
595
      <info>Get the public name for that domain</info>
476
596
      <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.'/>
485
605
      <info>Get the UUID for a domain</info>
486
606
      <return type='int' info='-1 in case of error, 0 in case of success'/>
487
607
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
488
 
      <arg name='uuid' type='unsigned char *' info='pointer to a 16 bytes array'/>
 
608
      <arg name='uuid' type='unsigned char *' info='pointer to a VIR_UUID_BUFLEN bytes array'/>
489
609
    </function>
490
610
    <function name='virDomainGetUUIDString' file='libvirt' module='libvirt'>
491
611
      <info>Get the UUID for a domain as string. For more information about UUID see RFC4122.</info>
492
612
      <return type='int' info='-1 in case of error, 0 in case of success'/>
493
613
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
494
 
      <arg name='buf' type='char *' info='pointer to a 37 bytes array'/>
 
614
      <arg name='buf' type='char *' info='pointer to a VIR_UUID_STRING_BUFLEN bytes array'/>
495
615
    </function>
496
616
    <function name='virDomainGetVcpus' file='libvirt' module='libvirt'>
497
617
      <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>
563
683
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
564
684
      <arg name='to' type='const char *' info='path for the output file'/>
565
685
    </function>
 
686
    <function name='virDomainSetAutostart' file='libvirt' module='libvirt'>
 
687
      <info>Configure the domain to be automatically started when the host machine boots.</info>
 
688
      <return type='int' info='-1 in case of error, 0 in case of success'/>
 
689
      <arg name='domain' type='virDomainPtr' info='a domain object'/>
 
690
      <arg name='autostart' type='int' info='whether the domain should be automatically started 0 or 1'/>
 
691
    </function>
566
692
    <function name='virDomainSetMaxMemory' file='libvirt' module='libvirt'>
567
693
      <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>
568
694
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
617
743
      <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>
618
744
      <return type='int' info='0 in case of success, -1 in case of error'/>
619
745
    </function>
 
746
    <function name='virNetworkCreate' file='libvirt' module='libvirt'>
 
747
      <info>Create and start a defined network. If the call succeed the network moves from the defined to the running networks pools.</info>
 
748
      <return type='int' info='0 in case of success, -1 in case of error'/>
 
749
      <arg name='network' type='virNetworkPtr' info='pointer to a defined network'/>
 
750
    </function>
 
751
    <function name='virNetworkCreateXML' file='libvirt' module='libvirt'>
 
752
      <info>Create and start a new virtual network, based on an XML description similar to the one returned by virNetworkGetXMLDesc()</info>
 
753
      <return type='virNetworkPtr' info='a new network object or NULL in case of failure'/>
 
754
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 
755
      <arg name='xmlDesc' type='const char *' info='an XML description of the network'/>
 
756
    </function>
 
757
    <function name='virNetworkDefineXML' file='libvirt' module='libvirt'>
 
758
      <info>Define a network, but does not create it</info>
 
759
      <return type='virNetworkPtr' info='NULL in case of error, a pointer to the network otherwise'/>
 
760
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 
761
      <arg name='xml' type='const char *' info='the XML description for the network, preferably in UTF-8'/>
 
762
    </function>
 
763
    <function name='virNetworkDestroy' file='libvirt' module='libvirt'>
 
764
      <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>
 
765
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
 
766
      <arg name='network' type='virNetworkPtr' info='a network object'/>
 
767
    </function>
 
768
    <function name='virNetworkFree' file='libvirt' module='libvirt'>
 
769
      <info>Free the network object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</info>
 
770
      <return type='int' info='0 in case of success and -1 in case of failure.'/>
 
771
      <arg name='network' type='virNetworkPtr' info='a network object'/>
 
772
    </function>
 
773
    <function name='virNetworkGetAutostart' file='libvirt' module='libvirt'>
 
774
      <info>Provides a boolean value indicating whether the network configured to be automatically started when the host machine boots.</info>
 
775
      <return type='int' info='-1 in case of error, 0 in case of success'/>
 
776
      <arg name='network' type='virNetworkPtr' info='a network object'/>
 
777
      <arg name='autostart' type='int *' info='the value returned'/>
 
778
    </function>
 
779
    <function name='virNetworkGetBridgeName' file='libvirt' module='libvirt'>
 
780
      <info>Provides a bridge interface name to which a domain may connect a network interface in order to join the network.</info>
 
781
      <return type='char *' info='a 0 terminated interface name, or NULL in case of error. the caller must free() the returned value.'/>
 
782
      <arg name='network' type='virNetworkPtr' info='a network object'/>
 
783
    </function>
 
784
    <function name='virNetworkGetName' file='libvirt' module='libvirt'>
 
785
      <info>Get the public name for that network</info>
 
786
      <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.'/>
 
787
      <arg name='network' type='virNetworkPtr' info='a network object'/>
 
788
    </function>
 
789
    <function name='virNetworkGetUUID' file='libvirt' module='libvirt'>
 
790
      <info>Get the UUID for a network</info>
 
791
      <return type='int' info='-1 in case of error, 0 in case of success'/>
 
792
      <arg name='network' type='virNetworkPtr' info='a network object'/>
 
793
      <arg name='uuid' type='unsigned char *' info='pointer to a VIR_UUID_BUFLEN bytes array'/>
 
794
    </function>
 
795
    <function name='virNetworkGetUUIDString' file='libvirt' module='libvirt'>
 
796
      <info>Get the UUID for a network as string. For more information about UUID see RFC4122.</info>
 
797
      <return type='int' info='-1 in case of error, 0 in case of success'/>
 
798
      <arg name='network' type='virNetworkPtr' info='a network object'/>
 
799
      <arg name='buf' type='char *' info='pointer to a VIR_UUID_STRING_BUFLEN bytes array'/>
 
800
    </function>
 
801
    <function name='virNetworkGetXMLDesc' file='libvirt' module='libvirt'>
 
802
      <info>Provide an XML description of the network. The description may be reused later to relaunch the network with virNetworkCreateXML().</info>
 
803
      <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.'/>
 
804
      <arg name='network' type='virNetworkPtr' info='a network object'/>
 
805
      <arg name='flags' type='int' info='and OR&apos;ed set of extraction flags, not used yet'/>
 
806
    </function>
 
807
    <function name='virNetworkLookupByName' file='libvirt' module='libvirt'>
 
808
      <info>Try to lookup a network on the given hypervisor based on its name.</info>
 
809
      <return type='virNetworkPtr' info='a new network object or NULL in case of failure'/>
 
810
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 
811
      <arg name='name' type='const char *' info='name for the network'/>
 
812
    </function>
 
813
    <function name='virNetworkLookupByUUID' file='libvirt' module='libvirt'>
 
814
      <info>Try to lookup a network on the given hypervisor based on its UUID.</info>
 
815
      <return type='virNetworkPtr' info='a new network object or NULL in case of failure'/>
 
816
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 
817
      <arg name='uuid' type='const unsigned char *' info='the raw UUID for the network'/>
 
818
    </function>
 
819
    <function name='virNetworkLookupByUUIDString' file='libvirt' module='libvirt'>
 
820
      <info>Try to lookup a network on the given hypervisor based on its UUID.</info>
 
821
      <return type='virNetworkPtr' info='a new network object or NULL in case of failure'/>
 
822
      <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
 
823
      <arg name='uuidstr' type='const char *' info='the string UUID for the network'/>
 
824
    </function>
 
825
    <function name='virNetworkSetAutostart' file='libvirt' module='libvirt'>
 
826
      <info>Configure the network to be automatically started when the host machine boots.</info>
 
827
      <return type='int' info='-1 in case of error, 0 in case of success'/>
 
828
      <arg name='network' type='virNetworkPtr' info='a network object'/>
 
829
      <arg name='autostart' type='int' info='whether the network should be automatically started 0 or 1'/>
 
830
    </function>
 
831
    <function name='virNetworkUndefine' file='libvirt' module='libvirt'>
 
832
      <info>Undefine a network but does not stop it if it is running</info>
 
833
      <return type='int' info='0 in case of success, -1 in case of error'/>
 
834
      <arg name='network' type='virNetworkPtr' info='pointer to a defined network'/>
 
835
    </function>
620
836
    <function name='virNodeGetInfo' file='libvirt' module='libvirt'>
621
837
      <info>Extract hardware information about the node.</info>
622
838
      <return type='int' info='0 in case of success and -1 in case of failure.'/>