Move python example programs into python/examples/ subdirectory

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

1 files changed, 33 insertions, 0 deletions

diff --git a/examples/README b/examples/README
new file mode 100644
index 0000000..f4db76c
--- /dev/null
+++ b/examples/README
@@ -0,0 +1,33 @@
+Some simple examples on how to use the Python API for libvirt
+
+The examples are:
+
+dominfo.py  - print information about a running domU based on the results of
+              virDomainGetInfo and virDomainGetXMLDesc
+domstart.py - create a domU from an XML description if the domU isn't
+              running yet
+domsave.py  - save all running domU's into a directory
+domrestore.py - restore domU's from their saved files in a directory
+esxlist.py  - list active domains of an VMware ESX host and print some info.
+              also demonstrates how to use the libvirt.openAuth() method
+
+The XML files in this directory are examples of the XML format that libvirt
+expects, and will have to be adapted for your setup. They are only needed
+for domstart.py
+
+
+Some additional notes for the esxlist.py example:
+
+You may see remote errors complaining about missing certificates:
+
+  Cannot access CA certificate '/usr/local/etc/pki/CA/cacert.pem': No such file
+  or directory
+
+This is expected, libvirt tries to find network and storage drivers for ESX,
+but those are not implemented yet (November 2009). While searching for this
+drivers, libvirt may try to start a local libvirtd instance, but fails because
+of the missing certificates. It'll warn about that:
+
+  Failed to find the network: Is the daemon running?
+
+This is also expected and can be ignored.