Package org.jenkinsci.plugins.vsphere.builders

Class ExposeGuestInfo

java.lang.Object

org.jenkinsci.plugins.vsphere.VSphereBuildStep

org.jenkinsci.plugins.vsphere.builders.ExposeGuestInfo

All Implemented Interfaces:

ExtensionPoint, Describable<VSphereBuildStep>, BuildStep, SimpleBuildStep

public class ExposeGuestInfo
extends VSphereBuildStep
implements SimpleBuildStep

Expose guest info for the named VM as environmental variables. Information on variables can be found here. https://www.vmware.com/support/developer/converter-sdk/conv55_apireference/vim.vm.GuestInfo.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExposeGuestInfo.ExposeGuestInfoDescriptor

Nested classes/interfaces inherited from class org.jenkinsci.plugins.vsphere.VSphereBuildStep

VSphereBuildStep.VSphereBuildStepDescriptor

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Field Summary

Fields inherited from class org.jenkinsci.plugins.vsphere.VSphereBuildStep

vsphere

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
ExposeGuestInfo(String vm, String envVariablePrefix, Boolean waitForIp4)

Method Summary

Modifier and Type	Method	Description
boolean	exposeInfo(Run<?,?> run, Launcher launcher, TaskListener listener)
String	getEnvVariablePrefix()
String	getIP()
Action	getProjectAction(AbstractProject<?,?> abstractProject)
Collection<? extends Action>	getProjectActions(AbstractProject<?,?> abstractProject)
BuildStepMonitor	getRequiredMonitorService()
Map<String,String>	getVars()
String	getVm()
boolean	perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener)
void	perform(Run<?,?> run, FilePath filePath, Launcher launcher, TaskListener listener)
boolean	prebuild(AbstractBuild<?,?> abstractBuild, BuildListener buildListener)

Methods inherited from class org.jenkinsci.plugins.vsphere.VSphereBuildStep

all, allowDelete, getDescriptor, getVsphere, setVsphere

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Constructor Details

ExposeGuestInfo

@DataBoundConstructor
public ExposeGuestInfo(String vm,
 String envVariablePrefix,
 Boolean waitForIp4)
                throws VSphereException

Throws:

VSphereException

Method Details

getVm

public String getVm()

getEnvVariablePrefix

public String getEnvVariablePrefix()

getIP

public String getIP()

Overrides:

getIP in class VSphereBuildStep

getVars

public Map<String,String> getVars()

perform

public void perform(@NonNull
 Run<?,?> run,
 @NonNull
 FilePath filePath,
 @NonNull
 Launcher launcher,
 @NonNull
 TaskListener listener)
             throws InterruptedException,
IOException

Specified by:

perform in interface SimpleBuildStep

Specified by:

perform in class VSphereBuildStep

Throws:

InterruptedException

IOException

prebuild

public boolean prebuild(AbstractBuild<?,?> abstractBuild,
 BuildListener buildListener)

Specified by:

prebuild in interface BuildStep

perform

public boolean perform(AbstractBuild<?,?> build,
 Launcher launcher,
 BuildListener listener)

Specified by:

perform in interface BuildStep

Specified by:

perform in class VSphereBuildStep

getProjectAction

public Action getProjectAction(AbstractProject<?,?> abstractProject)

Specified by:

getProjectAction in interface BuildStep

getProjectActions

public Collection<? extends Action> getProjectActions(AbstractProject<?,?> abstractProject)

Specified by:

getProjectActions in interface BuildStep

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface BuildStep

exposeInfo

public boolean exposeInfo(Run<?,?> run,
 Launcher launcher,
 TaskListener listener)
                   throws Exception

Throws:

Exception