VMWare VSphere Virtual Machine Get Ip Address Version 1

This 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 http://vijava.sourceforge.net/ 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.

Parameters

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

Sample Configuration

Name Description
VM Name Test Task VM

Results

Name Description
Ip Address
ip_address

Changelog

VMWarweVSphereVirtualMachineGetIpAddressV1 (2013-10-31)

  • Initial version. See README for details.


Related Handlers

VMWare VSphere Virtual Machine Check Status
Given a task id checks the current status of that task.
VMWare VSphere Virtual Machine Clone
Clones the given virtual machine.
VMWare VSphere Virtual Machine Destroy
Destroys the given Virtual Machine.
VMWare VSphere Virtual Machine PowerOff
Powers off the specified VMWare VSphere virtual machine. This simulates a hard reboot and does not attempt to safely shut down the guest operating system.
VMWare VSphere Virtual Machine PowerOn
Powers on the specified VMWare VSphere virtual machine.
VMWare VSphere Virtual Machine Reboot
Reboots the specified VMWare VSphere virtual machine. This triggers a shutdown of the guest operating system followed by an automatic power on. This handler requires the target virtual machine to have VMWare Tools installed.
VMWare VSphere Virtual Machine Reset
Resets the specified VMWare VSphere virtual machine. This simulates a hard power off followed by an automatic power on and does not attempt to safely shut down the guest operating system.
VMWare VSphere Virtual Machine Shutdown
Shuts down the specified VMWare VSphere virtual machine matching. This triggers a shutdown of the guest operating system before powering the virtual machine off. This handler requires the target virtual machine to have VMWare Tools installed.
VMWare VSphere Virtual Machine Snapshot
Takes a snapshot of the target VMWare VSphere virtual machine matching.
VMWare VSphere Virtual Machine Standby
Places the target VMWare VSphere virtual machine matching into standby. This handler requires the target virtual machine to have VMWare Tools installed.
VMWare VSphere Virtual Machine Suspend
Suspends the target VMWare VSphere virtual machine matching.
VMWare VSphere Virtual Machine Update CPU
Clones the given virtual machine.
VMWare VSphere Virtual Machine Update Memory
Clones the given virtual machine.