Skip to main content
Kinetic Community

VMWare VSphere Virtual Machine Disk Add


Adds a disk of a specified size to the virtual machine.


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

Detailed Description

vmware-add-disk.pngThis handler is designed to add a disk to a virtual machine on a VMWare VSphere server. It logs into the VSphere server using the server's administrative URL (make /sdk is on the end of the URL), user id, and password that are set as info value records. Once logged in, the virtual machine that will have the disk added to it will be verified to make sure the the machine exists. The handler then goes through the process of creating a VirtualDisk with the name, mode, and size that were passed as parameters. Once the signal is sent to create the disk, the handler waits long enough to catch immediate errors, returns the task id, and then exits.

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 VM that you want to add the disk to.
Disk Name The name of the new disk (will be used to name the vmdk file that is stored on the datastore).
Disk Mode The disk persistence mode. Valid modes are 'persistent, independent_persistent, independent_nonpersistent, nonpersistent, undoable,append'.
Disk Size (GB) The disk size in GB.

Sample Configuration

Parameter Example Configuration
VM Name Test Task VM
Disk Name handler_disk
Disk Mode persistent
Disk Size (GB) 5


Name Description
Task Id Returns the task id of the addition operation so that the status can be easily checked later on.

Change Log

Version Date Description
V1 2015-09-15 Initial Version