VMWare VSphere Virtual Machine Suspend Version 1

This handler is designed to suspend a virtual machine on a VMWare VSphere server that matches the name supplied to it. 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 a signal is sent to it to suspend the VM. Once the signal is sent, the handler does not wait for a response and immediately exits.

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 VM that you want to suspend

Sample Configuration

Name Description
VM Name <%=@answers['VM Name']%>

Results

This handler does not return any results.

Changelog

VMWarweVSphereVirtualMachineSuspendV1 (2011-01-27)

  • 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 Get Ip Address
Gets an ip address from a Virtual Machine.
VMWare VSphere Virtual Machine PowerOn
Powers on the specified VMWare VSphere virtual machine.
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 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 Update CPU
Clones the given virtual machine.
VMWare VSphere Virtual Machine Update Memory
Clones the given virtual machine.