The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.
For a list of other such plugins, see the Pipeline Steps Reference page.
ankaGetSaveImageResult
: Wait for previous save image requests resultsshouldFail
boolean
timeoutMinutes
int
createDynamicAnkaNode
: create dynamic anka nodemasterVmId
(optional)
String
SSHPort
(optional)
int
credentialsId
(optional)
String
deleteLatest
(optional)
boolean
description
(optional)
String
dontAppendTimestamp
(optional)
boolean
environments
(optional)
name
String
value
String
extraArgs
(optional)
String
group
(optional)
String
javaArgs
(optional)
String
jnlpJenkinsOverrideUrl
(optional)
String
jnlpTunnel
(optional)
String
keepAliveOnError
(optional)
boolean
labelString
(optional)
String
launchDelay
(optional)
int
launchMethod
(optional)
String
mode
(optional)
NORMAL
, EXCLUSIVE
nameTemplate
(optional)
String
numberOfExecutors
(optional)
int
priority
(optional)
int
pushTag
(optional)
String
remoteFS
(optional)
String
retentionStrategy
(optional)
agent-maintenance
regularRetentionStrategy
hudson.slaves.RetentionStrategy<hudson.slaves.SlaveComputer>
$class: 'AlmostAlways'
always
$class: 'AzureVMCloudOnceRetentionStrategy'
$class: 'AzureVMCloudPoolRetentionStrategy'
retentionInHours
int
poolSize
int
azureVMCloudRetentionStrategy
idleTerminationMinutes
int
$class: 'ContainerIdleRetentionStrategy'
idleMinutes
int
$class: 'ContainerOnceRetentionStrategy'
demand
inDemandDelay
long
idleDelay
long
$class: 'DockerCloudRetentionStrategy'
idleMinutes
int
$class: 'DockerSwarmAgentRetentionStrategy'
timeout
int
$class: 'IdleTimeCloudRetentionStrategy'
idleMinutes
int
demand
inDemandDelay
long
idleDelay
long
conflictsWith
(optional)
Optional regular expression (or string in trivial case) with name(s) of node(s) whose being online blocks the current node from starting.
To properly take advantage of this, be sure to set low idleDelay timeout values for those other workers that no longer have work pending.
Note that conflict is evaluated one way ("should this node start if inDemandDelay has elapsed?"), so all nodes in question should declare each other as conflicting -- e.g. by copying the regular expression, if such node names follow the same pattern. In any case, a node would not conflict with itself even if there is a match.
As with other regular expressions, "negative look-ahead" can be used to exclude certain results from the following matching pattern, e.g.:
^(?!myServer$)(.*erver.*)$
This setting allows a Jenkins deployment to co-locate various pre-defined or otherwise provisioned build environments without overwhelming their host -- and instead permits round-robining, one by one.
String
schedule
startTimeSpec
String
upTimeMins
int
keepUpWhenActive
boolean
$class: 'VSphereCloudRetentionStrategy'
idleMinutes
int
$class: 'com.github.kostyasha.yad.strategy.DockerOnceRetentionStrategy'
idleMinutes
int
$class: 'com.nirima.jenkins.plugins.docker.strategy.DockerOnceRetentionStrategy'
idleMinutes
int
numberOfTasksInProgress
(optional)
int
terminateOnceDone
(optional)
boolean
$class: 'com.veertu.plugin.anka.RunOnceCloudRetentionStrategy'
idleMinutes
int
$class: 'io.jenkins.plugins.orka.RunOnceCloudRetentionStrategy'
idleMinutes
int
$class: 'org.jenkinsci.plugins.vsphere.RunOnceCloudRetentionStrategy'
idleMinutes
int
saveImage
(optional)
boolean
suspend
(optional)
boolean
tag
(optional)
String
templateDescription
(optional)
String
templateId
(optional)
String
timeout
(optional)
int
Please submit your feedback about this page through this quick form.
Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?
See existing feedback here.