Package org.jenkinsci.plugins.ansible
Class AnsiblePlaybookBuilder
- java.lang.Object
-
- hudson.tasks.BuildStepCompatibilityLayer
-
- hudson.tasks.Builder
-
- org.jenkinsci.plugins.ansible.AnsiblePlaybookBuilder
-
- All Implemented Interfaces:
ExtensionPoint
,Describable<Builder>
,BuildStep
,SimpleBuildStep
public class AnsiblePlaybookBuilder extends Builder implements SimpleBuildStep
A builder which wraps an Ansible playbook invocation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AnsiblePlaybookBuilder.DescriptorImpl
-
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 Modifier and Type Field Description String
additionalParameters
String
ansibleName
boolean
become
String
becomeUser
boolean
checkMode
boolean
colorizedOutput
boolean
copyCredentialsInWorkspace
String
credentialsId
The id of the credentials to use.boolean
disableHostKeyChecking
List<ExtraVar>
extraVars
int
forks
boolean
hostKeyChecking
Deprecated.Inventory
inventory
String
limit
String
playbook
String
skippedTags
String
startAtTask
boolean
sudo
String
sudoUser
String
tags
boolean
unbufferedOutput
String
vaultCredentialsId
String
vaultTmpPath
-
Fields inherited from interface hudson.tasks.BuildStep
BUILDERS, PUBLISHERS
-
-
Constructor Summary
Constructors Constructor Description AnsiblePlaybookBuilder(String ansibleName, String playbook, Inventory inventory, String limit, String tags, String skippedTags, String startAtTask, String credentialsId, boolean sudo, String sudoUser, int forks, boolean unbufferedOutput, boolean colorizedOutput, boolean hostKeyChecking, String additionalParameters)
Deprecated.AnsiblePlaybookBuilder(String playbook, Inventory inventory)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BuildStepMonitor
getRequiredMonitorService()
void
perform(Run<?,?> run, FilePath ws, Launcher launcher, TaskListener listener)
void
perform(Run<?,?> run, Node node, FilePath ws, Launcher launcher, TaskListener listener, EnvVars envVars)
void
setAdditionalParameters(String additionalParameters)
void
setAnsibleName(String ansibleName)
void
setBecome(boolean become)
void
setBecomeUser(String becomeUser)
void
setCheckMode(boolean checkMode)
void
setColorizedOutput(boolean colorizedOutput)
void
setCredentialsId(String credentialsId)
void
setCredentialsId(String credentialsId, boolean copyCredentialsInWorkspace)
void
setDisableHostKeyChecking(boolean disableHostKeyChecking)
void
setExtraVars(List<ExtraVar> extraVars)
void
setForks(int forks)
void
setHostKeyChecking(boolean hostKeyChecking)
Deprecated.void
setLimit(String limit)
void
setSkippedTags(String skippedTags)
void
setStartAtTask(String startAtTask)
void
setSudo(boolean sudo)
void
setSudoUser(String sudoUser)
void
setTags(String tags)
void
setUnbufferedOutput(boolean unbufferedOutput)
void
setVaultCredentialsId(String vaultCredentialsId)
void
setVaultTmpPath(String vaultTmpPath)
-
Methods inherited from class hudson.tasks.Builder
all, getDescriptor, prebuild
-
Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer
getProjectAction, getProjectAction, getProjectActions, perform, perform, prebuild
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface hudson.tasks.BuildStep
getProjectAction, getProjectActions, perform, prebuild
-
Methods inherited from interface jenkins.tasks.SimpleBuildStep
perform, perform, requiresWorkspace
-
-
-
-
Field Detail
-
playbook
public final String playbook
-
inventory
public final Inventory inventory
-
ansibleName
public String ansibleName
-
limit
public String limit
-
tags
public String tags
-
skippedTags
public String skippedTags
-
startAtTask
public String startAtTask
-
credentialsId
public String credentialsId
The id of the credentials to use.
-
vaultCredentialsId
public String vaultCredentialsId
-
vaultTmpPath
public String vaultTmpPath
-
become
public boolean become
-
becomeUser
public String becomeUser
-
checkMode
public boolean checkMode
-
sudo
public boolean sudo
-
sudoUser
public String sudoUser
-
forks
public int forks
-
unbufferedOutput
public boolean unbufferedOutput
-
colorizedOutput
public boolean colorizedOutput
-
disableHostKeyChecking
public boolean disableHostKeyChecking
-
hostKeyChecking
@Deprecated public transient boolean hostKeyChecking
Deprecated.
-
additionalParameters
public String additionalParameters
-
copyCredentialsInWorkspace
public boolean copyCredentialsInWorkspace
-
-
Constructor Detail
-
AnsiblePlaybookBuilder
@Deprecated public AnsiblePlaybookBuilder(String ansibleName, String playbook, Inventory inventory, String limit, String tags, String skippedTags, String startAtTask, String credentialsId, boolean sudo, String sudoUser, int forks, boolean unbufferedOutput, boolean colorizedOutput, boolean hostKeyChecking, String additionalParameters)
Deprecated.
-
-
Method Detail
-
setAnsibleName
@DataBoundSetter public void setAnsibleName(String ansibleName)
-
setLimit
@DataBoundSetter public void setLimit(String limit)
-
setTags
@DataBoundSetter public void setTags(String tags)
-
setSkippedTags
@DataBoundSetter public void setSkippedTags(String skippedTags)
-
setStartAtTask
@DataBoundSetter public void setStartAtTask(String startAtTask)
-
setCredentialsId
@DataBoundSetter public void setCredentialsId(String credentialsId)
-
setCredentialsId
public void setCredentialsId(String credentialsId, boolean copyCredentialsInWorkspace)
-
setVaultCredentialsId
@DataBoundSetter public void setVaultCredentialsId(String vaultCredentialsId)
-
setVaultTmpPath
@DataBoundSetter public void setVaultTmpPath(String vaultTmpPath)
-
setBecome
public void setBecome(boolean become)
-
setBecomeUser
@DataBoundSetter public void setBecomeUser(String becomeUser)
-
setSudo
@DataBoundSetter public void setSudo(boolean sudo)
-
setCheckMode
@DataBoundSetter public void setCheckMode(boolean checkMode)
-
setSudoUser
@DataBoundSetter public void setSudoUser(String sudoUser)
-
setForks
@DataBoundSetter public void setForks(int forks)
-
setUnbufferedOutput
@DataBoundSetter public void setUnbufferedOutput(boolean unbufferedOutput)
-
setColorizedOutput
@DataBoundSetter public void setColorizedOutput(boolean colorizedOutput)
-
setDisableHostKeyChecking
@DataBoundSetter public void setDisableHostKeyChecking(boolean disableHostKeyChecking)
-
setHostKeyChecking
@DataBoundSetter @Deprecated public void setHostKeyChecking(boolean hostKeyChecking)
Deprecated.
-
setAdditionalParameters
@DataBoundSetter public void setAdditionalParameters(String additionalParameters)
-
perform
public void perform(@Nonnull Run<?,?> run, @Nonnull FilePath ws, @Nonnull Launcher launcher, @Nonnull TaskListener listener) throws InterruptedException, IOException
- Specified by:
perform
in interfaceSimpleBuildStep
- Throws:
InterruptedException
IOException
-
perform
public void perform(@Nonnull Run<?,?> run, @Nonnull Node node, @Nonnull FilePath ws, @Nonnull Launcher launcher, @Nonnull TaskListener listener, EnvVars envVars) throws InterruptedException, IOException
- Throws:
InterruptedException
IOException
-
getRequiredMonitorService
public BuildStepMonitor getRequiredMonitorService()
- Specified by:
getRequiredMonitorService
in interfaceBuildStep
- Overrides:
getRequiredMonitorService
in classBuilder
-
-