Merge pull request #239 from anusha94/master

vSphere 7.0 Update 1 GA

Author: anusha94

README.md

@@ -21,7 +21,7 @@ samples require the vSphere Management SDK packages (pyVmomi) to be installed on
 The samples have been developed to work with python 2.7.x and 3.3+
 
 ## Supported OnPrem vCenter Releases
-vCenter 6.0, 6.5, 6.7 and 7.0. 
+vCenter 6.0, 6.5, 6.7, 7.0 and 7.0U1.
 Certain APIs and samples that are introduced in 6.5 release, such as vCenter, Virtual Machine and Appliance Management. Please refer to the notes in each sample for detailed compatibility information. 
 
 ## Supported NSX-T Releases
@@ -214,8 +214,8 @@ $ python samples/vsphere/vcenter/vm/list_vms.py -v
 ### vSphere API Documentation
 
 * [VMware Cloud on AWS vSphere (latest version)](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/cloud/index.html)
-* [vSphere 7.0 (latest)](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/7.0.0.1/)
-* Previous releases:    [6.7.1](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/6.7.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)    [6.0](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/6.0)
+* [vSphere 7.0 Update 1 (latest)](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/7.0.1.0/)
+* Previous releases:    [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)    [6.0](https://vmware.github.io/vsphere-automation-sdk-python/vsphere/6.0)
 
 ### VMware Cloud on AWS API Documentation
 
@@ -250,5 +250,5 @@ Members:
 * [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://code.vmware.com/apis/366/vsphere-automation).
+* VMware vSphere [REST API Reference documentation](https://developer.vmware.com/docs/vsphere-automation/latest/).
 * [VMware Python forum](https://code.vmware.com/forums/7508/vsphere-automation-sdk-for-python)

lib/vapi-client-bindings/index.html

@@ -1 +1 @@
-<a href='vapi_client_bindings-3.3.0-py2.py3-none-any.whl'>vapi_client_bindings-3.3.0-py2.py3-none-any.whl</a><br />
+<a href='vapi_client_bindings-3.5.0-py2.py3-none-any.whl'>vapi_client_bindings-3.5.0-py2.py3-none-any.whl</a><br />

lib/vapi-client-bindings/vapi_client_bindings-3.2.0-py2.py3-none-any.whl

@@ -1 +1 @@
-<a href='vapi_common_client-2.15.0-py2.py3-none-any.whl'>vapi_common_client-2.15.0-py2.py3-none-any.whl</a><br />
+<a href='vapi_common_client-2.19.0-py2.py3-none-any.whl'>vapi_common_client-2.19.0-py2.py3-none-any.whl</a><br />

lib/vapi-client-bindings/vapi_client_bindings-3.3.0-py2.py3-none-any.whl

@@ -1 +1 @@
-<a href='vapi_runtime-2.15.0-py2.py3-none-any.whl'>vapi_runtime-2.15.0-py2.py3-none-any.whl</a><br />
+<a href='vapi_runtime-2.19.0-py2.py3-none-any.whl'>vapi_runtime-2.19.0-py2.py3-none-any.whl</a><br />

lib/vapi-client-bindings/vapi_client_bindings-3.5.0-py2.py3-none-any.whl

@@ -2,7 +2,7 @@ lxml >= 4.3.0
 pyVmomi >= 6.7
 suds ; python_version < '3'
 suds-jurko ; python_version >= '3.0'
-vapi-client-bindings == 3.3.0
+vapi-client-bindings == 3.5.0
 vmc-client-bindings
 nsx-python-sdk
 nsx-policy-python-sdk

lib/vapi-common-client/index.html

@@ -0,0 +1,54 @@
+## Grant types available
+
+| sample | grant_type |
+| ------ | ------ |
+| list_vms_authotization_code.py | authorization_code |
+| list_vms_client_credentials.py | client_credentials | 
+| list_vms_refresh_token.py | refresh_token |
+| list_vms_password.py | password |
+
+## Login Steps
+1.  From a given VC IP/hostname, find the Identity Provider (sample available at [list_external_identity_providers.py](https://github.com/vmware/vsphere-automation-sdk-python/blob/master/samples/vsphere/oauth/list_external_identity_providers.py))
+2.  Make a note of the auth/discovery/token endpoints from the identity provider object
+3.  Get access token by making the call to endpoints based on parameters relevant to different grant types
+4.  Convert access token to saml token (sample avaialble at [exchange_access_id_token_for_saml.py](https://github.com/vmware/vsphere-automation-sdk-python/blob/master/samples/vsphere/oauth/exchange_access_id_token_for_saml.py))
+5.  Use this saml assertion to login to vCenter as a bearer token
+
+
+## Executing the samples
+vCenter needs to be registered with an Identity Provider. Applicable for VC 7.0+
+### list_vms_authorization_code.py
+Create an OAuth app and make a note of the *app_id*, *app_secret* and *redirect_uri*
+
+First start the webserver code at [webserver.py](https://github.com/vmware/vsphere-automation-sdk-python/blob/master/samples/vsphere/oauth/grant_types/webserver.py). Note, this server is not recommended in a production setting, this is only to demonstarte the sample workflow
+
+`$ python3 webserver.py`
+
+Run the sample,
+
+`$ python list_vms_authorization_code.py --server <VC_IP> --client_id <client_id> --client_secret <client_secret> --org_id <org_id> --skipverification`
+
+### list_vms_client_credentials.py
+Create an OAuth app and make a note of the *client_id* and *client_secret*
+
+Run the sample,
+
+`$ python list_vms_client_credentials.py --server <VC_IP> -- client_id <client_id> --client_secret <client_secret> --skipverification`
+
+### list_vms_refresh_token.py
+Use the *refresh_token* that was returned along with the access token in authorization_code workflow
+
+Run the sample,
+
+`$ python list_vms_refresh_token.py --server <VC_IP> --client_id <client_id> --client_secret <client_secret> --refresh_token <refresh_token> --skipverification`
+
+### list_vms_password.py
+Obtain access token using *username* and *password*
+
+Run the sample,
+
+`$ python list_vms_password --server <VC_IP> --username <username> --password <password> --skipverification`
+
+
+## References
+[Understanding vCenter Server Identity Provider Federation](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.authentication.doc/GUID-0A3A19E6-150A-493B-8B57-37E19AB420F2.html)

lib/vapi-common-client/vapi_common_client-2.14.0-py2.py3-none-any.whl

@@ -0,0 +1,25 @@
+"""
+* *******************************************************
+* Copyright VMware, Inc. 2020. All Rights Reserved.
+* SPDX-License-Identifier: MIT
+* *******************************************************
+*
+* DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+* WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+* EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+* WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+* NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+"""
+
+__author__ = 'VMware, Inc.'
+
+# Required to distribute different parts of this
+# package as multiple distribution
+try:
+    import pkg_resources
+
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    from pkgutil import extend_path
+
+    __path__ = extend_path(__path__, __name__)  # @ReservedAssignment

lib/vapi-common-client/vapi_common_client-2.15.0-py2.py3-none-any.whl

@@ -0,0 +1,103 @@
+#!/usr/bin/env python
+
+"""
+* *******************************************************
+* Copyright (c) VMware, Inc. 2020. All Rights Reserved.
+* SPDX-License-Identifier: MIT
+* *******************************************************
+*
+* DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+* WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+* EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+* WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+* NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+"""
+from vmware.vapi.vsphere.client import create_vsphere_client
+
+from samples.vsphere.common.ssl_helper import get_unverified_session
+from samples.vsphere.oauth.grant_types.oauth_utility \
+    import login_using_authorization_code
+
+from urllib.parse import parse_qs
+import webbrowser
+import urllib.parse as urlparse
+import requests
+import uuid
+import argparse
+
+__author__ = 'VMware, Inc.'
+__copyright__ = 'Copyright 2020 VMware, Inc. All rights reserved.'
+__vcenter_version__ = '7.0+'
+
+"""
+To run this sample,
+
+In a different tab, keep the webserver running,
+$ python webserver.py
+
+Then execute the following
+$ python list_vms_authorization_code.py --server <VC_IP> \
+    --client_id <client_id> --client_secret <client_secret> \
+    --org_id <org_id> --skipverification
+"""
+
+parser = argparse.ArgumentParser()
+parser.add_argument("--server",
+                    help="VC IP or hostname")
+parser.add_argument("--client_id",
+                    help="Client/Application ID of the webapp")
+parser.add_argument("--client_secret",
+                    help="Client/Application secret \
+                        of the webapp")
+parser.add_argument("--redirect_uri",
+                    help="Redirect uri \
+                        given at the time of client registration")
+parser.add_argument('--skipverification',
+                    action='store_true',
+                    help='Verify server certificate when connecting to vc.')
+
+args = parser.parse_args()
+
+
+def get_auth_code_and_state(url):
+    openbrowser(url)
+    parsed = urlparse.urlparse(url)
+    redirect_uri = parse_qs(parsed.query)['redirect_uri']
+
+    get_code_uri = redirect_uri[0].rsplit('/', 1)[0]
+    get_code_uri = get_code_uri + "/getcode"
+
+    response = get_response(get_code_uri)
+    while "code" not in response or response == '':
+        response = get_response(get_code_uri)
+
+    res = response.split(':')
+    code = res[1]
+    state = res[3]
+    return [code, state]
+
+
+def openbrowser(url):
+    webbrowser.open(url)
+    pass
+
+
+def get_response(url):
+    response = requests.get(url)
+    return response.text
+
+
+session = get_unverified_session() if args.skipverification else None
+saml_assertion = login_using_authorization_code(
+                    args.server,
+                    session,
+                    args.client_id,
+                    args.client_secret,
+                    args.redirect_uri,
+                    get_auth_code_and_state)
+client = create_vsphere_client(
+            server=args.server,
+            bearer_token=saml_assertion,
+            session=session)
+vms = client.vcenter.VM.list()
+print(vms)

lib/vapi-common-client/vapi_common_client-2.19.0-py2.py3-none-any.whl

@@ -0,0 +1,60 @@
+#!/usr/bin/env python
+
+"""
+* *******************************************************
+* Copyright (c) VMware, Inc. 2020. All Rights Reserved.
+* SPDX-License-Identifier: MIT
+* *******************************************************
+*
+* DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+* WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+* EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+* WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+* NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+"""
+from vmware.vapi.vsphere.client import create_vsphere_client
+
+from samples.vsphere.common import sample_cli
+from samples.vsphere.common import sample_util
+from samples.vsphere.common.ssl_helper import get_unverified_session
+from samples.vsphere.oauth.grant_types.oauth_utility \
+    import login_using_client_credentials
+import argparse
+
+__author__ = 'VMware, Inc.'
+__copyright__ = 'Copyright 2020 VMware, Inc. All rights reserved.'
+__vcenter_version__ = '7.0+'
+
+"""
+To run this sample,
+$ python list_vms_client_credentials.py --server <VC_IP> \
+    -- client_id <client_id> --client_secret <client_secret> --skipverification
+"""
+
+parser = argparse.ArgumentParser()
+parser.add_argument("--server",
+                    help="VC IP or hostname")
+parser.add_argument("--client_id",
+                    help="Client/Application ID of the server to server app")
+parser.add_argument("--client_secret",
+                    help="Client/Application secret \
+                        of the server to server app")
+parser.add_argument('--skipverification',
+                    action='store_true',
+                    help='Verify server certificate when connecting to vc.')
+
+args = parser.parse_args()
+
+session = get_unverified_session() if args.skipverification else None
+saml_assertion = login_using_client_credentials(
+                    args.server,
+                    session,
+                    args.client_id,
+                    args.client_secret)
+
+client = create_vsphere_client(
+            server=args.server,
+            bearer_token=saml_assertion,
+            session=session)
+vms = client.vcenter.VM.list()
+print(vms)

lib/vapi-runtime/index.html

@@ -0,0 +1,61 @@
+#!/usr/bin/env python
+
+"""
+* *******************************************************
+* Copyright (c) VMware, Inc. 2020. All Rights Reserved.
+* SPDX-License-Identifier: MIT
+* *******************************************************
+*
+* DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT
+* WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN,
+* EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED
+* WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY,
+* NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
+"""
+from vmware.vapi.vsphere.client import create_vsphere_client
+
+from samples.vsphere.common import sample_cli
+from samples.vsphere.common import sample_util
+from samples.vsphere.common.ssl_helper import get_unverified_session
+from samples.vsphere.oauth.grant_types.oauth_utility \
+    import login_using_password
+import argparse
+
+__author__ = 'VMware, Inc.'
+__copyright__ = 'Copyright 2020 VMware, Inc. All rights reserved.'
+__vcenter_version__ = '7.0+'
+
+"""
+To run this sample,
+$ python list_vms_password --server <VC_IP> \
+    --username <username> --password <password> --skipverification
+"""
+
+parser = argparse.ArgumentParser()
+parser.add_argument("--server",
+                    help="VC IP or hostname")
+parser.add_argument("--username",
+                    help="username to login \
+                        to vCenter")
+parser.add_argument("--password",
+                    help="password to login \
+                        to vCenter")
+parser.add_argument('--skipverification',
+                    action='store_true',
+                    help='Verify server certificate when connecting to vc.')
+
+args = parser.parse_args()
+
+session = get_unverified_session() if args.skipverification else None
+saml_assertion = login_using_password(
+                    args.server,
+                    session,
+                    args.username,
+                    args.password)
+
+client = create_vsphere_client(
+            server=args.server,
+            bearer_token=saml_assertion,
+            session=session)
+vms = client.vcenter.VM.list()
+print(vms)