org.jenkinsci.plugins.ansible

Class AnsibleAdHocCommandBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

org.jenkinsci.plugins.ansible.AnsibleAdHocCommandBuilder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep, jenkins.tasks.SimpleBuildStep

public class AnsibleAdHocCommandBuilder
extends hudson.tasks.Builder
implements jenkins.tasks.SimpleBuildStep

A builder which wraps an Ansible Ad-Hoc command invocation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnsibleAdHocCommandBuilder.DescriptorImpl

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

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

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

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
String	additionalParameters
String	ansibleName
boolean	colorizedOutput
String	command
String	credentialsId The id of the credentials to use.
int	forks
boolean	hostKeyChecking
String	hostPattern
Inventory	inventory Path to the inventory file.
String	module
boolean	sudo
String	sudoUser
boolean	unbufferedOutput

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
AnsibleAdHocCommandBuilder(String hostPattern, Inventory inventory, String module, String command)
AnsibleAdHocCommandBuilder(String ansibleName, String hostPattern, Inventory inventory, String module, String command, String credentialsId, boolean sudo, String sudoUser, int forks, boolean unbufferedOutput, boolean colorizedOutput, boolean hostKeyChecking, String additionalParameters) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	perform(hudson.model.Run<?,?> run, hudson.FilePath ws, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	setAdditionalParameters(String additionalParameters)
void	setAnsibleName(String ansibleName)
void	setColorizedOutput(boolean colorizedOutput)
void	setCredentialsId(String credentialsId)
void	setForks(int forks)
void	setHostKeyChecking(boolean hostKeyChecking)
void	setSudo(boolean sudo)
void	setSudoUser(String sudoUser)
void	setUnbufferedOutput(boolean unbufferedOutput)

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, getRequiredMonitorService, 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, getRequiredMonitorService, perform, prebuild

Field Detail

ansibleName

public String ansibleName

credentialsId

public String credentialsId

The id of the credentials to use.

hostPattern

public final String hostPattern

inventory

public final Inventory inventory

Path to the inventory file.

module

public final String module

command

public final String command

sudo

public boolean sudo

sudoUser

public String sudoUser

forks

public int forks

unbufferedOutput

public boolean unbufferedOutput

colorizedOutput

public boolean colorizedOutput

hostKeyChecking

public boolean hostKeyChecking

additionalParameters

public String additionalParameters

Constructor Detail

AnsibleAdHocCommandBuilder

@Deprecated
public AnsibleAdHocCommandBuilder(String ansibleName,
                                              String hostPattern,
                                              Inventory inventory,
                                              String module,
                                              String command,
                                              String credentialsId,
                                              boolean sudo,
                                              String sudoUser,
                                              int forks,
                                              boolean unbufferedOutput,
                                              boolean colorizedOutput,
                                              boolean hostKeyChecking,
                                              String additionalParameters)

Deprecated.

AnsibleAdHocCommandBuilder

@DataBoundConstructor
public AnsibleAdHocCommandBuilder(String hostPattern,
                                                        Inventory inventory,
                                                        String module,
                                                        String command)

Method Detail

setAnsibleName

@DataBoundSetter
public void setAnsibleName(String ansibleName)

setCredentialsId

@DataBoundSetter
public void setCredentialsId(String credentialsId)

setSudo

@DataBoundSetter
public void setSudo(boolean sudo)

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)

setHostKeyChecking

@DataBoundSetter
public void setHostKeyChecking(boolean hostKeyChecking)

setAdditionalParameters

@DataBoundSetter
public void setAdditionalParameters(String additionalParameters)

perform

public void perform(@Nonnull
                    hudson.model.Run<?,?> run,
                    @Nonnull
                    hudson.FilePath ws,
                    @Nonnull
                    hudson.Launcher launcher,
                    @Nonnull
                    hudson.model.TaskListener listener)
             throws InterruptedException,
                    IOException

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

InterruptedException

IOException