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 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	AnsiblePlaybookInvocation(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)
AnsiblePlaybookInvocation	setHostPattern(String playbook)
T	setInventory(Inventory inventory)
AnsiblePlaybookInvocation	setLimit(String limit)
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.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

AnsiblePlaybookInvocation

protected AnsiblePlaybookInvocation(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 AnsiblePlaybookInvocation setHostPattern(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)

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