Merge pull request #441 from vmware/revert-440-master

Revert "vSphere Automation SDK Python 9.0.0.0 release"

Author: purohitshweta

CONTRIBUTING.md

@@ -15,7 +15,7 @@ The following information must be included in the README.md or in the sample doc
 * Author Name
   * This can include full name, email address or other identifiable piece of information that would allow interested parties to contact author with questions.
 * Compatible vCenter version
-  * This should be the vCenter version when the API is introduced, something like "7.0"+.
+  * This should be the vCenter version when the API is introduced, something like "6.5+" or "6.8.1+".
 * Minimal/High Level Description
   * What does the sample do ?
 * Any KNOWN limitations or dependencies

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016-2025 Broadcom, Inc.
+Copyright (c) 2016-2024 Broadcom, Inc.
 
 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:
 

README.md

@@ -1,9 +1,11 @@
 # VMware vSphere Automation SDK for Python  
+[![Build Status](https://travis-ci.com/vmware/vsphere-automation-sdk-python.svg?token=v9mEJjcpDiQ9DrYbzyaQ&branch=master)](https://travis-ci.com/vmware/vsphere-automation-sdk-python)
 
 ## Table of Contents
 - [Abstract](#abstract)
 - [Supported vCenter Releases](#supported-onprem-vcenter-releases)
 - [Supported NSX-T Releases](#supported-nsx-t-releases)
+- [VMware Cloud on AWS Support](#vmware-cloud-on-aws-support)
 - [Quick Start Guide](#quick-start-guide)
 - [Run SDK Samples](#run-sdk-samples)
 - [API Documentation](#api-documentation)
@@ -12,24 +14,22 @@
 - [Repository Administrator Resources](#repository-administrator-resources)
 - [VMware Resources](#vmware-resources)
 
-## IMPORTANT NOTICE
-Starting with VCF release 9.0.0.0, the vSphere Automation Python SDK repository now includes only the NSX on-prem libraries.
-
-Please use the official [VCF Python SDK](https://github.com/vmware/vcf-sdk-python).
-
 ## Abstract
 This document describes the vSphere Automation Python SDK samples that use the vSphere Automation
 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
 samples require the vSphere Management SDK packages (pyVmomi) to be installed on the client.
-The samples have been developed to work with python 3.9+
+The samples have been developed to work with python 3.8+
 
 ## Supported OnPrem vCenter Releases
-vCenter 7.0, 7.0U1, 7.0U2, 7.0U3 , 8.0, 8.0U1, 8.0U2, 8.0U3, 9.0.0.0
+vCenter 7.0, 7.0U1, 7.0U2, 7.0U3 , 8.0, 8.0U1, 8.0U2, 8.0U3
 Please refer to the notes in each sample for detailed compatibility information.
 
 ## Supported NSX-T Releases
-NSX-T 2.2 - 4.2.0
+NSX-T 2.2 - 4.2.0 and VMC 1.7 - 1.24
+
+## Latest VMware Cloud on AWS Release:
+VMC M24 (1.24) ([Release Notes](https://docs.vmware.com/en/VMware-Cloud-on-AWS/0/rn/vmc-on-aws-relnotes.html))
 
 ## Quick Start Guide
 
@@ -47,7 +47,7 @@ SDK package installation commands may differ depending on the environment where
 **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.
+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 pip from PyPI.
 ```cmd
@@ -65,11 +65,6 @@ pip install --upgrade git+https://github.com/vmware/vsphere-automation-sdk-pytho
 ##### 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's lib directory.
-```cmd
-pip install -U lib/*/*.whl
-```
-Install dependencies like *lxml* and *pyvmomi* from PyPI as other requirements were installed from SDK's lib directory.
 ```cmd
 pip install -U <SDK_DIRECTORY_PATH>
 ```
@@ -78,7 +73,7 @@ e.g.
 ```
 pip install -U vsphere-automation-sdk-python
 Or
-pip install -U vsphere-automation-sdk-python-9.0.0.0.zip
+pip install -U vsphere-automation-sdk-python-8.0.0.0.zip
 ```
 ##### 3. Installation in an air gap environment
 For this type of environment an additional step is required to ensure SDK's dependencies are available.
@@ -147,20 +142,53 @@ Type "help", "copyright", "credits" or "license" for more information.
 
 **NOTE:** If you are using Bash, be sure to use single quote for username and password to preserve the values. If you use double quote, you will have to escape special characters, such as "$". See [Bash manual](http://www.gnu.org/software/bash/manual/html_node/Double-Quotes.html) 
 
+### Connect to VMware Cloud on AWS
+
+```python
+from vmware.vapi.vmc.client import create_vmc_client
+
+# Connect to VMware Cloud on AWS using refresh token
+vmc_client = create_vmc_client('<refresh_token>')
+
+# Get organizations associated with calling user.
+vmc_client.Orgs.list()
+```
+
+Output in a Python Interpreter:
+
+```shell
+(venv) het-m03:vsphere-automation-sdk-python het$ python
+Python 3.9.8 (main, Nov 10 2021, 06:03:50)
+[GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin
+Type "help", "copyright", "credits" or "license" for more information.
+>>> from vmware.vapi.vmc.client import create_vmc_client
+>>> vmc_client = create_vmc_client('<refresh_token>')
+>>> vmc_client.Orgs.list()
+[Organization(updated=datetime.datetime(2018, 3, 2, 16, 57, 46), user_id='77aa6e6f-3257-3637-9cd9-14fae3a25b9d', updated_by_user_id='2021b5ae-890b-3472-ba9a-bc8cff776ca7', created=datetime.datetime(2017, 4, 4, 11, 57, 48, 861), version=15, updated_by_user_name='mdreyer@vmware.com', user_name='pgifford@vmware.com', id='2a8ac0ba-c93d-4748-879f-7dc9918beaa5', display_name='VMC-SET', name='j13hqg73', sla='VMC_INTERNAL', project_state='CREATED', properties=OrgProperties(values={'defaultAwsRegions': 'US_WEST_2,US_EAST_1', 'sddcLimit': '5', 'planVersion': '3.0', 'defaultHostsPerSddc': '4', 'invitationCode': '/csp/gateway/slc/api/service-invitations/aa7203c3617bbe755597b8b0ad652', 'enableAWSCloudProvider': 'true', 'enableZeroCloudCloudProvider': 'true', 'accountLinkingOptional': 'false', 'defaultPDXDatacenter': 'pdx2', 'skipSubscriptionCheck': 'true', 'minHostsPerSddc': '4', 'maxHostsPerSddc': '8', 'hostLimit': '16', 'maxHostsPerSddcOnCreate': '4', 'isAllAccess': 'true', 'enabledAvailabilityZones': '{"us-east-1":["iad6","iad7","iad12"],"us-west-2":["pdx1", "pdx4", "pdx2"]}'}), cloud_configurations={'AWS': AwsOrgConfiguration(provider='AWS')})
+...]
+```
+
 ## Run SDK Samples
 
-In this section we will walk you through the steps to run the sample code for vSphere.
+In this section we will walk you through the steps to run the sample code for vSphere 
+and VMware Cloud on AWS APIs. 
 
 ### First, set PYTHONPATH to use SDK helper methods  
 
 * Linux/Mac:
 
-    export PYTHONPATH=\$\{PWD\}:\$PYTHONPATH
+    export PYTHONPATH=${PWD}:$PYTHONPATH
 
 * Windows:
 
     set PYTHONPATH=%cd%;%PYTHONPATH%
 
+### Run VMware Cloud on AWS Samples
+
+```cmd
+$ python samples/vmc/orgs/organization_operations.py -r <refresh_token>
+```
+
 ### Run vSphere Samples
 
 A vSphere test environment is required with the following configuration:
@@ -181,7 +209,7 @@ Before executing the samples we'll need to setup the vSphere test environment us
 * Create a Distributed Switch
 * Create a Distributed Portgroup
 * Attach the NFS datastore (if Selected) to the hosts
-* Copy the [Photon OS](https://vmware.github.io/photon/) ISO image downloaded from [VMware's bintray server](https://github.com/vmware/photon/wiki/Downloading-Photon-OS#downloading-photon-os-50-ga) to the datastore
+* 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
 * Create directories to add sample ports
 
 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.
@@ -232,18 +260,27 @@ $ python samples/vsphere/vcenter/vm/list_vms.py -v
 ### vSphere API Documentation
 
 * [VMware vSphere REST API Reference documentation](https://developer.broadcom.com/xapis/vsphere-automation-api/latest/)
-* Previous Releases:
-[8.0 U3](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/8.0.3.0/),
-[8.0 U2](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/8.0.2.0/),
-[8.0 U1](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/8.0.1.0/),
-[8.0 GA](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/8.0.0.1/),
+* [vSphere 8.0 U3 Python APIs (latest)](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/8.0.3.0/)
+* Previous Releases:	vSphere [8.0 U2](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/8.0.2.0/)
+[8.0 U1](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/8.0.1.0/)
+[8.0 GA](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/8.0.0.1/)
 [8.0.0.0](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/8.0.0.0/),
-[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/)
 [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/).
 
+### VMware Cloud on AWS API Documentation
+
+* [VMware Cloud on AWS REST APIs](https://developer.broadcom.com/xapis/vmware-cloud-on-aws-api-reference/latest/) 
+* [VMware Cloud on AWS Console Python APIs](https://vmware.github.io/vsphere-automation-sdk-python/vmc/index.html)
+* [VMware Cloud on AWS Disaster Recovery as a Service (DRaaS) Python APIs](https://vmware.github.io/vsphere-automation-sdk-python/vmc-draas/index.html)
+
 
 ### NSX API Documentation
-* [VMware NSX-T Data Center REST API](https://developer.broadcom.com/xapis/nsx-t-data-center-rest-api/latest/)
+* [NSX-T Data Center](https://docs.vmware.com/en/VMware-NSX-T-Data-Center/index.html)
+* [NSX Manager Python APIs](https://vmware.github.io/vsphere-automation-sdk-python/nsx/nsx/index.html) - API for managing NSX-T cluster and transport nodes for on-prem customers
+* [NSX Policy Python APIs](https://vmware.github.io/vsphere-automation-sdk-python/nsx/nsx_policy/index.html) - primary API for managing logical networks for on-prem customers
+* [NSX VMC Policy Python APIs](https://vmware.github.io/vsphere-automation-sdk-python/nsx/nsx_vmc_policy/index.html) - primary API for managing logical networks for VMC customers
+* [NSX VMC AWS Integration Python APIs](https://vmware.github.io/vsphere-automation-sdk-python/nsx/nsx_vmc_aws_integration/index.html) - API for managing AWS underlay networks for VMC customers
 
 ## Troubleshooting
 
@@ -270,5 +307,9 @@ Members:
 
 ## VMware Resources
 
+* [vSphere Automation SDK Overview](http://pubs.vmware.com/vsphere-65/index.jsp#com.vmware.vapi.progguide.doc/GUID-AF73991C-FC1C-47DF-8362-184B6544CFDE.html)
+* [VMware Sample Exchange](https://code.vmware.com/samples) It is highly recommended to add any and all submitted samples to the VMware Sample Exchange
+* [VMware Code](https://code.vmware.com/home)
+* [VMware Developer Community](https://communities.vmware.com/community/vmtn/developer)
 * VMware vSphere [REST API Reference documentation](https://developer.broadcom.com/xapis/vsphere-automation-api/latest/).
-* [VMware Developer Community](https://community.broadcom.com/vmware-code/home)
+* [VMware Python forum](https://code.vmware.com/forums/7508/vsphere-automation-sdk-for-python)

lib/README.md

@@ -1,9 +1,11 @@
-
 # SDK libraries
 
 For python developers, client libraries are supplied for testing and development purposes. All the supplied libraries are located under lib directory.
 
 Name                                | Description
 ------------------------------------| -------------
+vmwarecloud_aws                     | Client stubs for VMware Cloud on AWS Console APIs
+vmwarecloud_draas                   | Client stubs for VMware Cloud (VMC) Disaster Recovery as a Service (DRaaS) APIs
 nsx-python-sdk                      | Client stubs for VMware NSX-T APIs
-nsx-policy-python-sdk               | Client stubs for VMware NSX-T Policy APIs
+nsx-vmc-policy-python-sdk           | Client stubs for VMware NSX-T on VMC Policy APIs
+nsx-vmc-aws-integration-python-sdk  | Client stubs for VMware NSX-T AWS integration app APIs (for AWS underlay management)

lib/index.html

@@ -0,0 +1,13 @@
+<html>
+<head><title>Simple Index</title>
+    <meta name='api-version' value='2'/>
+</head>
+<body>
+<a href='vmwarecloud-aws/'>vmwarecloud-aws</a><br/>
+<a href='vmwarecloud-draas/'>vmwarecloud-draas</a><br/>
+<a href='nsx-python-sdk/'>nsx-python-sdk</a><br/>
+<a href='nsx-policy-python-sdk/'>nsx-policy-python-sdk</a><br/>
+<a href='nsx-vmc-policy-python-sdk/'>nsx-vmc-policy-python-sdk</a><br/>
+<a href='nsx-vmc-aws-integration-python-sdk/'>nsx-vmc-aws-integration-python-sdk</a><br/>
+</body>
+</html>

lib/nsx-vmc-aws-integration-python-sdk/index.html

@@ -0,0 +1 @@
+<a href='nsx_vmc_aws_integration_python_sdk-4.1.2.0.1-py2.py3-none-any.whl'>nsx_vmc_aws_integration_python_sdk-4.1.2.0.1-py2.py3-none-any.whl</a><br />

lib/nsx-vmc-aws-integration-python-sdk/nsx_vmc_aws_integration_python_sdk-4.1.2.0.1-py2.py3-none-any.whl

@@ -0,0 +1 @@
+<a href='nsx_vmc_policy_python_sdk-4.1.2.0.1-py2.py3-none-any.whl'>nsx_vmc_policy_python_sdk-4.1.2.0.1-py2.py3-none-any.whl</a><br />