vsphere-automation-sdk-python

What's New

• Updated vSphere Bindings and NSX-T Bindings #423

What's Changed

Following libraries removed from the lib directory. SDK uses renamed libraries published to PyPI

Bug Fixes

#363 : Deprecation warnings from setuptools
#400 : from vmware.vapi.vsphere.client import create_vsphere_client
#407 : Possible problem with Python 3.12?
#408 : Use "com" folder as an implicit namespace

Deprecated

Deprecated LookupService client bindings and External PSC Samples

• lookservice and lookup wsdls
• sample external_psc_sso_workflow.py
• lookup_service_helper.py
• platform_service_controller.py

vSphere

This release contains following new/updated APIs.

• vSAN Snapservice

• TLS Manual Parameters Global APIs

• TLS Profiles APIs

• TLS Profiles Global APIs

• Settings Clusters Installed Images APIs

• Settings Clusters Software Drafts Software Removed Components APIs

• Settings Clusters Software Removed Components APIs

• Settings Hosts Software Drafts Software Removed Components APIs

• Settings Hosts Software Removed Components APIs

• Authorization Vt Containers Mappings APIs

• Namespace Management Software Supervisors Prechecks APIs

• Namespace Management Supervisors Container Image Registries APIs

• Namespace Management Supervisors Recovery Backup Archives APIs

• Namespace Management Supervisors Recovery Backup Jobs APIs

• Namespace Management Supervisors Recovery Restore Jobs APIs

• Namespace Management Supervisors Supervisor Services APIs

• vCenter Phm About APIs

• Hardware Support Managers APIs

• Hardware Support Managers Managed Hosts APIs

• Hardware Support Managers Resource Bundle APIs

New Samples

vCenter Server Samples

Single session between vAPI and pyvmomi

• pyvmomi session usage in vAPI API call
• vAPI session usage in pyvmomi API call

vCenter Server vLCM

• vCenter Server vLCM Cluster Installed Images

Hardware Trusted Platform Module

• Hardware Trusted Platform Module Info

vSAN Snapservice Samples

• List Protection Groups
• Create Protection Group
• Delete Protection Groups
• Delete Protection Group Snapshots

NSX

• Updated API bindings for NSX-T Policy. New features and bug fixes in this release for NSX-T Data Center can be found here.

Known issues

These two API calls from this SDK will work only with vCenter Server version 8.0.3
List NSX Tier0 Gateway
List Networks NSX Edges

What's New

• Updated vSphere Bindings and VMware Cloud on AWS Bindings #394
• Updated NSX-T Bindings for VMware Cloud on AWS #396
• Official support option for customers.

What's Changed

• Renamed vmc_client_bindings to vmwarecloud_aws
• Renamed vmc_draas_client_bindings to vmwarecloud_draas

vSphere

This release contains following new/updated APIs.

• vCenter Settings Current Config API ${\color{green}(Tech \space preview)}$
• ESX Cluster Configuration Audit Records API
• ESX Cluster Configuration Drafts API
• vCenter System API

Samples

• vCenter Crypto Manager Native Key Provider
• vCenter Privilege check
• vCenter Transcode
• vCenter Guest VM Customization
• vCenter Guest VM Customization with Cloud Init data

VMware Cloud on AWS (VMC on AWS)

• Updated API bindings for NSX-T Policy, NSX VMC Policy, and NSX VMC AWS Integration. New features and bug fixes in this release for NSX-T Data Center can be found here.
• Updated VMC and DRAAS bindings. New features and bug fixes in this release for VMware cloud on AWS can be found here.

What's New:

• Updated VMware Cloud on AWS Bindings #376
• Updated vSphere bindings for VMware Cloud On AWS #372
• Updated NSX-T Bindings for VMware Cloud on AWS #375
• PyVmomi version 8.0 is not compatible with SDK due to this issue.
  Switch to PyVmomi version > 8.0.0.1.1

vSphere
This release contains following new/updated APIs.

• ESX Settings APIs
  Config Current Apis ${\color{green}(Tech \space preview)}$
  Cluster Configuration APIs
  Clusters Configuration Reports Last Apply Result APIs
  Clusters Configuration Reports Last Compliance Result APIs
  Clusters Configuration Reports Last Precheck Result APIs
  Clusters Configuration Reports Recent Tasks APIs
  Clusters Configuration Schema APIs
  Clusters Enablement Configuration APIs
  Clusters Enablement Configuration Transition APIs
  Hosts Configuration APIs
  Hosts Depot Overrides APIs
• vCenter HVC APIs
  HVC Links APIs
  HVC Management Administrators APIs
  Identity Broker Tenants Admin Client APIs
  Identity Broker Tenants Operator Client APIs

VMware Cloud on AWS (VMC on AWS)

• Updated API bindings for NSX-T Policy, NSX VMC Policy, and NSX VMC AWS Integration. New features and bug fixes in this release for NSX-T Data Center can be found here.
• Updated VMC and DRAAS bindings. New features and bug fixes in this release for VMware cloud on AWS can be found here.

What's Changed

• Removed support for older versions of vCenter Server 6.5/6.7
• Added additional installation steps depending on user environment.

vSphere

This release contains following new/updated APIs.

• ESX Settings APIs
  • Clusters Configuration APIs ${\color{green}(Tech \space preview)}$
  • Clusters Configuration Reports Last Apply Result APIs ${\color{green}(Tech \space preview)}$
  • Clusters Configuration Reports Last Compliance Result APIs ${\color{green}(Tech \space preview)}$
  • Clusters Configuration Reports Last Precheck Result APIs ${\color{green}(Tech \space preview)}$
  • Clusters Configuration Reports Recent Tasks APIs ${\color{green}(Tech \space preview)}$
  • Clusters Configuration Schema APIs ${\color{green}(Tech \space preview)}$
  • Clusters Enablement Configuration APIs ${\color{green}(Tech \space preview)}$
  • Clusters Enablement Configuration Transition APIs ${\color{green}(Tech \space preview)}$
  • Defaults Hosts Policies Apply APIs
  • Defaults Hosts Policies Apply Effective APIs
  • Hosts Configuration APIs ${\color{green}(Tech \space preview)}$
  • Hosts Enablement Software APIs
  • Hosts Policies Apply APIs
  • Hosts Policies Apply Effective APIs
  • Hosts Software Add On APIs
  • Hosts Software Base Image APIs
  • Hosts Software Commits APIs
  • Hosts Software Compliance APIs
  • Hosts Software Components APIs
  • Hosts Software Drafts APIs
  • Hosts Software Drafts Software Add On APIs
  • Hosts Software Drafts Software Base Image APIs
  • Hosts Software Drafts Software Components APIs
  • Hosts Software Drafts Software Effective Components APIs
  • Hosts Software Effective Components APIs
  • Hosts Software Recommendations APIs
  • Hosts Software Reports Apply Impact APIs
  • Hosts Software Reports Last Apply Result APIs
  • Hosts Software Reports Last Check Result APIs
  • Hosts Software Solutions APIs
• Namespace Management APIs
  • Namespace Management Clusters Topology APIs
  • Namespace Management Networks NSX Distributed Switches APIs
  • Namespace Management Networks NSX Distributed Switches Compatibility APIs
  • Namespace Management Networks NSX Edges APIs
  • Namespace Management Networks NSX Edges Compatibility APIs
  • Namespace Management Storage Profiles APIs
  • Namespace Management Supervisors APIs
  • Namespace Management Supervisors Conditions APIs
  • Namespace Management Supervisors Identity Providers APIs
  • Namespace Management Supervisors Summary APIs
  • Namespace Management Supervisors Topology APIs
• Trusted Infrastructure APIs
  • Hosts Hardware TPM APIs
  • Hosts Hardware TPM Endorsement Keys APIs
  • Hosts Hardware TPM Event Log

Samples

• Get the cluster hardware compatibility details
• Patching API - appliance management APIs
• WCP service APIs

VMware Cloud on AWS (VMC on AWS)

• Updated API bindings for NSX-T Policy, NSX VMC Policy, and NSX VMC AWS Integration. New features and bug fixes in this release for NSX-T Data Center can be found here.
• Updated VMC and DRAAS bindings. New features and bug fixes in this release for VMware cloud on AWS can be found here.

What’s New

Updated VMware Cloud on AWS Bindings.
Updated vSphere bindings for VMware Cloud On AWS
Updated NSX-T Bindings for VMware Cloud on AWS.
New features and bug fixes in this release for VMware cloud on AWS can be found here.

What’s New

• Updated VMware Cloud on AWS Bindings.
• Updated vSphere bindings for VMware Cloud On AWS
• Updated NSX-T Bindings for VMware Cloud on AWS.

New features and bug fixes in this release for VMware cloud on AWS can be found here.
New features and bug fixes in this release for NSX-T Data Center can be found here.

New Samples

Demonstrate certificatemanagement
gencsr.py
get_tls_certificate.py
renew_tls_certificate.py
replace_tls_certificate.py
replace_tls_certificate_with_vmca_signed.py
replace_vmca_root.py
trusted_root_chains_create.py
trusted_root_chains_delete.py
trusted_root_chains_get.py
trusted_root_chains_list.py

Demonstrate supervisor_services in namespace_management
list_supervisor_services.py
list_supervisor_services_on_cluster.py

What’s New:

vSphere

• API(s) for Namespace Management Supervisor services.
• API(s) for Personality Manager Depot Deletion.
• API(s) for vCenter Compute Policies
• Updated tech-preview API(s) for HybridVC
• Updated tech-preview API(s) for Compute Policy and vStats

New Samples

• Demonstrate Customization Specs
  • cloudinitDataCustomizationSpecs.py
  • customizationSpecs.py
  • customizationSpecs_import_export.py

What’s New

• Updated VMware Cloud on AWS Bindings.
• Updated NSX-T Bindings for VMware Cloud on AWS.

New features and bug fixes in this release for VMware cloud on AWS can be found here.
New features and bug fixes in this release for NSX-T Data Center can be found here.

What’s New

vSphere

• APIs for virtual machine classes. A virtual machine class represents a policy and configuration resource which defines a set of attributes to be used in the configuration of a virtual machine instance.
• APIs to manage namespace self service and namespace templates.
• Updated Namespace bindings. Namespaces.Instances.Info and Namespaces.Instances.Summary now contain information pertaining the the namespace templates and VM classes/images.

What’s New

vSphere

• Bindings for vCenter authentication using token exchange
• Bindings for vCenter crypto manager native key providers
• Bindings for vCenter guest operations
• Tech-preview bindings for HybridVC
• Updated tech-preview bindings for Compute Policy and vstats
• Updated bindings for vSphere Lifecycle manager.

New Samples

• demonstrate vAPI guest operations - guest_ops.py

What’s New

vSphere

• Bindings for namespace management load balancers and networks
• Bindings for vSphere Trust Authority that includes attestation and KMS services applied config
• Tech-preview bindings for VCenter Settings and Profiles
• Updated tech-preview bindings for Compute Policy and vstats

New samples

• OAuth2 authorization via different grant types
  • authorization_code
  • client_credentials
  • refresh_token
  • password

Fixed Issues

• Missing vsphere_client documentation

What’s New

vSphere

• New bindings for vSphere Lifecycle manager
• New bindings for vSphere Trust Authority that includes attestation and KMS services
• New bindings for vCenter Server Profiles to manage profile specification
• Introduced support for OAuth2
  • identity_client to manage VC identity
  • OAuth2 and OIDC specs and identity types for VC providers
• Updated APIs for vCenter high availability cluster node with new identifiers
• Updated vSphere Update Manager bindings to generate compatibility reports
• New bindings to manage lifecycle and health of harbor container registry in vCenter
• New bindings for Workload Control Plane namespace management
• Removed convergence and decommission samples

New samples

• To retrieve node topology and replication status operations
• To demonstrate the usage of discovery and plan APIs via lcm_client
• To generate hardware compatibility reports

VMware Cloud on AWS (VMC on AWS)

• New hybrid vCenter tech preview APIs (only for VMware Cloud on AWS)
  • Added new bindings to create a sync session and manage groups
• Removed samples for NSX for vSphere (NSX-V). NSX-V is no longer supported for VMware Cloud on AWS. For more details on the end of life, refer VMware Cloud on AWS documentation

NSX

• New bindings to support NSX-TT Data Center 3.0. For details on the new features, refer the NSX documentation here

What’s New

VMware Cloud on AWS (VMC on AWS)

NSX

• New API specifications for NSX-T Policy API
• Updated API bindings for NSX-T Policy, NSX VMC Policy, and NSX VMC AWS Integration

VMC Console

• Updated APIs to get compatible subnets for a linked AWS account with an additional parameter (linked connected account identifier or linked Account Id)
• Delete SDDC API no longer supports forceful delete. Parameter "force" has been removed.

DRaaS

• Removed following APIs
  -- Create audit setup task for specific appliance and configure rsyslog for it
  -- Upload backup script to specific appliance
• Updated API to deactivate site recovery for a specific SDDC.

vSphere

This release contains following new/updated features.

• VSTATS(Tech Preview APIs) and samples
• vCenter Guest Customisation APIs
• VM Guest APIs and samples
• VM Life Cycle Management APIs(clone and relocate)
• Resource Pool APIs (create and delete)

Note: clone the SDK repository to get the most recent VMC API bindings

What’s New

pip Installation from GitHub repository

Ability to install the SDK package directly from the GitHub repository using pip

• pip install --upgrade pip setuptools
• pip install --upgrade git+https://github.com/vmware/vsphere-automation-sdk-python.git

Refer to following pull requests

• pip install from repository : #164
• updating new installation instructions : #165
• Optimized setup.py for version control #166

VMware Cloud on AWS (VMC on AWS)

• VMware Cloud on AWS library now includes APIs for Disaster Recovery as Service (DRaaS). With this version, users can automate the setup and the configuration of site recovery for a specified SDDC using DRaaS APIs.

vSphere

• vSphere library now supports VMware Certificate Authority (VMCA) root certificate, check-out VMs managed by content library, and a new appliance API to change hostname/IP of vCenter appliance.

What's New

• Updated VMware Cloud on AWS Console API bindings
• Updated VMware Cloud on AWS SDDC API bindings
• Updated NSX Manager, NSX Policy, NSX VMC Policy and NSX VMC AWS Integration API bindings
• New bindings and samples for Convergence and Decommission APIs
• New bindings for Content Library VMTX_Sync APIs
• New bindings and samples for Token Exchange and query External Identity Providers APIs

• Updated VMware Cloud on AWS Console API bindings
• Updated VMware Cloud on AWS SDDC API bindings
• Added Compute Policy API bindings
• Add compute Policy API samples
• Remove doc folder. The API specs are hosted on gh-pages branch now. The API doc links can be found on the main README.

• Updated bindings and samples for VMware Cloud on AWS APIs
• Added bindings for NSX APIs
• Added HVC samples

What's New

The vSphere Automation SDKs for vSphere 6.7 includes new APIs for:

• Storage Policy
• Guest Ops
• vCenter Server Appliance and Platform Services Controller appliance deployment
  • Installing and Upgrading the vCenter Server Appliance and Platform Services Controller appliance stage 2
  • Importing the historical data of vCenter Server
  • Scheduling a backup job
  • Updating the vCenter Server Appliance
  • Managing and recovering the vCenter Server Appliance

Invoke vSphere APIs via the new vSphere Client module.

Refer to quick start guide for detailed usage.

Caveats and Limitations

The vcenter API includes the following methods that have known issues and might be removed in a future version. It is advised that these APIs are not invoked:

• DeploymentType.reconfigure
• PscRegistration.repoint
• Upgrade.cancel
• Deployment.rollback

Known Issues

• Unauthenticated exception following long-running operation

  After an API client completes a long-running operation, such as an upload to the content library, the next operation might fail with an "Unauthenticated exception" message. This happens if the long running operation did not complete within the lifetime of the authentication session.

  Workarounds:

  • Keep the session alive by issuing short operations on another thread until the long running operation completes.
  • Increase the session length using the VMware vSphere Web Client. Select Administration > System Configuration > Services > vAPI Endpoint > Manage> General, and increase the value for the Maximum session idle time.

• A couple of service endpoints under vCenter namespace are not accessible through the vSphere Client module.

  ovfs, vcenter-inventory, iso, hvc and vm_template API endpoints are not accessible through the vSphere client module.

  Workaround

  Please use the legacy invocation mechanism demonstrated in the corresponding samples to access above API endpoints.

• New: Language bindings for working with VMware Cloud on AWS
• New: Multiple samples for working with VMware Cloud on AWS
• Updated: vSphere language bindings to include Content Library VM Templates
• Updated: Multiple samples for working with Content Library VM Templates

Release Notes:

• Please use below cmd to refresh the client bindings:

pip install --upgrade --force-reinstall -r requirements.txt --extra-index-url <file:///abs_path/to/sdk/lib/>

1. Update vAPI binding and runtime to support vSphere 6.6.1 for VMware Cloud 1.1
2. Include tech-preview API for Hybrid VC.
3. Package vSphere Automation runtime and bindings in wheel format.
4. Update password and remove IP from testbed.py
5. Remove redundant dependencies from requirements.txt