diff --git a/samples/vsphere/vcenter/README.md b/samples/vsphere/vcenter/README.md new file mode 100644 index 00000000..dd9c2bb5 --- /dev/null +++ b/samples/vsphere/vcenter/README.md @@ -0,0 +1,20 @@ +vAPI Samples for Managing vSphere Infrastructure and Virtual Machines + +The directory vsphere.samples.vcenter contains samples for the vSphere infrastructure and virtual machine APIs. You have two options to run samples inside this package: + + * Run all samples under vcenter folder using main.py in samples.vsphere.vcenter.setup package. + Please see the [README](../../../README.md#running-a-complex-sample) for more details. + + * Run an individual sample in an existing environment. + You can either pass the environment parameters through command line arguments or specify them in setup.py in the setup package. + For example, to run the create_default_vm sample in the vsphere.samples.vcenter.vm.create package: + + * $ cd /path/to/vsphere-automation-sdk-python-samples/client/bin + + * Run the sample with the testbed settings specified in setup.py in a Linux machine: + + * $ ./run_sample.sh ../samples/vsphere/vcenter/vm/create/create_default_vm.py -v + + * Or specify the credentials using command line parameters: + + * $ ./run_sample.sh ../samples/vsphere/vcenter/vm/create/create_default_vm.py -s -u -p -v \ No newline at end of file