Release of libvirt-python-4.5.0
[libvirt-python/ericb.git] / examples / README
blob13211b6ca0713546f3dda4bba7636c18f8bf5365
1 Some simple examples on how to use the Python API for libvirt
3 The examples are:
5 dominfo.py  - print information about a running domU based on the results of
6               virDomainGetInfo and virDomainGetXMLDesc
7 domstart.py - create a domU from an XML description if the domU isn't
8               running yet
9 domsave.py  - save all running domU's into a directory
10 domrestore.py - restore domU's from their saved files in a directory
11 esxlist.py  - list active domains of an VMware ESX host and print some info.
12               also demonstrates how to use the libvirt.openAuth() method
13 dhcpleases.py - list dhcp leases for a given virtual network
14 domipaddrs.py - list IP addresses for guest domains
15 guest-vcpus - two helpers to make the guest agent event useful with agent based
16               vCPU state modification
17 nodestats.py - print total memory and free memory for each host NUMA node and
18                the memory strictly bound to certain host nodes for each running
19                domain.
21 The XML files in this directory are examples of the XML format that libvirt
22 expects, and will have to be adapted for your setup. They are only needed
23 for domstart.py
26 Some additional notes for the esxlist.py example:
28 You may see remote errors complaining about missing certificates:
30   Cannot access CA certificate '/usr/local/etc/pki/CA/cacert.pem': No such file
31   or directory
33 This is expected, libvirt tries to find network and storage drivers for ESX,
34 but those are not implemented yet (November 2009). While searching for this
35 drivers, libvirt may try to start a local libvirtd instance, but fails because
36 of the missing certificates. It'll warn about that:
38   Failed to find the network: Is the daemon running?
40 This is also expected and can be ignored.