Package org.jenkinsci.plugins.ansible

Class AnsibleAdHocCommandInvocation

java.lang.Object

org.jenkinsci.plugins.ansible.AnsibleAdHocCommandInvocation

public class AnsibleAdHocCommandInvocation
extends Object

Invoke the ansible 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	AnsibleAdHocCommandInvocation(String exe, AbstractBuild<?,?> build, BuildListener listener)
	AnsibleAdHocCommandInvocation(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	appendCredentials(ArgumentListBuilder args)
protected ArgumentListBuilder	appendExecutable(ArgumentListBuilder args)
ArgumentListBuilder	appendExtraVars(ArgumentListBuilder args)
ArgumentListBuilder	appendForks(ArgumentListBuilder args)
protected ArgumentListBuilder	appendInventory(ArgumentListBuilder args)
ArgumentListBuilder	appendModuleCommand(ArgumentListBuilder args)
protected ArgumentListBuilder	appendSudo(ArgumentListBuilder args)
protected ArgumentListBuilder	appendVaultPasswordFile(ArgumentListBuilder args)
protected ArgumentListBuilder	buildCommandLine()
boolean	execute(CLIRunner runner)
protected ArgumentListBuilder	prependPasswordCredentials(ArgumentListBuilder args)
AnsibleAdHocCommandInvocation	setAdditionalParameters(String additionalParameters)
AnsibleAdHocCommandInvocation	setBecome(boolean become, String becomeUser)
AnsibleAdHocCommandInvocation	setColorizedOutput(boolean colorizedOutput)
AnsibleAdHocCommandInvocation	setCredentials(com.cloudbees.plugins.credentials.common.StandardUsernameCredentials credentials)
AnsibleAdHocCommandInvocation	setCredentials(com.cloudbees.plugins.credentials.common.StandardUsernameCredentials credentials, boolean copyCredentialsInWorkspace)
AnsibleAdHocCommandInvocation	setDisableHostKeyCheck(boolean disableHostKeyChecking)
AnsibleAdHocCommandInvocation	setExtraVars(List<ExtraVar> extraVars)
AnsibleAdHocCommandInvocation	setForks(int forks)
AnsibleAdHocCommandInvocation	setHostPattern(String hostPattern)
AnsibleAdHocCommandInvocation	setInventory(Inventory inventory)
AnsibleAdHocCommandInvocation	setModule(String module)
AnsibleAdHocCommandInvocation	setModuleCommand(String command)
AnsibleAdHocCommandInvocation	setSudo(boolean sudo, String sudoUser)
AnsibleAdHocCommandInvocation	setUnbufferedOutput(boolean unbufferedOutput)
AnsibleAdHocCommandInvocation	setVaultCredentials(com.cloudbees.plugins.credentials.common.StandardCredentials vaultCredentials)
AnsibleAdHocCommandInvocation	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

AnsibleAdHocCommandInvocation

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

Throws:

IOException

InterruptedException

AnsibleInvocationException

AnsibleAdHocCommandInvocation

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

Throws:

IOException

InterruptedException

AnsibleInvocationException

Method Details

setHostPattern

public AnsibleAdHocCommandInvocation setHostPattern(String hostPattern)

setModule

public AnsibleAdHocCommandInvocation setModule(String module)

setModuleCommand

public AnsibleAdHocCommandInvocation setModuleCommand(String command)

appendModuleCommand

public ArgumentListBuilder appendModuleCommand(ArgumentListBuilder args)

buildCommandLine

protected ArgumentListBuilder buildCommandLine()
                                        throws InterruptedException,
AnsibleInvocationException,
IOException

Throws:

InterruptedException

AnsibleInvocationException

IOException

appendExecutable

protected ArgumentListBuilder appendExecutable(ArgumentListBuilder args)

setInventory

public AnsibleAdHocCommandInvocation setInventory(Inventory inventory)

appendInventory

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

Throws:

IOException

InterruptedException

AnsibleInvocationException

setForks

public AnsibleAdHocCommandInvocation setForks(int forks)

appendForks

public ArgumentListBuilder appendForks(ArgumentListBuilder args)

setExtraVars

public AnsibleAdHocCommandInvocation setExtraVars(List<ExtraVar> extraVars)

appendExtraVars

public ArgumentListBuilder appendExtraVars(ArgumentListBuilder args)

setAdditionalParameters

public AnsibleAdHocCommandInvocation setAdditionalParameters(String additionalParameters)

appendAdditionalParameters

public ArgumentListBuilder appendAdditionalParameters(ArgumentListBuilder args)

setBecome

public AnsibleAdHocCommandInvocation setBecome(boolean become,
 String becomeUser)

appendBecome

protected ArgumentListBuilder appendBecome(ArgumentListBuilder args)

setSudo

public AnsibleAdHocCommandInvocation 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 AnsibleAdHocCommandInvocation setCredentials(com.cloudbees.plugins.credentials.common.StandardUsernameCredentials credentials)

setCredentials

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

setVaultCredentials

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

setVaultTmpPath

public AnsibleAdHocCommandInvocation 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 AnsibleAdHocCommandInvocation setUnbufferedOutput(boolean unbufferedOutput)

setColorizedOutput

public AnsibleAdHocCommandInvocation setColorizedOutput(boolean colorizedOutput)

setDisableHostKeyCheck

public AnsibleAdHocCommandInvocation setDisableHostKeyCheck(boolean disableHostKeyChecking)

execute

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

Throws:

IOException

InterruptedException

AnsibleInvocationException