This document describes the VMware Cloud Foundation Python SDK samples that use the VMware Cloud Foundation python client libraries
All modules of the VCF SDK for Python are compatible and verified with the supported versions of Python at the time of their release. Once a Python version reaches EOL (End-Of-Life), it no longer receives security patches. VCF SDK releases which happen after this moment will not provide compatibility guarantees for the EOL-ed Python version. As a generally good practice and for best security posture, it is recommended to use the VCF SDK with an actively maintained version of Python and keeping your environment on the latest patch provided by the Python Software Foundation (PSF).
For release 9.0.0.0, the compatible Python versions are 3.9, 3.10, 3.11, 3.12 and 3.13.
The SDK is compatible with following VMware Cloud Foundation components
- VMware Cloud Foundation
- pyVmomi (includes vSAN) 8.0 and 9.0
- vCenter 8.0 and 9.0
- VMware vSAN Data Protection 8.0 and 9.0
- SDDC Manager 9.0
- VCF Installer 9.0
Kindly refer to README.md under each sample package and the DocStrings in the sample for detailed product compatibility information.
We recommend to install a Python supported version (3.9 to 3.13) and a compatible pip on your system.
NOTE: latest pip version is compatible with all the Python versions supported by the SDK.
A Python virtual environment is also highly recommended.
The SDK package installation commands vary depending on the component being installed and the installation environment.
- The SDK requires OpenSSL 3.0+ in order to support TLS 1.2 & 1.3.
- pip and setuptools are common requirements for all installation types. It is recommended to upgrade pip and setuptools to the latest version.
Install/Update compatible pip from PyPI.
pip install --upgrade pipInstall/Update setuptools
pip install --upgrade setuptoolsThe SDK installation options provided below are for Linux and Windows environments
This is the recommended way to install the SDK. The installation gets the SDK libraries and dependencies from PyPI.
pip install vcf-sdkIndividual VCF SDK components like SDDC Manager, VCF Installer etc, can be installed directly.
pip install <COMPONENT_PACKAGE_NAME>
# e.g. To install SDDC Manager
pip install sddc-managerTo get list of other VCF SDK packages, refer to requirements.txt
VCF SDK for Python is published to the Broadcom Developer Portal.
The SDK zip file follows the naming convention vcf-python-sdk-<VERSION>-<BUILD_NUMBER>.zip.
where
VERSION : The released version of the VCF SDK Python
BUILD_NUMBER : The build number of the released VCF SDK Python
e.g. vcf-python-sdk-9.0.0.0-24798170.zip
The SDK zip bundles the SDK libraries, samples, and documentation. However, third-party dependency packages are not bundled; they are listed in the requirements-third-party.txt file included in vcf-python-sdk--<BUILD_NUMBER>.zip
To install the VCF SDK Python from the zip, follow these steps.
- Download the SDK zip from the trusted source Broadcom Developer Portal
- Install the third party dependencies.
- Either
pip installthem using therequirements-third-party.txtor - download the dependencies from PyPI and install them from the download location.
- Either
- Install the SDK packages bundled in the zip.
e.g.
# unzip the SDK to vcf-sdk-python directory
unzip vcf-python-sdk-9.0.0.0-24798170.zip -d vcf-sdk-python
cd vcf-sdk-python# Install the third party dependencies from PyPI
pip install -r requirements-third-party.txtor
# Download third party dependencies from PyPI and install
pip download -r requirements-third-party.txt -d third-party_libs/
pip install --no-index -U third-party_libs/**/*.whl# Install vcf sdk libraries from deflated sdk zip
pip install --no-index -U pypi/**/*.whlTo install VCF SDK in an air-gapped environment, first download the required SDK packages as "wheels" (pre-built package files) from a trusted source (Broadcom Developer Portal or PyPI) outside the airgap, then transfer them to the air-gapped system and install them using the pip install command with the local wheel file path; essentially, you cannot directly use online python package repositories in an air-gapped environment.
The required SDK packages are listed in the requirements.txt and requirements-third-party.txt files. Also, present in the vcf-sdk-python.zip.
- requirements.txt : Lists all the SDK packages, including the third party dependency packages.
- requirements-third-party.txt : Lists only the third party dependency packages.
-
In an environment which is outside of air gap.
- Download the SDK zip from Broadcom Developer Portal, it contains requirements.txt, requirements-third-party.txt, samples, readme and SDK libraries.
- Third Party dependencies are not bundled in this zip, download the dependencies from PyPI in an environment which has PyPI access, then copy and install them in the air-gapped environment.
e.g.
# Unzip the VCF SDK zip unzip vcf-python-sdk-9.0.0.0-24798170.zip -d vcf-sdk-python cd vcf-sdk-python # Download third party dependencies from PyPI pip download -r requirements-third-party.txt -d pypi/ cd .. # zip the vcf-sdk-python with downloaded third party libraries zip -r vcf-sdk-python.zip vcf-sdk-python/
The VCF SDK python packages as well as the third party libraries are present under
pypidirectory inside thevcf-sdk-python.zip. -
Transfer
vcf-sdk-python.zipto the air-gapped system- Unzip
vcf-sdk-python.zipand install vcf-sdk-python packages and dependencies. e.g.
unzip vcf-sdk-python.zip -d vcf-sdk-python cd vcf-sdk-python/ pip install --no-index -U pypi/**/*.whl
- Unzip
-
In an environment which is outside of airgap
- Download the SDK from vcf-sdk-python github repository, the zip contains requirements.txt, requirements-third-party.txt, samples and readme. The zip does not contain any SDK libraries or dependencies.
e.g.
wget https://github.com/vmware/vcf-sdk-python/archive/refs/tags/v9.0.0.0.zip unzip v9.0.0.0.zip -d vcf-sdk-python cd vcf-sdk-python pip download -r requirements.txt -d pypi/ cd .. zip -r vcf-sdk-python.zip vcf-sdk-python/
The VCF SDK python packages as well as the third party libraries are present under
pypidirectory inside thevcf-sdk-python.zip. -
Transfer
vcf-sdk-python.zipto the air-gapped system- Unzip and install the vcf-sdk-python packages and dependencies.
e.g.
unzip pypi.zip -d pypi pip install --no-index -U pypi/**/*.whl
-
In an environment which is outside of airgap
- Clone the SDK from the vcf-sdk-python GitHub repository.
- Downloaded SDK and third-party dependency packages from PyPI: The repository includes
requirements.txt,requirements-third-party.txt, sample code, and README files. However, it does not include the SDK packages or third-party dependencies; these need to be downloaded from PyPI.
e.g.
git clone https://github.com/vmware/vcf-sdk-python.git cd vcf-sdk-python pip download -r requirements.txt -d pypi/ cd .. zip -r vcf-sdk-python.zip vcf-sdk-python/
The VCF SDK python packages as well as the third party libraries are present under
pypidirectory inside thevcf-sdk-python.zip. -
Transfer
vcf-sdk-python.zipto the air-gapped system:- Unzip and install the vcf-sdk-python packages and its dependencies.
e.g.
unzip libs_pypi.zip -d libs_pypi pip install -U libs_pypi/**/*.whl
git clone https://github.com/vmware/vcf-sdk-python.git
cd vcf-sdk-pythonTo run the samples install the SDK libraries using requirements.txt, it lists all the SDK packages required for running the samples.
pip install -r requirements.txtRefer to SDK Installation to explore other installation options.
Samples and utilities are organized as Python modules under each component's samples directory. The directory name follows the format:<COMPONENT-NAME>-samples.
Where <COMPONENT-NAME> is the name of the VCF component e.g sddc-manager, vsphere etc.
These directories are regular python packages. However, they are not installed via pip. Python will not be able to resolve the modules imported by the python samples under <COMPONENT-NAME>-samples directory, if run as is.
In order to make the modules discoverable by Python, update the environment variable PYTHONPATH with the location of <COMPONENT-NAME>-samples package.
Linux/Mac:
cd vcf-sdk-python
export PYTHONPATH=${PWD}/<COMPONENT-NAME>-samples:$PYTHONPATH
e.g. For SDDC Manager Samples
export PYTHONPATH=${PWD}/sddc-manager-samples:$PYTHONPATHWindows:
cd vcf-sdk-python
set PYTHONPATH=%cd%\<COMPONENT-NAME>-samples;%PYTHONPATH%
e.g. For SDDC Manager Samples
set PYTHONPATH=%cd%\sddc-manager-samples;%PYTHONPATH%vSphere samples are present in two different directories vsphere-automation-sdk and pyvmomi-community-samples.
Update the environment variable PYTHONPATH with the location of vsphere-samples/vsphere-automation-sdk package for Python to discover the vSphere modules.
NOTE : pyvmomi-community-samples have no modules. Do not update the PYTHONPATH to run samples under vsphere-samples/pyvmomi-community-samples
Linux/Mac:
cd vcf-sdk-python
export PYTHONPATH=${PWD}/vsphere-samples/vsphere-automation-sdk:$PYTHONPATHWindows:
cd vcf-sdk-python
set PYTHONPATH=%cd%\vsphere-samples\vsphere-automation-sdk;%PYTHONPATH%import requests
import urllib3
from vmware.vapi.sddc_manager.client import create_sddc_manager_client
session = requests.session()
# Disable cert verification for demo purpose.
# This is not recommended in a production environment.
session.verify = False
# Connect to a SDDC Manager Server using username and password
sddc_client = create_sddc_manager_client(server='<sddc_manager_ip>', username='<username>', password='<password>', session=session)
# Get Domains
sddc_client.v1.Domains.get_domains()Output in a Python Interpreter:
(venv)[vsphere-automation-sdk]$ 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.
>>> import requests
>>> import urllib3
>>> from vmware.vapi.sddc_manager.client import create_sddc_manager_client
>>> session = requests.session()
>>> session.verify = False
>>> urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
>>> sddc_client = create_sddc_manager_client(server='<sddc_manager_ip>', username='<username>', password='<password>', session=session)
>>> sddc_client.v1.Domains.get_domains()
Domains Info :
{elements : [Domain(id='7277ed7e-3239-438b-b7c7-a735f1293c08', name='sddcId-1001', org_name='COM', status='ACTIVE', upgrade_state='AVAILABLE', upgrade_status=UpgradeStatus(status='UP_TO_DATE', completed_resources=None, total_resources=None), type='MANAGEMENT', vra_integration_status=None, vrops_integration_status=None
...}import requests
import urllib3
from vmware.vapi.vsphere.client import create_vsphere_client
session = requests.session()
# Disable cert verification for demo purpose.
# This is not recommended in a production environment.
session.verify = False
# Disable the secure connection warning for demo purpose.
# This is not recommended in a production environment.
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
# Connect to a vCenter Server using username and password
vsphere_client = create_vsphere_client(server='<vc_ip>', username='<vc_username>', password='<vc_password>', session=session)
# List all VMs inside the vCenter Server
vsphere_client.vcenter.VM.list()Output in a Python Interpreter:
(venv)[vsphere-automation-sdk]$ 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.
>>> import requests
>>> import urllib3
>>> from vmware.vapi.vsphere.client import create_vsphere_client
>>> session = requests.session()
>>> session.verify = False
>>> urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
>>> vsphere_client = create_vsphere_client(server='<vc_ip>', username='<vc_username>', password='<vc_password>', session=session)
>>> vsphere_client.vcenter.VM.list()
[Summary(vm='vm-58', name='standalone-20e4bd3af-esx.0-vm.0', power_state=State(string='POWERED_OFF'), cpu_count=1, memory_size_mib=256),
...]from utils.client import create_vcf_installer_client
# never use ca_certs=False in production! This is used in dev environments to avoid self-signed certificate validations
client = create_vcf_installer_client(server=<vcf_installer_ip>, password=<vcf_installer_admin_password>, ca_certs=False)
client.v1.system.ApplianceInfo.get_appliance_info()Output in a Python Interpreter:
(.venv) [vcf-installer-samples]$ python
Python 3.12.5 (main, Aug 9 2024, 08:20:41) [GCC 14.2.1 20240805] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from utils.client import create_vcf_installer_client
>>> client = create_vcf_installer_client(server=<vcf_installer_ip>, password=<vcf_installer_admin_password>, ca_certs=False)
>>> client.v1.system.ApplianceInfo.get_appliance_info()
ApplianceInfo(role='VcfInstaller', version='9.0.0.0.24541873')In this section we will walk you through the steps to run the sample code for few VCF Components like vSphere, SDDC Manager etc.
A VCF test environment is required with the following configuration:
$ python create_domains.py --server <SDDC_MANAGER IP> --user <username> --password <password>Follow the instructions from vSphere Automation SDK guide
$ python get_appliance_info.py --vcf_installer_server_address <VCF_INSTALLER_IP> --vcf_installer_admin_password <VCF_INSTALLER_ADMIN_PASSWORD>This project contains python samples from VCF products which can be imported to the supported IDEs. Some specifics of PyCharm and Visual Studio Code, two popular IDEs for Python are discussed in the following subsections.
To work with the IDEs, either Clone the repository or download the SDK zip from Broadcom.com
Open the project in PyCharm IDE, create a virtual environment using a supported python version, and install dependencies to the project referring requirements.txt and requirements-third-party.txt.
To Run the sample from the PyCharm Editor, set the PYTHONPATH in Edit Configuration Settings -> Environment -> Environment Variables.
For more details regarding the PYTHONPATH, kindly refer the sample section, Using the SDK Samples
It is recommended to install Python extension for VS Code. Open the project in VS Code IDE, create and activate a virtual environment using a supported python version, refer to Creating Environments in VS Code.
Install SDK dependencies to the project referring requirements.txt and requirements-third-party.txt.
To Run the sample from the VS Code Editor, first set the PYTHONPATH environment variable, refer setting environment variables in VS Code.
You can run the sample from VS Code using two ways
- Select the sample and click on
[Run and Debug]button - Open the VS Code integrated terminal and run the sample
- SDDC Manager
- VCF Installer
- VMware vSphere REST API Reference documentation
- vSphere Web Services API
- vSAN
Support details can be referenced under the SDK and API Support for Commercial and Enterprise Organizations section at Broadcom Developer Portal.
For community support, please open a Github issue or start a Discussion.
