org.jenkinsci.plugins.ansible

Class AnsiblePlaybookInvocation

java.lang.Object

org.jenkinsci.plugins.ansible.AnsiblePlaybookInvocation

public class AnsiblePlaybookInvocation
extends Object

Invoke the ansible-playbook command

Field Summary

Fields

Modifier and Type	Field and Description
protected String	additionalParameters
protected hudson.model.Run<?,?>	build
protected com.cloudbees.plugins.credentials.common.StandardUsernameCredentials	credentials
protected Map<String,String>	environment
protected hudson.EnvVars	envVars
protected String	exe
protected List<ExtraVar>	extraVars
protected int	forks
protected hudson.model.TaskListener	listener
protected boolean	sudo
protected String	sudoUser

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnsiblePlaybookInvocation(String exe, hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener, hudson.EnvVars envVars)
	AnsiblePlaybookInvocation(String exe, hudson.model.Run<?,?> build, hudson.FilePath ws, hudson.model.TaskListener listener, hudson.EnvVars envVars)

Method Summary

Modifier and Type	Method and Description
protected void	addKeyValuePair(hudson.util.ArgumentListBuilder args, String key, String value)
protected void	addOptionAndValue(hudson.util.ArgumentListBuilder args, String option, String value)
hudson.util.ArgumentListBuilder	appendAdditionalParameters(hudson.util.ArgumentListBuilder args)
protected hudson.util.ArgumentListBuilder	appendCredentials(hudson.util.ArgumentListBuilder args)
protected hudson.util.ArgumentListBuilder	appendExecutable(hudson.util.ArgumentListBuilder args)
hudson.util.ArgumentListBuilder	appendExtraVars(hudson.util.ArgumentListBuilder args)
hudson.util.ArgumentListBuilder	appendForks(hudson.util.ArgumentListBuilder args)
protected hudson.util.ArgumentListBuilder	appendInventory(hudson.util.ArgumentListBuilder args)
protected hudson.util.ArgumentListBuilder	appendSudo(hudson.util.ArgumentListBuilder args)
protected hudson.util.ArgumentListBuilder	buildCommandLine()
boolean	execute(CLIRunner runner)
protected hudson.util.ArgumentListBuilder	prependPasswordCredentials(hudson.util.ArgumentListBuilder args)
T	setAdditionalParameters(String additionalParameters)
T	setColorizedOutput(boolean colorizedOutput)
T	setCredentials(com.cloudbees.plugins.credentials.common.StandardUsernameCredentials credentials)
T	setCredentials(com.cloudbees.plugins.credentials.common.StandardUsernameCredentials credentials, boolean copyCredentialsInWorkspace)
T	setExtraVars(List<ExtraVar> extraVars)
T	setForks(int forks)
T	setHostKeyCheck(boolean hostKeyChecking)
T	setInventory(Inventory inventory)
AnsiblePlaybookInvocation	setLimit(String limit)
AnsiblePlaybookInvocation	setPlaybook(String playbook)
AnsiblePlaybookInvocation	setSkippedTags(String skippedTags)
AnsiblePlaybookInvocation	setStartTask(String startAtTask)
T	setSudo(boolean sudo, String sudoUser)
AnsiblePlaybookInvocation	setTags(String tags)
T	setUnbufferedOutput(boolean unbufferedOutput)

Methods inherited from class java.lang.Object

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

Field Detail

envVars

protected final hudson.EnvVars envVars

listener

protected final hudson.model.TaskListener listener

build

protected final hudson.model.Run<?,?> build

environment

protected final Map<String,String> environment

exe

protected String exe

forks

protected int forks

sudo

protected boolean sudo

sudoUser

protected String sudoUser

credentials

protected com.cloudbees.plugins.credentials.common.StandardUsernameCredentials credentials

extraVars

protected List<ExtraVar> extraVars

additionalParameters

protected String additionalParameters

Constructor Detail

AnsiblePlaybookInvocation

protected AnsiblePlaybookInvocation(String exe,
                                    hudson.model.AbstractBuild<?,?> build,
                                    hudson.model.BuildListener listener,
                                    hudson.EnvVars envVars)
                             throws IOException,
                                    InterruptedException,
                                    AnsibleInvocationException

Throws:

IOException

InterruptedException

AnsibleInvocationException

AnsiblePlaybookInvocation

public AnsiblePlaybookInvocation(String exe,
                                 hudson.model.Run<?,?> build,
                                 hudson.FilePath ws,
                                 hudson.model.TaskListener listener,
                                 hudson.EnvVars envVars)
                          throws IOException,
                                 InterruptedException,
                                 AnsibleInvocationException

Throws:

IOException

InterruptedException

AnsibleInvocationException

Method Detail

setPlaybook

public AnsiblePlaybookInvocation setPlaybook(String playbook)

setLimit

public AnsiblePlaybookInvocation setLimit(String limit)

setTags

public AnsiblePlaybookInvocation setTags(String tags)

setSkippedTags

public AnsiblePlaybookInvocation setSkippedTags(String skippedTags)

setStartTask

public AnsiblePlaybookInvocation setStartTask(String startAtTask)

buildCommandLine

protected hudson.util.ArgumentListBuilder buildCommandLine()
                                                    throws InterruptedException,
                                                           AnsibleInvocationException,
                                                           IOException

Throws:

InterruptedException

AnsibleInvocationException

IOException

appendExecutable

protected hudson.util.ArgumentListBuilder appendExecutable(hudson.util.ArgumentListBuilder args)

setInventory

public T setInventory(Inventory inventory)

appendInventory

protected hudson.util.ArgumentListBuilder appendInventory(hudson.util.ArgumentListBuilder args)
                                                   throws IOException,
                                                          InterruptedException,
                                                          AnsibleInvocationException

Throws:

IOException

InterruptedException

AnsibleInvocationException

setForks

public T setForks(int forks)

appendForks

public hudson.util.ArgumentListBuilder appendForks(hudson.util.ArgumentListBuilder args)

setExtraVars

public T setExtraVars(List<ExtraVar> extraVars)

appendExtraVars

public hudson.util.ArgumentListBuilder appendExtraVars(hudson.util.ArgumentListBuilder args)

setAdditionalParameters

public T setAdditionalParameters(String additionalParameters)

appendAdditionalParameters

public hudson.util.ArgumentListBuilder appendAdditionalParameters(hudson.util.ArgumentListBuilder args)

setSudo

public T setSudo(boolean sudo,
                 String sudoUser)

appendSudo

protected hudson.util.ArgumentListBuilder appendSudo(hudson.util.ArgumentListBuilder args)

addOptionAndValue

protected void addOptionAndValue(hudson.util.ArgumentListBuilder args,
                                 String option,
                                 String value)

addKeyValuePair

protected void addKeyValuePair(hudson.util.ArgumentListBuilder args,
                               String key,
                               String value)

setCredentials

public T setCredentials(com.cloudbees.plugins.credentials.common.StandardUsernameCredentials credentials)

setCredentials

public T setCredentials(com.cloudbees.plugins.credentials.common.StandardUsernameCredentials credentials,
                        boolean copyCredentialsInWorkspace)

prependPasswordCredentials

protected hudson.util.ArgumentListBuilder prependPasswordCredentials(hudson.util.ArgumentListBuilder args)

appendCredentials

protected hudson.util.ArgumentListBuilder appendCredentials(hudson.util.ArgumentListBuilder args)
                                                     throws IOException,
                                                            InterruptedException

Throws:

IOException

InterruptedException

setUnbufferedOutput

public T setUnbufferedOutput(boolean unbufferedOutput)

setColorizedOutput

public T setColorizedOutput(boolean colorizedOutput)

setHostKeyCheck

public T setHostKeyCheck(boolean hostKeyChecking)

execute

public boolean execute(CLIRunner runner)
                throws IOException,
                       InterruptedException,
                       AnsibleInvocationException

Throws:

IOException

InterruptedException

AnsibleInvocationException