Add VMware vSphere support to Jenkins by making available multiple vSphere Build Steps and supporting the use of Virtual Machines as slaves.
This plugin adds a way to control Virtual Machines hosted in a VMware vSphere server using Jenkins. You can configure a Jenkins Slave to use a virtual machine, including an optional snapshot name. If configured to do so, Jenkins will (optionally) revert, then start the virtual machine as a slave. If configured to do so, Jenkins will also shutdown and (optionally) revert the virtual machine when all jobs have finished processing.
Additionally, you can manipulate your vSphere VMs & templates using any of the vSphere Build steps provided by this plugin.
The first step is to configure Jenkins to know what vSphere server you will be using. To do this you need to add a new "Cloud" in the Jenkins "Configure System" menu.
Enter your vSphere host name (the name of the VMware vCenter); it usually has a format of https://host-name-or-IP-address You will also need to enter a display name for the vSphere cloud, a user name and password. The user you enter will need to have power up/down and revert access to the virtual machines that will be used as slaves. The Test Connection button will test to see if your vSphere is accessible with the specified host name, user name and password.
This feature - when enabled by using a value greater than 0 - will cause the slave to disconnect after the number of builds has been reached. The disconnect action will be performed when the last build is completed.
This build step will clone an existing Template or VM to a new VM. Linked clones are optional. Cluster, Resource Pool, and Datastore can be specified.
This build step will create a VM from the specified template. The template must have at least one snapshot before it can be cloned. A linked clone may optionally be chosen. The new VM will be placed in the same folder and storage device as the original template, and will use the specified ResourcePool and Cluster.
This build step will mark the specified VM as a template. The VM must be powered down first, or the user must use the "force" option.
This build step will convert a template into the VM.
This build step will delete the specified VM. At this time, templates will not be deleted by this build step.
As an additional precaution against accidental deletion, if the name or description associated with the vSphere Cloud changes after the Job has been saved, the job will need to be re-saved before it will function correctly.
WARNING: THIS IS A DESTRUCTIVE OPERATION THAT WILL DELETE THE VIRTUAL MACHINE WITHOUT ADDITIONAL CONFIRMATION. IT CANNOT BE UNDONE.
This build step will delete a snapshot, and optional allow consolidation of the disk.
This build step will power on the specified VM and store the IP address in the "VSPHERE_IP" environment variable. The build step will wait as long as specified in the "timeout" field (max 3600 seconds). This build step will resume suspended VMs as well.
This build step will power off the specified VM. There is an optional "Graceful shutdown", to attempt a shutdown via VMware Tools, if it's installed.
This build step will allow selectively reconfiguration of the VM. Available at this time are the following reconfigurations:
This build step allows renaming of a snapshot.
This build step will allow renaming the VM
This build step will suspend the specified VM.
This build step will revert the specified VM to the specified snapshot.
This build step will take a snapshot of the specified VM using the specified Snapshot name, description, and whether or not to include memory in the snapshot.
This build step will delete a specified snapshot from a specified VM. It will optionally consolidate all of the VM's disks.
WARNING: THIS IS A DESTRUCTIVE OPERATION THAT WILL DELETE THE SNAPSHOT WITHOUT ADDITIONAL CONFIRMATION. IT CANNOT BE UNDONE.
This plugin is supposed to work in the following environments:
This plugin will NOT work with the following VMWare products:
Version 2.3 (February 3rd, 2015)
Skip to end of metadata Go to start of metadata