The vSphere Automation SDKs have recently received an exciting update! These open-sourced SDKs can now also interact with the VMware Cloud on AWS service. The first two SDK languages updated to include this feature set is Python and Java. The remaining SDK languages will follow soon.
The VMware Cloud on AWS service offers a couple different RESTful APIs to interact with. The updated SDKs will focus on the VMware Cloud on AWS (VMC) API, as well as provide the authentication method through the Cloud Services Platform (CSP) API. To find out more about the APIs available as part of the VMware Cloud on AWS service, see this blog post: An Overview of VMware Cloud on AWS APIs
On this initial release, both the Python and Java SDKs include a handful of sample frameworks. These include the following functions:
- Listing all Organizations associated with a user
- Creation and removal of an SDDC
- Managing the host count for a deployed SDDC
Let’s take a look at a couple of these in action.
vSphere Automation SDK for Python
One of the vSphere Automation SDK for Python samples has the functionality to perform two methods. The first will list all of the organizations the user’s refresh token is associated with. These orgs will be displayed by ID and display name. The second will list more detailed information for the first organization, such as ID, display name, name, create and updated dates, and SLA. This sample can be executed with the following command:
|
1 |
Python ./samples/vmc/orgs/organization_operations.py refresh-token-id |
This SDK also has a new way to interact with the API and that is through the interactive interpreter! This can be done by creating the service object using the ‘create_vmc_client’ function while passing our refresh token. At this point, we can start accessing the available collections. The collections can by discovered in two main ways. First, by referring to the documentation that’s located in the ‘vmc.zip’ file that’s located in the ‘doc’ folder. Second, by using tab-complete. Some example code to obtain similar output to our prior example while in the interactive shell:
|
1 2 3 4 5 6 |
from vmware.vapi.vmc.client import create_vmc_client client = create_vmc_client('refresh-token-id') client.Orgs.get('org-id') tmmOrg2 = client.Orgs.get('org-id') print(tmmOrg2.display_name) print(tmmOrg2.created) |
vSphere Automation SDK for Java
The vSphere Automation SDK for Java offers a similar sample to the first Python example from above. However, this particular sample operates a little differently. The output from this sample will be the complete details of each org the user is associated with. This sample can be executed with the following command:
|
1 |
java -ea -cp target/vsphere-samples-6.6.2.jar vmware.samples.vmc.orgs.OrganizationOperations -refreshtoken refresh-token-id |
Summary
The open-sourced vSphere Automation SDKs have recently received an update. This update allows these SDKs to work with the RESTful API service of VMware Cloud on AWS. There are also a number of samples available within each SDK to list information about organizations, add and/or remove SDDCs, and manage the host count within an SDDC. These samples are easy to have operational within a few minutes of updating your local repo and are quite simple to integrate into your existing code!
Stay tuned for a more detailed look at getting started with each of these SDKs with the VMware Cloud on AWS service in the future.
For more information about the VMware Cloud on AWS service, see the following blog post: VMware Cloud on AWS Technical Overview
For more information about the VMware Cloud on AWS APIs, see the following blog post: An Overview of VMware Cloud on AWS APIs
