Package 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	Description
protected String	additionalParameters
protected boolean	become
protected String	becomeUser
protected final Run<?,?>	build
protected com.cloudbees.plugins.credentials.common.StandardUsernameCredentials	credentials
protected final Map<String,String>	environment
protected final EnvVars	envVars
protected String	exe
protected List<ExtraVar>	extraVars
protected int	forks
protected final TaskListener	listener
protected boolean	sudo
protected String	sudoUser
protected com.cloudbees.plugins.credentials.common.StandardCredentials	vaultCredentials
protected FilePath	vaultTmpPath

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	addKeyValuePair(ArgumentListBuilder args, String key, String value)
protected void	addOptionAndValue(ArgumentListBuilder args, String option, String value)
ArgumentListBuilder	appendAdditionalParameters(ArgumentListBuilder args)
protected ArgumentListBuilder	appendBecome(ArgumentListBuilder args)
protected ArgumentListBuilder	appendCheckMode(ArgumentListBuilder args)
protected ArgumentListBuilder	appendCredentials(ArgumentListBuilder args)
protected ArgumentListBuilder	appendExecutable(ArgumentListBuilder args)
ArgumentListBuilder	appendExtraVars(ArgumentListBuilder args)
ArgumentListBuilder	appendForks(ArgumentListBuilder args)
protected ArgumentListBuilder	appendInventory(ArgumentListBuilder args)
protected ArgumentListBuilder	appendSudo(ArgumentListBuilder args)
protected ArgumentListBuilder	appendVaultPasswordFile(ArgumentListBuilder args)
protected ArgumentListBuilder	buildCommandLine()
boolean	execute(CLIRunner runner)
protected ArgumentListBuilder	prependPasswordCredentials(ArgumentListBuilder args)
AnsiblePlaybookInvocation	setAdditionalParameters(String additionalParameters)
AnsiblePlaybookInvocation	setBecome(boolean become, String becomeUser)
AnsiblePlaybookInvocation	setCheckMode(boolean checkMode)
AnsiblePlaybookInvocation	setColorizedOutput(boolean colorizedOutput)
AnsiblePlaybookInvocation	setCredentials(com.cloudbees.plugins.credentials.common.StandardUsernameCredentials credentials)
AnsiblePlaybookInvocation	setCredentials(com.cloudbees.plugins.credentials.common.StandardUsernameCredentials credentials, boolean copyCredentialsInWorkspace)
AnsiblePlaybookInvocation	setDisableHostKeyCheck(boolean disableHostKeyChecking)
AnsiblePlaybookInvocation	setExtraVars(List<ExtraVar> extraVars)
AnsiblePlaybookInvocation	setForks(int forks)
AnsiblePlaybookInvocation	setInventory(Inventory inventory)
AnsiblePlaybookInvocation	setLimit(String limit)
AnsiblePlaybookInvocation	setPlaybook(String playbook)
AnsiblePlaybookInvocation	setSkippedTags(String skippedTags)
AnsiblePlaybookInvocation	setStartTask(String startAtTask)
AnsiblePlaybookInvocation	setSudo(boolean sudo, String sudoUser)
AnsiblePlaybookInvocation	setTags(String tags)
AnsiblePlaybookInvocation	setUnbufferedOutput(boolean unbufferedOutput)
AnsiblePlaybookInvocation	setVaultCredentials(com.cloudbees.plugins.credentials.common.StandardCredentials vaultCredentials)
AnsiblePlaybookInvocation	setVaultTmpPath(FilePath vaultTmpPath)

Methods inherited from class java.lang.Object

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

Field Details

envVars

protected final EnvVars envVars

listener

protected final TaskListener listener

build

protected final Run<?,?> build

environment

protected final Map<String,String> environment

exe

protected String exe

forks

protected int forks

become

protected boolean become

becomeUser

protected String becomeUser

sudo

protected boolean sudo

sudoUser

protected String sudoUser

vaultCredentials

protected com.cloudbees.plugins.credentials.common.StandardCredentials vaultCredentials

vaultTmpPath

protected FilePath vaultTmpPath

credentials

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

extraVars

protected List<ExtraVar> extraVars

additionalParameters

protected String additionalParameters

Constructor Details

AnsiblePlaybookInvocation

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

Throws:

IOException

InterruptedException

AnsibleInvocationException

AnsiblePlaybookInvocation

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

Throws:

IOException

InterruptedException

AnsibleInvocationException

Method Details

setPlaybook

public AnsiblePlaybookInvocation setPlaybook(String playbook)

setCheckMode

public AnsiblePlaybookInvocation setCheckMode(boolean checkMode)

setLimit

public AnsiblePlaybookInvocation setLimit(String limit)

setTags

public AnsiblePlaybookInvocation setTags(String tags)

setSkippedTags

public AnsiblePlaybookInvocation setSkippedTags(String skippedTags)

setStartTask

public AnsiblePlaybookInvocation setStartTask(String startAtTask)

appendCheckMode

protected ArgumentListBuilder appendCheckMode(ArgumentListBuilder args)

buildCommandLine

protected ArgumentListBuilder buildCommandLine()
                                        throws InterruptedException,
AnsibleInvocationException,
IOException

Throws:

InterruptedException

AnsibleInvocationException

IOException

appendExecutable

protected ArgumentListBuilder appendExecutable(ArgumentListBuilder args)

setInventory

public AnsiblePlaybookInvocation setInventory(Inventory inventory)

appendInventory

protected ArgumentListBuilder appendInventory(ArgumentListBuilder args)
                                       throws IOException,
InterruptedException,
AnsibleInvocationException

Throws:

IOException

InterruptedException

AnsibleInvocationException

setForks

public AnsiblePlaybookInvocation setForks(int forks)

appendForks

public ArgumentListBuilder appendForks(ArgumentListBuilder args)

setExtraVars

public AnsiblePlaybookInvocation setExtraVars(List<ExtraVar> extraVars)

appendExtraVars

public ArgumentListBuilder appendExtraVars(ArgumentListBuilder args)

setAdditionalParameters

public AnsiblePlaybookInvocation setAdditionalParameters(String additionalParameters)

appendAdditionalParameters

public ArgumentListBuilder appendAdditionalParameters(ArgumentListBuilder args)

setBecome

public AnsiblePlaybookInvocation setBecome(boolean become,
 String becomeUser)

appendBecome

protected ArgumentListBuilder appendBecome(ArgumentListBuilder args)

setSudo

public AnsiblePlaybookInvocation setSudo(boolean sudo,
 String sudoUser)

appendSudo

protected ArgumentListBuilder appendSudo(ArgumentListBuilder args)

addOptionAndValue

protected void addOptionAndValue(ArgumentListBuilder args,
 String option,
 String value)

addKeyValuePair

protected void addKeyValuePair(ArgumentListBuilder args,
 String key,
 String value)

setCredentials

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

setCredentials

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

setVaultCredentials

public AnsiblePlaybookInvocation setVaultCredentials(com.cloudbees.plugins.credentials.common.StandardCredentials vaultCredentials)

setVaultTmpPath

public AnsiblePlaybookInvocation setVaultTmpPath(FilePath vaultTmpPath)

prependPasswordCredentials

protected ArgumentListBuilder prependPasswordCredentials(ArgumentListBuilder args)

appendCredentials

protected ArgumentListBuilder appendCredentials(ArgumentListBuilder args)
                                         throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

appendVaultPasswordFile

protected ArgumentListBuilder appendVaultPasswordFile(ArgumentListBuilder args)
                                               throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

setUnbufferedOutput

public AnsiblePlaybookInvocation setUnbufferedOutput(boolean unbufferedOutput)

setColorizedOutput

public AnsiblePlaybookInvocation setColorizedOutput(boolean colorizedOutput)

setDisableHostKeyCheck

public AnsiblePlaybookInvocation setDisableHostKeyCheck(boolean disableHostKeyChecking)

execute

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

Throws:

IOException

InterruptedException

AnsibleInvocationException