Skip to content

Commit 46aa57d

Browse files
committed
Updated Licenses, README.
Signed-off-by: Ankit Agrawal <aagrawal3@vmware.com>
1 parent 526b72c commit 46aa57d

5 files changed

Lines changed: 2854 additions & 11 deletions

File tree

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: 51 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, 2.3, 3.0 and VMC 1.7, 1.8, 1.9, 1.10, 1.11, 1.12, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19
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,56 @@ 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 installed. The three installation options are provided for different environments. Be sure to upgrade to the latest pip and setuptools.
4546

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

49+
##### 1. Typical Installation
50+
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.
51+
52+
Install/Update latest setuptools from PyPi
4853
```cmd
4954
pip install --upgrade pip setuptools
50-
pip install --upgrade git+https://github.com/vmware/vsphere-automation-sdk-python.git
55+
```
56+
Install SDK packages from Github.
57+
```cmd
58+
pip install --upgrade git+https://gitlab.eng.vmware.com/vapi-sdk/vsphere-automation-sdk-python.git
59+
```
60+
61+
##### 2. Local installation
62+
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.
63+
64+
Install all the wheel files from SDK lib directory
65+
```cmd
66+
pip install -U lib/*/*.whl
67+
```
68+
Install dependencies like lxml and pyvmomi from PyPi as other requirements were installed from SDK lib directory
69+
```cmd
70+
pip install -U <SDK_DIRECTORY>
5171
```
5272

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

5596
### Connect to a vCenter Server
5697

@@ -79,7 +120,7 @@ Output in a Python Interpreter:
79120

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

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

214255
### vSphere API Documentation
215256

216-
* [VMware Cloud on AWS vSphere (latest version)](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/cloud/index.html)
257+
* [VMware vSphere REST API Reference documentation](https://developer.vmware.com/docs/vsphere-automation/latest/)
217258
* [vSphere 8.0.0.0 (latest)](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/8.0.0.0/)
218259
* Previous Releases: vSphere [7.0.3.2](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/7.0.3.2/),
219260
[7.0 U3](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/7.0.3.0/)
220261
[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).
221262

222263
### VMware Cloud on AWS API Documentation
223264

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

@@ -247,6 +289,7 @@ Members:
247289
* Jobin George (VMware)
248290
* Martin Tsvetanov (VMware)
249291
* Shweta Purohit (VMware)
292+
* Kunal Singh (VMware)
250293

251294
## VMware Resources
252295

0 commit comments

Comments
 (0)