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 and Description
protected hudson.util.ArgumentListBuilder	args
protected hudson.model.AbstractBuild<?,?>	build
protected Map<String,String>	environment
protected hudson.EnvVars	envVars
protected hudson.Launcher	launcher
protected hudson.model.BuildListener	listener

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnsibleAdHocCommandInvocation(String ansibleInstallation, hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	execute()
T	setAdditionalParameters(String additionalParameters)
T	setColorizedOutput(boolean colorizedOutput)
T	setCredentials(String credentialsId)
T	setForks(int forks)
T	setHostKeyCheck(boolean hostKeyChecking)
AnsibleAdHocCommandInvocation	setHostPattern(String hostPattern)
T	setInventory(Inventory inventory)
AnsibleAdHocCommandInvocation	setModule(String module)
AnsibleAdHocCommandInvocation	setModuleCommand(String command)
T	setSudo(boolean sudo, String sudoUser)
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.BuildListener listener

build

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

args

protected final hudson.util.ArgumentListBuilder args

environment

protected final Map<String,String> environment

launcher

protected final hudson.Launcher launcher

Constructor Detail

AnsibleAdHocCommandInvocation

protected AnsibleAdHocCommandInvocation(String ansibleInstallation,
                             hudson.model.AbstractBuild<?,?> build,
                             hudson.Launcher launcher,
                             hudson.model.BuildListener listener)
                                 throws IOException,
                                        InterruptedException,
                                        AnsibleInvocationException

Throws:

IOException

InterruptedException

AnsibleInvocationException

Method Detail

setHostPattern

public AnsibleAdHocCommandInvocation setHostPattern(String hostPattern)

setModule

public AnsibleAdHocCommandInvocation setModule(String module)

setModuleCommand

public AnsibleAdHocCommandInvocation setModuleCommand(String command)

setInventory

public T setInventory(Inventory inventory)
                                                                                  throws IOException,
                                                                                         InterruptedException,
                                                                                         AnsibleInvocationException

Throws:

IOException

InterruptedException

AnsibleInvocationException

setForks

public T setForks(int forks)

setAdditionalParameters

public T setAdditionalParameters(String additionalParameters)

setSudo

public T setSudo(boolean sudo,
        String sudoUser)

setCredentials

public T setCredentials(String credentialsId)
                                                                                    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()
                throws IOException,
                       InterruptedException

Throws:

IOException

InterruptedException