Skip to main content

IMPORTANT - Product End of Life Statement - IMPORTANT

Request RE, Survey, and Calendar 1.5 Support Ending December 31, 2020
Contact Kinetic Data Support with Questions
Kinetic Community

VMWare VSphere Virtual Machine Get IP Address

Get an IP Address from a Virtual Machine.


By downloading this file, you acknowledge that you agree to our Terms of Service

Detailed Description

ip_address_vmware.pngThis handler is designed to get the ip address of a virtual machine on a VMWare VSphere server that matches the name supplied as a parameter. It logs in to the VSphere server using the server's administrative URL, user ID and password that are set as info_value records for the task.  Once logged in, the virtual machine name is verified and then the handler traverses the object to retrieve and return the virtual machines ip address.

This handler uses the VMWare VI (vSphere) Java API (see for more information).  The api is deployed as a Java archive file (jar) and is stored in this handler's vendor directory.  If the vijava jar file is stored somewhere else on the classpath, the jar file stored in this handler's vendor directory is not used.  It is recommended that there are no vijava jar files stored anywhere on the classpath, and that all VMWare VSphere handlers contain the same vijava jar file in their vendor directory.


Name Description
VM Name The name of the Virtual Machine to get the ip address of.

Sample Configuration

Parameter Example Configuration
VM Name Test Task VM


Name Description
IP Address The IP Address of the given Virtual Machine.

Change Log

Version Date Description
1 2013-10-31 Initial Version