VMWare VSphere Virtual Machine Check Status Version 1

This handler is designed to check the status of a virtual machine task on a VMWare VSphere server that matches the given task id. 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, a Managed Reference Object is created based on the task id so that the Task Object can be re-created. Once that is created, the Task object is traversed to retrieve and return the state and message for the task.

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
Task Id The Id of the Task that you want to check the status of.

Sample Configuration

Name Description
Task Id task-2843

Results

Name Description
State
Message
state
message

Changelog

VMWarweVSphereVirtualMachineCheckStatusV1 (2013-10-31)

  • Initial version. See README for details.


Related Handlers

VMWare VSphere Virtual Machine Clone Advanced
Clones the given virtual machine.
VMWare VSphere Virtual Machine Clone
Clones the given virtual machine.
VMWare VSphere Virtual Machine Destroy
Destroys the given Virtual Machine.
VMWare VSphere Virtual Machine Get Ip Address
Gets an ip address from a 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.