Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-27 11:39:58 -05:00
Code

Updated Licenses, README.

Browse Source 
Signed-off-by: Ankit Agrawal <aagrawal3@vmware.com>
This commit is contained in:
aagrawal3 2022-09-26 15:16:14 +05:30
parent 526b72cc47
commit 46aa57de24
No known key found for this signature in database
GPG Key ID: D6EA3E657D229A55
5 changed files with 2854 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
LICENSE
View File

@ -1,6 +1,12 @@
The MIT License LICENSE
Copyright 2017 VMware Inc. vsphere_automation_sdk_python 8.0
Copyright (c) 2016-2022 VMware, Inc. All rights reserved.
This product is licensed to you under the MIT License (the License). You may not use this product except in compliance with the License.
MIT License
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: 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:

59
README.md
View File

@ -18,7 +18,7 @@ This document describes the vSphere Automation Python SDK samples that use the v
python client library. Additionally, some of the samples demonstrate the combined use of the python client library. Additionally, some of the samples demonstrate the combined use of the
vSphere Automation and vSphere APIs. To support this combined use, the vSphere Automation Python SDK vSphere Automation and vSphere APIs. To support this combined use, the vSphere Automation Python SDK
samples require the vSphere Management SDK packages (pyVmomi) to be installed on the client. samples require the vSphere Management SDK packages (pyVmomi) to be installed on the client.
The samples have been developed to work with python 2.7.x and 3.3+ The samples have been developed to work with python 3.8+
## Supported OnPrem vCenter Releases ## Supported OnPrem vCenter Releases
vCenter 6.5, 6.7, 7.0, 7.0U1, 7.0U2 and 7.0U2 mp1, 7.0U3, 7.0.3.2 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
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 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
## Latest VMware Cloud on AWS Release: ## Latest VMware Cloud on AWS Release:
VMC M19 (1.19) ([Release Notes](https://docs.vmware.com/en/VMware-Cloud-on-AWS/0/rn/vmc-on-aws-relnotes.html)) VMC M20 (1.20) ([Release Notes](https://docs.vmware.com/en/VMware-Cloud-on-AWS/0/rn/vmc-on-aws-relnotes.html))
## Quick Start Guide ## Quick Start Guide
@ -42,15 +42,56 @@ A Python virtual environment is also highly recommended.
* [Install a virtual env for Python 3](https://docs.python.org/3/tutorial/venv.html) * [Install a virtual env for Python 3](https://docs.python.org/3/tutorial/venv.html)
### Installing Required Python Packages ### Installing Required Python Packages
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.
Be sure to upgrade to the latest pip and setuptools. **NOTE:** The SDK also requires OpenSSL 1.0.1+ in order to support TLS1.1 & 1.2
##### 1. Typical Installation
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.
Install/Update latest setuptools from PyPi
```cmd ```cmd
pip install --upgrade pip setuptools pip install --upgrade pip setuptools
pip install --upgrade git+https://github.com/vmware/vsphere-automation-sdk-python.git ```
Install SDK packages from Github.
```cmd
pip install --upgrade git+https://gitlab.eng.vmware.com/vapi-sdk/vsphere-automation-sdk-python.git
``` ```
**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 ##### 2. Local installation
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.
Install all the wheel files from SDK lib directory
```cmd
pip install -U lib/*/*.whl
```
Install dependencies like lxml and pyvmomi from PyPi as other requirements were installed from SDK lib directory
```cmd
pip install -U <SDK_DIRECTORY>
```
##### 3. Installation in an air gap environment
For these type of environment an additional step is required to ensure SDK's dependencies are available.
Following dependencies have to be downloaded from PyPi and transferred to the air gap environment.
This step has to be done in an environment which has PyPI access.
```cmd
pip download -r requirements_pypi.txt -d lib
zip -r lib.zip lib/
```
Following on the air gap environment.
Unzip the lib.zip under automation SDK home directory
```cmd
unzip lib.zip
```
Install all the dependencies and packages
```cmd
pip install -U lib/*/*.whl
```
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.
```cmd
pip install -U `pwd`
```
### Connect to a vCenter Server ### Connect to a vCenter Server
@ -79,7 +120,7 @@ Output in a Python Interpreter:
```shell ```shell
(venv) het-m03:vsphere-automation-sdk-python het$ python (venv) het-m03:vsphere-automation-sdk-python het$ python
Python 3.6.3 (v3.6.3:2c5fed86e0, Oct 3 2017, 00:32:08) Python 3.9.8 (main, Nov 10 2021, 06:03:50)
[GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin [GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin
Type "help", "copyright", "credits" or "license" for more information. Type "help", "copyright", "credits" or "license" for more information.
>>> import requests >>> import requests
@ -112,7 +153,7 @@ Output in a Python Interpreter:
```shell ```shell
(venv) het-m03:vsphere-automation-sdk-python het$ python (venv) het-m03:vsphere-automation-sdk-python het$ python
Python 3.6.3 (v3.6.3:2c5fed86e0, Oct 3 2017, 00:32:08) Python 3.9.8 (main, Nov 10 2021, 06:03:50)
[GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin [GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin
Type "help", "copyright", "credits" or "license" for more information. Type "help", "copyright", "credits" or "license" for more information.
>>> from vmware.vapi.vmc.client import create_vmc_client >>> from vmware.vapi.vmc.client import create_vmc_client
@ -213,7 +254,7 @@ $ python samples/vsphere/vcenter/vm/list_vms.py -v
### vSphere API Documentation ### vSphere API Documentation
* [VMware Cloud on AWS vSphere (latest version)](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/cloud/index.html) * [VMware vSphere REST API Reference documentation](https://developer.vmware.com/docs/vsphere-automation/latest/)
* [vSphere 8.0.0.0 (latest)](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/8.0.0.0/) * [vSphere 8.0.0.0 (latest)](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/8.0.0.0/)
* Previous Releases: vSphere [7.0.3.2](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/7.0.3.2/), * Previous Releases: vSphere [7.0.3.2](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/7.0.3.2/),
[7.0 U3](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/7.0.3.0/) [7.0 U3](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/7.0.3.0/)
@ -221,6 +262,7 @@ $ python samples/vsphere/vcenter/vm/list_vms.py -v
### VMware Cloud on AWS API Documentation ### VMware Cloud on AWS API Documentation
* [VMware Cloud on AWS REST APIs](http://developers.eng.vmware.com/docs/vmc/latest/)
* [VMware Cloud on AWS Console API](https://vmware.github.io/vsphere-automation-sdk-python/vmc/index.html) * [VMware Cloud on AWS Console API](https://vmware.github.io/vsphere-automation-sdk-python/vmc/index.html)
* [VMware Cloud on AWS Disaster Recovery as a Service (DRaaS) API](https://vmware.github.io/vsphere-automation-sdk-python/vmc-draas/index.html) * [VMware Cloud on AWS Disaster Recovery as a Service (DRaaS) API](https://vmware.github.io/vsphere-automation-sdk-python/vmc-draas/index.html)
@ -247,6 +289,7 @@ Members:
* Jobin George (VMware) * Jobin George (VMware)
* Martin Tsvetanov (VMware) * Martin Tsvetanov (VMware)
* Shweta Purohit (VMware) * Shweta Purohit (VMware)
* Kunal Singh (VMware)
## VMware Resources ## VMware Resources

2792
open_source_licenses.txt Normal file
View File

File diff suppressed because it is too large Load Diff

2
requirements_pypi.txt Normal file
View File

@ -0,0 +1,2 @@
lxml >= 4.3.0
pyVmomi >= 6.7

2
setup.py
View File

@ -5,7 +5,7 @@ import os
from setuptools import setup from setuptools import setup
setup(name='vSphere Automation SDK', setup(name='vSphere Automation SDK',
version='1.80.0', version='1.79.0',
description='VMware vSphere Automation SDK for Python', description='VMware vSphere Automation SDK for Python',
url='https://github.com/vmware/vsphere-automation-sdk-python', url='https://github.com/vmware/vsphere-automation-sdk-python',
author='VMware, Inc.', author='VMware, Inc.',