libvirt-python-api.xml

   1 <?xml version="1.0"?>
   2 <api name='libvir-python'>
   3   <symbols>
   4     <function name="virConnectListDomainsID" file='python'>
   5       <info>Returns the list of the ID of the domains on the hypervisor</info>
   6       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
   7       <return type='int *' info="the list of ID or None in case of error"/>
   8     </function>
   9     <function name='virDomainLookupByUUID' file='python'>
  10       <info>Try to lookup a domain on the given hypervisor based on its UUID.</info>
  11       <return type='virDomainPtr' info='a new domain object or NULL in case of failure'/>
  12       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
  13       <arg name='uuid' type='const unsigned char *' info='the UUID string for the domain, must be 16 bytes'/>
  14     </function>
  15     <function name='virDomainGetInfo' file='python'>
  16       <info>Extract informations about a domain. Note that if the connection used to get the domain is limited only a partial set of the informations can be extracted.</info>
  17       <return type='int *' info='the list of informations or None in case of error'/>
  18       <arg name='domain' type='virDomainPtr' info='a domain object'/>
  19     </function>
  20     <function name='virNodeGetInfo' file='python'>
  21       <info>Extract hardware informations about the Node.</info>
  22       <return type='int *' info='the list of informations or None in case of error'/>
  23       <arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
  24     </function>
  25     <function name='virDomainGetUUID' file='python'>
  26       <info>Extract the UUID unique Identifier of a domain.</info>
  27       <return type='char *' info='the 16 bytes string or None in case of error'/>
  28       <arg name='domain' type='virDomainPtr' info='a domain object'/>
  29     </function>
  30   </symbols>
  31 </api>