Getting started with vSphere API using VI Java

Recently I got introduced to VMware Infrastructure (aka vSphere) Java & I should say “VI Java is an incredible open source project  I have ever come across”. I am really humbled with the impact that Steve Jin’s contribution to the VMware community. I am sure this open source project is asset for thousands of VMware customers & partners. In the purview of the same, VI Java project inspired me to add “vSphere API” section in my blog. Under this section you can expect small utilities to manage your VMware environment which will be useful specially to most of the VMware administrators. Here we go with first post under “vSphere API” section. I am going to share how I got started with VI Java application development. i.e. Step by step tutorial on getting started with vSphere API using Java.

Update: VI Java project has now YAVI JAVA, please start using this guide to get started with YAVI JAVA instead of below steps. Since it supports vSphere 5.5 as well as vSphere 6.0 SDK, it is recommended to use YAVI JAVA. All the automation written using VI JAVA will work fine on YAVI JAVA.

1. Goto VI java website Here. Click on “Download” tab on the top as shown in below screenshot.


2. Click on the latest release as shown below. 

Download_2Note: For future releases Zip file name would be different. Just you need to download latest one

3.  Extract the downloaded file at any location of your choice.Extract ZIP_file

4. You should see below jar files inside extracted Zip file.


5. Now it is time to install Eclipse. Download eclipse from “” as shown below .Please make sure you have JDK/JRE 1.6 or higher

Eclipse download6. Create java project as shown below .




7. Configure the 2 jars files that were extracted above in step 5 as follows.





8. Create first java program “” as follows: Download source code from (Source code originally written by Steve Jin). Add this source code in java class created below.



 9. You need to modify source code with vCenter IP, vCenter username & vCenter password as shown in below screenshot.

Create_project_1210. Run your first VI Java program as follows.



Great! Finally you got started with VI SDK and executed first VI SDK program. Stay tuned for more meaningful programs to manage your VMware environment.

10 thoughts on “Getting started with vSphere API using VI Java

  1. Thanks a lot for your comment. Yes, I will be writing post on useful vSphere operations those will demonstrate how vSphere APIs can be explored using VI Java.

  2. Hi Vikash,

    Nice article on getting started with vSphere API.
    Here VI Java API is used, which is a wrapper over the VMware’s original vSphere SDK API.

    Is VI-JAVA officially supported by VMware ? Or we have to use it our own risk ?


    1. Hi Aravind,

      Thanks a lot for reading my post.

      Yes, It is wrapper around VMware’s original vSphere SDK. It is not officially supported by VMware. VI Java is now forked into another open source project i.e. YA VI JAVA (Yet Another VI JAVA). It is open source and some of the VMware engineers (like me) are active in community and using it.

      For YA VI Java, I have written couple of articles already. VI java was supporting till 5.5 and YA Vi java supports even 6.0 release as well.

      I would suggest to use YA Vi Java now:

      So many companies use it and as per my experience, I have found no serious issues. This has been there since last 5-6 years.

  3. Hi Vikash,

    Nice article.

    So far We are using vijava-5.0.0.jar for vsphere 6.5. Now we want to upgrade 6.7 version.

    Will it work for 6.7 version ?. If not what needs to be upgrade.

Comments are closed.