You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This document describes the vSphere Automation Python SDK samples that use the vSphere Automation
@@ -39,52 +26,100 @@ Certain APIs and samples that are introduced in 6.5 release, such as vCenter, Vi
39
26
The VMware Cloud on AWS API and samples are currently available as a preview and are subject to change in the future.
40
27
41
28
## Quick Start Guide
42
-
This document will walk you through getting up and running with the Python SDK Samples.
43
-
Prior to running the samples you will need to setup a vCenter test environment and
44
-
install local Python packages, the following steps will take you through this process.
45
29
46
-
Before you can run the SDK samples we'll need to walk you through the following steps:
30
+
### Prepare a Python Development Environment
47
31
48
-
1. Installing the required Python packages
49
-
2. Setting up a vSphere test environment
50
-
3. Running SDK Samples setup script
32
+
We recommend you to install latest [Python](http://docs.python-guide.org/en/latest/starting/installation/) and
33
+
[pip](https://pypi.python.org/pypi/pip/) on your system.
51
34
52
-
### Installing the required Python Packages
53
-
**Note:** The SDK requires Python v2.7+ (preferably v3.6) to run the setup/samples,
54
-
please make sure you have the appropriate version installed before continuing.
55
-
If you are on macOS/OSX/Linux, please note that the system installed version of
56
-
Python may be outdated and/or not be intended for development and we recommended you [install Python](http://docs.python-guide.org/en/latest/starting/installation/) yourself before installing the required packages. [Virtualenv](https://virtualenv.pypa.io/en/stable/) is also highly recommended.
35
+
A Python virtual environment is also highly recommended.
36
+
*[Install a virtual env for Python 2](https://virtualenv.pypa.io/en/stable/)
37
+
*[Install a virtual env for Python 3](https://docs.python.org/3/tutorial/venv.html)
57
38
58
-
The required packages are:
59
-
60
-
* pyVmomi
61
-
* suds (suds-jurko for python3+)
62
-
* vapi-client-bindings
63
-
* vmc-client-bindings
64
-
* vapi-vmc-client
65
-
66
-
These dependencies are listed in the requirements.txt file and installed using "pip install"; For more details on how to install python packages using pip please refer to the [pip user guide](http://pip.readthedocs.io/en/latest/user_guide/).
**NOTE:** The SDK also requires OpenSSL 1.0.1+ if you want to connect to vSphere 6.5+ in order to support TLS1.1 & 1.2
73
48
74
-
### Setting up a vSphere Test Environment
75
-
**NOTE:** The samples are intended to be run against a freshly installed **non-Production** vSphere setup as the scripts may make changes to the test environment and in some cases can destroy items when needed.
49
+
### Connect to a vCenter Server
76
50
77
-
To run the samples a vSphere test environment is required with the following configuration
78
-
* 1 vCenter Server
79
-
* 2 ESX hosts
80
-
* 1 NFS Datastore with at least 3GB of free capacity
51
+
```python
52
+
import requests
53
+
import urllib3
54
+
from vmware.vapi.vsphere.client import create_vsphere_client
55
+
session = requests.session()
56
+
57
+
# Disable cert verification for demo purpose.
58
+
# This is not recommended in a production environment.
59
+
session.verify =False
60
+
61
+
# Disable the secure connection warning for demo purpose.
62
+
# This is not recommended in a production environment.
from vmware.vapi.vmc.client import create_vmc_client
95
+
96
+
# Connect to VMware Cloud on AWS using refresh token
97
+
vmc_client = create_vmc_client('<refresh_token>')
81
98
82
-
Please have the details of these available but do not have any configuration pre-created on vCenter server or ESXi Hosts, for example there should be no existing datacenters, clusters or attached hosts on the vCenter server.
Before executing the samples we'll need to setup the vSphere test environment using one of the sample scripts. Before we run the script we'll need to edit one of the files and provide IP addresses for the various machine instances.
117
+
## Run SDK Samples
86
118
87
-
First, set PYTHONPATH to use SDK helper methods
119
+
In this section we will walk you through the steps to run the sample code for vSphere
120
+
and VMware Cloud on AWS APIs.
121
+
122
+
### First, set PYTHONPATH to use SDK helper methods
88
123
89
124
* Linux/Mac:
90
125
@@ -94,28 +129,25 @@ First, set PYTHONPATH to use SDK helper methods
94
129
95
130
set PYTHONPATH=%cd%;%PYTHONPATH%
96
131
97
-
Next, using a text editor open ../samples/vsphere/vcenter/setup/testbed.py and edit the following settings replace everything in < > brackets with your environment information. Leave the rest of the settings in this file at their default values.
A vSphere test environment is required with the following configuration:
141
+
* 1 vCenter Server
142
+
* 2 ESX hosts
143
+
* 1 NFS Datastore with at least 3GB of free capacity
144
+
145
+
**Note** Please have the details of these available but do not have any configuration pre-created on vCenter server or ESXi Hosts, for example there should be no existing datacenters, clusters or attached hosts on the vCenter server.
113
146
114
-
Save and close the file.
147
+
#### Running the SDK Sample Setup Script
115
148
116
-
At this point, we're ready to run the setupscript.
149
+
Before executing the samples we'll need to setup the vSphere test environment using one of the sample scripts (samples/vsphere/vcenter/setup/main.py). The script will perform the following:
117
150
118
-
This script will perform the following:
119
151
* Create 2 test Datacenters
120
152
* Create a test Cluster
121
153
* Create Test Folders for VM Storage
@@ -126,33 +158,51 @@ This script will perform the following:
126
158
* Copy the [Photon OS](https://vmware.github.io/photon/) ISO image downloaded from [VMware's bintray server](https://dl.bintray.com/vmware/photon) to the datastore
127
159
* Create directories to add sample ports
128
160
161
+
First, edit settings in samples/vsphere/vcenter/setup/testbed.py and replace everything in < > brackets with your environment information. Leave the rest of the settings in this file at their default values.
129
162
130
-
**Note:** The setup script may take several minutes to complete.
163
+
```python
164
+
config["SERVER"] ="<vcenter_hostname_or_ip>"
165
+
config["USERNAME"] ="<vsphere_username>"
166
+
config["PASSWORD"] ="<vsphere_password>"
167
+
168
+
config["ESX_HOST1"] ="<ESX_host1_ipaddress>"
169
+
config["ESX_HOST2"] ="<ESX_host2_ipaddress>"
170
+
config["ESX_USER"] ="<esx_username>"
171
+
config["ESX_PASS"] ="<esx_password>"
172
+
173
+
config["USE_NFS"] =True
174
+
config["NFS_HOST"] ="<nfs_ipaddress>"
175
+
config["NFS_REMOTE_PATH"] ="/store1"
176
+
```
131
177
132
-
**To view the available command-line options:**
178
+
At this point, we're ready to run the setup script:
After completion you will see from the output and also the vSphere Client that the environment has now been fully setup and is ready to easily run further samples.
After completion you will see from the output and also the vSphere Webclient that the environment has now been fully setup and is ready to easily run further samples.
192
+
#### Run the vAPI vCenter sample suite:
145
193
146
-
### Running a complex sample
147
-
This SDK includes a sample script which can be used to perform a number of actions and give you an indication of how to perform multiple vCenter actions, this script is located in the /samples/vsphere/vcenter/setup/ directory, use the following instructions to run this sample:
The API documentation can be found [here](doc/client.zip)
157
207
158
208
## Submitting samples
@@ -162,10 +212,12 @@ The API documentation can be found [here](doc/client.zip)
162
212
Before you start working with this project, please read our [Developer Certificate of Origin](https://cla.vmware.com/dco). All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.
163
213
164
214
### Sample Template
215
+
165
216
[Sample template](sample_template) contains boilerplate code that can be used to build a new sample.
166
217
Please copy the file and use it as a starting point to write a new sample.
167
218
168
219
### Required Information
220
+
169
221
The following information must be included in the README.md or in the sample docstring in case README already exists in same folder.
170
222
* Author Name
171
223
* This can include full name, email address or other identifiable piece of information that would allow interested parties to contact author with questions.
@@ -174,6 +226,7 @@ The following information must be included in the README.md or in the sample doc
174
226
* Any KNOWN limitations or dependencies
175
227
176
228
### Suggested Information
229
+
177
230
The following information should be included when possible. Inclusion of information provides valuable information to consumers of the resource.
178
231
* vSphere version against which the sample was developed/tested
179
232
* SDK version against which the sample was developed/tested
@@ -194,18 +247,25 @@ Please conform to pep8 standards. Check your code by running the pep8 tool.
194
247
195
248
## Resource Maintenance
196
249
### Maintenance Ownership
250
+
197
251
Ownership of any and all submitted samples are maintained by the submitter.
252
+
198
253
### Filing Issues
254
+
199
255
Any bugs or other issues should be filed within GitHub by way of the repository’s Issue Tracker.
256
+
200
257
### Resolving Issues
258
+
201
259
Any community member can resolve issues within the repository, however only the board member can approve the update. Once approved, assuming the resolution involves a pull request, only a board member will be able to merge and close the request.
202
260
203
261
### VMware Sample Exchange
262
+
204
263
It is highly recommended to add any and all submitted samples to the VMware Sample Exchange: <https://code.vmware.com/samples>
205
264
206
265
Sample Exchange can be allowed to access your GitHub resources, by way of a linking process, where they can be indexed and searched by the community. There are VMware social media accounts which will advertise resources posted to the site and there's no additional accounts needed, as the VMware Sample Exchange uses MyVMware credentials.
207
266
208
267
## Repository Administrator Resources
268
+
209
269
### Board Members
210
270
211
271
Board members are volunteers from the SDK community and VMware staff members, board members are not held responsible for any issues which may occur from running of samples from this repository.
@@ -215,6 +275,7 @@ Members:
215
275
* Steve Trefethen (VMware)
216
276
217
277
### Approval of Additions
278
+
218
279
Items added to the repository, including items from the Board members, require 2 votes from the board members before being added to the repository. The approving members will have ideally downloaded and tested the item. When two “Approved for Merge” comments are added from board members, the pull can then be committed to the repository.
0 commit comments