org.jenkinsci.plugins.ansible

Class AnsiblePlaybookBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

org.jenkinsci.plugins.ansible.AnsiblePlaybookBuilder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep

public class AnsiblePlaybookBuilder
extends hudson.tasks.Builder

A builder which wraps an Ansible playbook invocation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnsiblePlaybookBuilder.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields

Modifier and Type	Field and Description
String	additionalParameters
String	ansibleName
boolean	colorizedOutput
String	credentialsId The id of the credentials to use.
int	forks
boolean	hostKeyChecking
Inventory	inventory
String	limit
String	playbook
String	skippedTags
String	startAtTask
boolean	sudo
String	sudoUser
String	tags
boolean	unbufferedOutput

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
AnsiblePlaybookBuilder(String ansibleName, String playbook, Inventory inventory, String limit, String tags, String skippedTags, String startAtTask, String credentialsId, boolean sudo, String sudoUser, int forks, boolean unbufferedOutput, boolean colorizedOutput, boolean hostKeyChecking, String additionalParameters)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Field Detail

ansibleName

public final String ansibleName

limit

public final String limit

tags

public final String tags

skippedTags

public final String skippedTags

startAtTask

public final String startAtTask

credentialsId

public final String credentialsId

The id of the credentials to use.

playbook

public final String playbook

inventory

public final Inventory inventory

sudo

public final boolean sudo

sudoUser

public final String sudoUser

forks

public final int forks

unbufferedOutput

public final boolean unbufferedOutput

colorizedOutput

public final boolean colorizedOutput

hostKeyChecking

public final boolean hostKeyChecking

additionalParameters

public final String additionalParameters

Constructor Detail

AnsiblePlaybookBuilder

@DataBoundConstructor
public AnsiblePlaybookBuilder(String ansibleName,
                                           String playbook,
                                           Inventory inventory,
                                           String limit,
                                           String tags,
                                           String skippedTags,
                                           String startAtTask,
                                           String credentialsId,
                                           boolean sudo,
                                           String sudoUser,
                                           int forks,
                                           boolean unbufferedOutput,
                                           boolean colorizedOutput,
                                           boolean hostKeyChecking,
                                           String additionalParameters)

Method Detail

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
              hudson.Launcher launcher,
              hudson.model.BuildListener listener)
                throws InterruptedException,
                       IOException

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

InterruptedException

IOException