Skip to main content
Kinetic Community

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.

Downloads

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

vmware_vsphere_virtualmachine_standby_v1.zip

Detailed Description

standby_vmware.pngThis handler is designed to set a virtual machine on a VMWare VSphere server that matches the name supplied to it into a standby mode.  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 set the VM into standby mode. 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 standby

Sample Configuration

Parameter Example Configuration
VM Name <%=@answers['VM Name']%>

Results

This handler returns no results.

Change Log

Version Date Description
V1 2011-01-27 Initial Version