Skip to content

Commit 83d41bd

Browse files
authored
Merge pull request #332 from aagrawal3/master
Update VMC and DRAAS bindings
2 parents 553f623 + 6778350 commit 83d41bd

13 files changed

+2859
-15
lines changed

LICENSE

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
The MIT License
1+
LICENSE
22

3-
Copyright 2017 VMware Inc.
3+
vsphere_automation_sdk_python 8.0
4+
5+
Copyright (c) 2016-2022 VMware, Inc. All rights reserved.
6+
7+
This product is licensed to you under the MIT License (the License). You may not use this product except in compliance with the License.
8+
9+
MIT License
410

511
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
612

README.md

Lines changed: 52 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This document describes the vSphere Automation Python SDK samples that use the v
1818
python client library. Additionally, some of the samples demonstrate the combined use of the
1919
vSphere Automation and vSphere APIs. To support this combined use, the vSphere Automation Python SDK
2020
samples require the vSphere Management SDK packages (pyVmomi) to be installed on the client.
21-
The samples have been developed to work with python 2.7.x and 3.3+
21+
The samples have been developed to work with python 3.8+
2222

2323
## Supported OnPrem vCenter Releases
2424
vCenter 6.5, 6.7, 7.0, 7.0U1, 7.0U2 and 7.0U2 mp1, 7.0U3, 7.0.3.2
@@ -28,7 +28,7 @@ Certain APIs and samples that are introduced in 6.5 release, such as vCenter, Vi
2828
NSX-T 2.2 - 4.0 and VMC 1.7 - 1.20
2929

3030
## Latest VMware Cloud on AWS Release:
31-
VMC M19 (1.19) ([Release Notes](https://docs.vmware.com/en/VMware-Cloud-on-AWS/0/rn/vmc-on-aws-relnotes.html))
31+
VMC M20 (1.20) ([Release Notes](https://docs.vmware.com/en/VMware-Cloud-on-AWS/0/rn/vmc-on-aws-relnotes.html))
3232

3333
## Quick Start Guide
3434

@@ -42,15 +42,57 @@ A Python virtual environment is also highly recommended.
4242
* [Install a virtual env for Python 3](https://docs.python.org/3/tutorial/venv.html)
4343

4444
### Installing Required Python Packages
45+
SDK package installation commands may differ depending on the environment where it is being installed. The three installation options provided below are for different environments.
46+
*pip* and *setuptools* are common requirements for these installation types, upgrade to the latest *pip* and *setuptools*.
4547

46-
Be sure to upgrade to the latest pip and setuptools.
48+
**NOTE:** The SDK also requires OpenSSL 1.0.1+ in order to support TLS1.1 & 1.2
4749

50+
##### 1. Typical Installation
51+
This is the recommended way to install the SDK. The installation is done from [PyPI](https://pypi.org/) and [Automation SDK Python Github](https://github.com/vmware/vsphere-automation-sdk-python) repositories.
52+
53+
Install/Update latest setuptools from PyPI
4854
```cmd
4955
pip install --upgrade pip setuptools
50-
pip install --upgrade git+https://github.com/vmware/vsphere-automation-sdk-python.git
56+
```
57+
Install SDK packages from Github.
58+
```cmd
59+
pip install --upgrade git+https://gitlab.eng.vmware.com/vapi-sdk/vsphere-automation-sdk-python.git
60+
```
61+
62+
##### 2. Local installation
63+
Local installation can be used in an environment which either do not have Github access or users do not want to install from Github repository.
64+
65+
Install all the wheel files from SDK's lib directory
66+
```cmd
67+
pip install -U lib/*/*.whl
68+
```
69+
Install dependencies like *lxml* and *pyvmomi* from PyPI as other requirements were installed from SDK's lib directory
70+
```cmd
71+
pip install -U <SDK_DIRECTORY>
5172
```
5273

53-
**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
74+
##### 3. Installation in an air gap environment
75+
For this type of environment an additional step is required to ensure SDK's dependencies are available.
76+
Following dependencies have to be downloaded from PyPI and transferred to the air gap environment.
77+
78+
**NOTE:** This step has to be done in an environment which has PyPI access.
79+
```cmd
80+
pip download -r requirements_pypi.txt -d lib
81+
zip -r lib.zip lib/
82+
```
83+
Follow these steps in the air gap environment.
84+
Unzip the lib.zip under automation SDK home directory
85+
```cmd
86+
unzip lib.zip
87+
```
88+
Install all the dependencies and packages
89+
```cmd
90+
pip install -U lib/*/*.whl
91+
```
92+
This is to install the "vSphere-Automation-SDK" which provides an SDK version. It also ensures that all the SDK requirements are installed. If not, the installation will fail.
93+
```cmd
94+
pip install -U `pwd`
95+
```
5496

5597
### Connect to a vCenter Server
5698

@@ -79,7 +121,7 @@ Output in a Python Interpreter:
79121

80122
```shell
81123
(venv) het-m03:vsphere-automation-sdk-python het$ python
82-
Python 3.6.3 (v3.6.3:2c5fed86e0, Oct 3 2017, 00:32:08)
124+
Python 3.9.8 (main, Nov 10 2021, 06:03:50)
83125
[GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin
84126
Type "help", "copyright", "credits" or "license" for more information.
85127
>>> import requests
@@ -112,7 +154,7 @@ Output in a Python Interpreter:
112154

113155
```shell
114156
(venv) het-m03:vsphere-automation-sdk-python het$ python
115-
Python 3.6.3 (v3.6.3:2c5fed86e0, Oct 3 2017, 00:32:08)
157+
Python 3.9.8 (main, Nov 10 2021, 06:03:50)
116158
[GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin
117159
Type "help", "copyright", "credits" or "license" for more information.
118160
>>> from vmware.vapi.vmc.client import create_vmc_client
@@ -213,14 +255,15 @@ $ python samples/vsphere/vcenter/vm/list_vms.py -v
213255

214256
### vSphere API Documentation
215257

216-
* [VMware Cloud on AWS vSphere (latest version)](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/cloud/index.html)
258+
* [VMware vSphere REST API Reference documentation](https://developer.vmware.com/docs/vsphere-automation/latest/)
217259
* [vSphere 8.0.0.0 (latest)](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/8.0.0.0/)
218260
* Previous Releases: vSphere [7.0.3.2](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/7.0.3.2/),
219261
[7.0 U3](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/7.0.3.0/)
220262
[7.0 U2](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/7.0.2.0/), [7.0 U1](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/7.0.1.0/), [7.0](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/7.0.0.1/), [6.7.0](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/6.7.0), [6.6.1](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/6.6.1), [6.5](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/6.5).
221263

222264
### VMware Cloud on AWS API Documentation
223265

266+
* [VMware Cloud on AWS REST APIs](http://developers.eng.vmware.com/docs/vmc/latest/)
224267
* [VMware Cloud on AWS Console API](https://vmware.github.io/vsphere-automation-sdk-python/vmc/index.html)
225268
* [VMware Cloud on AWS Disaster Recovery as a Service (DRaaS) API](https://vmware.github.io/vsphere-automation-sdk-python/vmc-draas/index.html)
226269

@@ -247,6 +290,7 @@ Members:
247290
* Jobin George (VMware)
248291
* Martin Tsvetanov (VMware)
249292
* Shweta Purohit (VMware)
293+
* Kunal Singh (VMware)
250294

251295
## VMware Resources
252296

1.89 KB
Binary file not shown.
Binary file not shown.

lib/vmc-client-bindings/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<a href='vmc_client_bindings-1.60.0-py2.py3-none-any.whl'>vmc_client_bindings-1.60.0-py2.py3-none-any.whl</a><br />
1+
<a href='vmc_client_bindings-1.61.0-py2.py3-none-any.whl'>vmc_client_bindings-1.61.0-py2.py3-none-any.whl</a><br />
Binary file not shown.
Binary file not shown.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<a href='vmc_draas_client_bindings-1.19.0-py2.py3-none-any.whl'>vmc_draas_client_bindings-1.19.0-py3.py3-none-any.whl</a><br />
1+
<a href='vmc_draas_client_bindings-1.20.0-py2.py3-none-any.whl'>vmc_draas_client_bindings-1.20.0-py3.py3-none-any.whl</a><br />
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)