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.
step([$class: 'BuildStepsFromJsonBuilder'])
: Build Steps from JsonbuildStep
$class: 'A3Builder'
project_file : String
analysis_ids : String
pedantic_level : String
export_a3apxworkspace : String
copy_report_file : boolean
copy_result_file : boolean
skip_a3_analysis : boolean
$class: 'ACSDeploymentBuilder'
context
java.lang.TypeNotPresentException: Type org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint not present
ACXScanBuilder
ncScanType : String
ncWebsiteId : String
ncProfileId : String
ncDoNotFail : boolean
(optional)
ncReportType : String
(optional)
acxServerURL : String
(optional)
credentialsId : String
(optional)
ncApiToken : Object
(optional)
ncConfirmed : boolean
(optional)
ncIgnoreFalsePositive : boolean
(optional)
ncIgnoreRiskAccepted : boolean
(optional)
ncSeverity : String
(optional)
ncStopScan : boolean
(optional)
cfyAzureArm
azureCredentialsId : String
(optional)
The ID of the credentials to use when accessing Azure. Parameters' expansion is supported when using freestyle jobs.
credentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugOutput : boolean
(optional)
deploymentId : String
(optional)
echoEnvData : boolean
(optional)
If checked, then the created environment's data will be printed to the job's log.
echoInputs : boolean
(optional)
envDataLocation : String
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
location : String
(optional)
The Azure location where the created resource group should reside in. If omitted, the value of the azure_default_location
Cloudify secret will be used.
parameters
(optional)
YAML/JSON of parameters to pass to the template.
java.util.Map<java.lang.String, java.lang.Object>
parametersAsString : String
(optional)
parametersFile : String
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
resourceGroupName : String
(optional)
Name of resource group to create for the template.
templateFile : String
(optional)
Workspace-relative path of the ARM template file.
tenant : String
(optional)
$class: 'AWSEBBuilder'
extensions
awsRegion
GovCloud
, US_GOV_EAST_1
, US_EAST_1
, US_EAST_2
, US_WEST_1
, US_WEST_2
, EU_WEST_1
, EU_WEST_2
, EU_WEST_3
, EU_CENTRAL_1
, EU_CENTRAL_2
, EU_NORTH_1
, EU_SOUTH_1
, EU_SOUTH_2
, AP_EAST_1
, AP_SOUTH_1
, AP_SOUTH_2
, AP_SOUTHEAST_1
, AP_SOUTHEAST_2
, AP_SOUTHEAST_3
, AP_SOUTHEAST_4
, AP_NORTHEAST_1
, AP_NORTHEAST_2
, AP_NORTHEAST_3
, SA_EAST_1
, CN_NORTH_1
, CN_NORTHWEST_1
, CA_CENTRAL_1
, ME_CENTRAL_1
, ME_SOUTH_1
, AF_SOUTH_1
, US_ISO_EAST_1
, US_ISOB_EAST_1
, US_ISO_WEST_1
, IL_CENTRAL_1
awsRegionText : String
credentialsString : String
credentialsText : String
applicationName : String
versionLabelFormat : String
versionDescriptionFormat : String
failOnError : boolean
extensions
$class: 'AWSEBElasticBeanstalkSetup'
$class: 'AWSEBS3Setup'
bucketName : String
bucketRegion : String
keyPrefix : String
rootObject : String
Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.
It could be either a path to a zip file or a directory.
If its a directory, includes and excludes are used to build the zip file
includes : String
excludes : String
overwriteExistingFile : boolean
useTransferAcceleration : boolean
$class: 'ByName'
envNameList : String
$class: 'ByUrl'
urlList : String
envLookup
$class: 'AWSEBElasticBeanstalkSetup'
$class: 'AWSEBS3Setup'
bucketName : String
bucketRegion : String
keyPrefix : String
rootObject : String
Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.
It could be either a path to a zip file or a directory.
If its a directory, includes and excludes are used to build the zip file
includes : String
excludes : String
overwriteExistingFile : boolean
useTransferAcceleration : boolean
$class: 'ByName'
envNameList : String
$class: 'ByUrl'
urlList : String
$class: 'AWSEBDeploymentBuilder'
config
class br.com.ingenieux.jenkins.plugins.awsebdeployment.AWSEBDeploymentConfig
applicationName : String
(optional)
awsRegion : String
(optional)
bucketName : String
(optional)
S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
(Optional, will call createStorageLocation
if blank)
checkHealth : boolean
(optional)
credentialId : String
(optional)
environmentName : String
(optional)
Optional: AWS EB Environment name(s) to deploy to.
Can accept single or multiple comma-separated values. Examples:
When this value is set and each requested environment exists, an UpdateEnvironment call will be triggered as the Application Version is created.
excludes : String
(optional)
includes : String
(optional)
keyPrefix : String
(optional)
maxAttempts : int
(optional)
rootObject : String
(optional)
Workspace-relative path of the artifact file to upload (if it's a file), or if it's a directory, the base directory to build the zip/war against
Examples:
target/mywebapp.war
: The war file will be uploaded.
' or 'target/war
': A Zip file will be built and uploaded instead (using includes and excludes).skipEnvironmentUpdates : boolean
(optional)
sleepTime : int
(optional)
versionDescriptionFormat : String
(optional)
versionLabelFormat : String
(optional)
zeroDowntime : boolean
(optional)
awsebReleaser
credentialId : String
awsRegion : String
applicationName : String
environmentId : String
versionLabel : String
abapCi
abapPackagename : String
(optional)
atcVariant : String
(optional)
sapSystemLabel : String
(optional)
runAtcChecks : boolean
(optional)
runUnitTests : boolean
(optional)
treatWarningAtcChecksAsErrors : boolean
(optional)
useJenkinsProjectName : boolean
(optional)
withCoverage : boolean
(optional)
snActivatePlugin
credentialsId : String
(optional)
apiVersion : String
(optional)
pluginId : String
(optional)
url : String
(optional)
addchangestobuildchangelog
changelogPath : String
changelogText : String
$class: 'AddComment'
prefix : String
note : String
logfile : String
$class: 'AddTestToSetStep'
domain : String
project : String
testPlanPath : String
testSetPath : String
allocateDS
dsn : String
dsOrg
PO
, POE
, PS
, VS
primary : int
secondary : int
recFm
F
, FB
, V
, VB
, U
, VSAM
, VA
alcUnit
(optional)
TRK
, CYL
avgBlk : int
(optional)
blkSize : int
(optional)
dataClass : String
(optional)
dirBlk : int
(optional)
dsModel : String
(optional)
dsnType
(optional)
LIBRARY
, HFS
, PDS
, LARGE
, BASIC
, EXTREQ
, EXTPREF
lrecl : int
(optional)
mgntClass : String
(optional)
storClass : String
(optional)
unit : String
(optional)
volser : String
(optional)
$class: 'AmxEclipseAntBuilder'
targets : String
name : String
Jenkins supplies some environment variables that can be used from within the build script.
antOpts : String
buildFile : String
properties : String
# comment name1=value1 name2=$VAR2These are passed to amx_eclipse_ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as amx_eclipse_ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname= Please refer to TIBCO Documentation for any detail
amxEclipseAntTra : String
businessStudioWs : String
anchore
name : String
annotations
(optional)
key : String
value : String
autoSubscribeTagUpdates : boolean
(optional)
bailOnFail : boolean
(optional)
bailOnPluginFail : boolean
(optional)
engineCredentialsId : String
(optional)
engineRetries : String
(optional)
engineurl : String
(optional)
engineverify : boolean
(optional)
forceAnalyze : boolean
(optional)
policyBundleId : String
(optional)
$class: 'AnsibleAdHocCommandBuilder'
hostPattern : String
inventory
$class: 'InventoryContent'
content : String
dynamic : boolean
$class: 'InventoryDoNotSpecify'
$class: 'InventoryPath'
path : String
module : String
command : String
additionalParameters : String
(optional)
ansibleName : String
(optional)
becomeUser : String
(optional)
colorizedOutput : boolean
(optional)
credentialsId : String
(optional)
disableHostKeyChecking : boolean
(optional)
extraVars
(optional)
hidden : boolean
(optional)
key : String
(optional)
secretValue
(optional)
class hudson.util.Secret
forks : int
(optional)
hostKeyChecking : boolean
(optional)
sudo : boolean
(optional)
sudoUser : String
(optional)
unbufferedOutput : boolean
(optional)
vaultCredentialsId : String
(optional)
cfyAnsible
additionalArgs : String
(optional)
ansibleEnvVars : String
(optional)
credentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugLevel : int
(optional)
debugOutput : boolean
(optional)
deploymentId : String
(optional)
echoEnvData : boolean
(optional)
echoInputs : boolean
(optional)
envDataLocation : String
(optional)
optionsConfig : String
(optional)
playbookPath : String
(optional)
remergeSources : boolean
(optional)
runData : String
(optional)
savePlaybook : boolean
(optional)
scpExtraArgs : String
(optional)
sensitiveKeys : String
(optional)
sftpExtraArgs : String
(optional)
sourcePath : String
(optional)
sources : String
(optional)
sshCommonArgs : String
(optional)
sshExtraArgs : String
(optional)
startAtTask : String
(optional)
tenant : String
(optional)
timeout : int
(optional)
$class: 'AnsiblePlaybookBuilder'
playbook : String
inventory
$class: 'InventoryContent'
content : String
dynamic : boolean
$class: 'InventoryDoNotSpecify'
$class: 'InventoryPath'
path : String
additionalParameters : String
(optional)
ansibleName : String
(optional)
becomeUser : String
(optional)
colorizedOutput : boolean
(optional)
credentialsId : String
(optional)
disableHostKeyChecking : boolean
(optional)
extraVars
(optional)
hidden : boolean
(optional)
key : String
(optional)
secretValue
(optional)
class hudson.util.Secret
forks : int
(optional)
hostKeyChecking : boolean
(optional)
limit : String
(optional)
skippedTags : String
(optional)
startAtTask : String
(optional)
sudo : boolean
(optional)
sudoUser : String
(optional)
tags : String
(optional)
unbufferedOutput : boolean
(optional)
vaultCredentialsId : String
(optional)
$class: 'AnsibleTower'
towerServer : String
(optional)
jobTemplate : String
(optional)
towerCredentialsId : String
(optional)
jobType : String
(optional)
extraVars : String
(optional)
jobTags : String
(optional)
skipJobTags : String
(optional)
limit : String
(optional)
inventory : String
(optional)
credential : String
(optional)
scmBranch : String
(optional)
verbose : boolean
(optional)
importTowerLogs : boolean
(optional)
removeColor : boolean
(optional)
templateType : String
(optional)
importWorkflowChildLogs : boolean
(optional)
$class: 'AnsibleTowerProjectRevisionFreestyle'
towerServer : String
(optional)
towerCredentialsId : String
(optional)
project : String
(optional)
revision : String
(optional)
verbose : boolean
(optional)
throwExceptionWhenFail : boolean
(optional)
$class: 'AnsibleTowerProjectSyncFreestyle'
towerServer : String
(optional)
towerCredentialsId : String
(optional)
project : String
(optional)
verbose : boolean
(optional)
importTowerLogs : boolean
(optional)
removeColor : boolean
(optional)
$class: 'AnsibleVaultBuilder'
action : String
(optional)
ansibleName : String
(optional)
content : String
(optional)
input : String
(optional)
newVaultCredentialsId : String
(optional)
output : String
(optional)
vaultCredentialsId : String
(optional)
ant
Jenkins supplies some environment variables that can be used from within the build script.
targets : String
antName : String
antOpts : String
-Xmx512m
. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
buildFile : String
build.xml
in the root directory; this option can be used to use build files with a different name or in a subdirectory.
properties : String
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
$class: 'AntExec'
scriptSource : String
extendedScriptSource : String
scriptName : String
properties : String
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname=
antName : String
antOpts : String
keepBuildfile : boolean
verbose : boolean
emacs : boolean
noAntcontrib : boolean
Disabling usage of Ant-Contrib Tasks in this build step.
antws
Jenkins supplies some environment variables that can be used from within the build script.
targets : String
antName : String
antOpts : String
-Xmx512m
. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
buildFile : String
build.xml
in the root directory; this option can be used to use build files with a different name or in a subdirectory.
properties : String
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
$class: 'ApiFortressBuilder'
mode : String
hook : String
id : String
blocking : boolean
dryrun : boolean
silent : boolean
param1name : String
param1value : String
param2name : String
param2value : String
param3name : String
param3value : String
appray
appRayUrl : String
outputFilePath : String
waitTimeout : int
riskScoreThreshold : int
credentialsId : String
appscan
scanner
dynamic_analyzer
target : String
hasOptions : boolean
extraField : String
(optional)
loginPassword : String
(optional)
loginType : String
(optional)
loginUser : String
(optional)
optimization : String
(optional)
presenceId : String
(optional)
scanFile : String
(optional)
scanType : String
(optional)
trafficFile : String
(optional)
static_analyzer
target : String
hasOptions : boolean
openSourceOnly : boolean
(optional)
scanMethod : String
(optional)
scanSpeed : String
(optional)
sourceCodeOnly : boolean
(optional)
name : String
type : String
application : String
credentials : String
email : boolean
(optional)
failBuild : boolean
(optional)
failBuildNonCompliance : boolean
(optional)
failureConditions
(optional)
failureType : String
threshold : int
intervention : boolean
(optional)
target : String
(optional)
wait : boolean
(optional)
appscanenterprise
credentials : String
folder : String
testPolicy : String
template : String
jobName : String
accessId : String
(optional)
agent : String
(optional)
application : String
(optional)
email : boolean
(optional)
exploreData : String
(optional)
failBuild : boolean
(optional)
failureConditions
(optional)
failureType : String
threshold : int
loginType : String
(optional)
scanType : String
(optional)
secretKey : String
(optional)
target : String
(optional)
testOptimization : String
(optional)
trafficFile : String
(optional)
wait : boolean
(optional)
$class: 'AppScanSourceBuilder'
disableScan : boolean
applicationFile : String
acceptSSL : boolean
customScanWorkspace : String
This value will be passed to AppScan Source as the scan workspace. AppScan Source assessment and working files will be stored in this directory.
If this field is blank, the default scan directory will be used.
The default directory is this job's build folder, as defined by Jenkins.
installation : String
(optional)
$class: 'AppScanStandardBuilder'
startingURL : String
Spiders will find the remaining URLs in the domain to be included for scanning.
installation : String
additionalCommands : String
(optional)
AppScanCMD exec|ex|e Parameters: [ /dest_scan|/dest|/d ] [ /base_scan|/base|/b ] [ /old_host|/ohost|/oh ] [ /new_host|/nhost|/nh ] [ /scan_template|/stemplate|/st ] [ /login_file|/lfile|/lf ] [ /multi_step_file|/mstepfile|/mf ] [ /manual_explore_file|/mexplorefile|/mef ] [ /policy_file|/pfile|/pf ] [ /additional_domains|/adomains|/ad ] [ /report_file|/rf ] [ /report_type|/rt {xml} ] [ /min_severity|/msev {informational} ] [ /test_type|/tt ] [ /report_template|/rtemplate|/rtm {CliDefault} ] Flags: [ /verbose|/v {false} ] [ /scan_log|/sl {false} ] [ /explore_only|/eo {false} ] [ /test_only|/to {false} ] [ /multi_step|/mstep|/ms {false} ] [ /continue|/c {false} ] [ /merge_manual_explore_requests|/mmer {false} ] [ /include_responses|/ir {false} ] [ /open_proxy|/oprxy|/opr /listening_port|/lport|/lp ] Creates new scan with base_scan's configuration saving dest_scan and creating report, if configured. AppScanCMD report|rep|r Parametrs: /base_scan|/base|/b /report_file|/rf /report_type|/rt [ /min_severity|/msev {informational} ] [ /test_type|/tt ] [ /report_template|/rtemplate|/rtm {CliDefault} ] Flags: [ /verbose|/v {false} ] Creates a report for base_scan. AppScanCMD close_proxy|cprxy|cpr Closes AppScan proxy if was previously opened. More info. at: (9.0.3.2 User Guide) CLI - Chapter 15 - CLI - Page 315 http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
authScan : boolean
(optional)
If the website contains private information accessed only by logging in this option should be checked and credentials provided to increase dynamic security coverage.
authScanPw : String
(optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
authScanRadio : boolean
(optional)
A login sequence may be recorded using AppScan Standard's GUI by following these steps:
"Scan" > "Scan Configuration" > "Login Management" > "Record" > [ record your login...] > "I am logged in to the site" > "Details" (Tab) > "Export" (small icon on the right side).
Check "Form Based Authentication" if you do not have a recorded login sequence, this option will require an user name and password combination and is not guaranteed to work for all scenarios.
authScanUser : String
(optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
generateReport : boolean
(optional)
The report is available in HTML and PDF.
The HTML report generated is ready to be integrated with the HTML Publisher Plugin.
htmlReport : boolean
(optional)
includeURLS : String
(optional)
Some URLs might not be found by AppScan Standard's spiders, include them to get the best possible coverage.
pathRecordedLoginSequence : String
(optional)
pdfReport : boolean
(optional)
policyFile : String
(optional)
A Test Policy File can be created following these steps:
"Scan" > "Scan Configuration" > "Test Policy" > "Export".
reportName : String
(optional)
To configure HTML Publisher Plugin properly, the names in the configuration must match.
verbose : boolean
(optional)
xooa
name : String
appId : String
AppdomeBuilder
token
class hudson.util.Secret
teamId : String
platform
AndroidPlatform
certificateMethod
Android_AutoDevSign
fingerprint : String
googleSigning : boolean
(optional)
Android_AutoSign
keystorePath : String
keystorePassword
class hudson.util.Secret
keystoreAlias
class hudson.util.Secret
keyPass
class hudson.util.Secret
googleSignFingerPrint
(optional)
googleSignFingerPrint : String
(optional)
googleSign
(optional)
googleSignFingerPrint : String
(optional)
Android_PrivateSign
fingerprint : String
googleSigning : boolean
(optional)
appPath : String
(optional)
fusionSetId : String
(optional)
IosPlatform
certificateMethod
iOS_AutoDevSign
provisioningProfiles
item : String
entitlements
item : String
iOS_AutoSign
keystorePath : String
keystorePassword
class hudson.util.Secret
entitlements
item : String
provisioningProfiles
(optional)
item : String
iOS_PrivateSign
provisioningProfiles
item : String
appPath : String
(optional)
fusionSetId : String
(optional)
secondOutput
(optional)
item : String
buildToTest
(optional)
selectedVendor : String
(optional)
buildWithLogs : boolean
(optional)
outputLocation : String
(optional)
AppdomeValidator
token
class hudson.util.Secret
appPath : String
outputLocation : String
(optional)
applatix
axUrl : String
axUsername : String
axPassword : String
axServiceTemplateName : String
axServiceTemplateRepository : String
axServiceTemplateBranch : String
axServiceTemplateParameters
key : String
value : String
snApplyChanges
credentialsId : String
(optional)
apiVersion : String
(optional)
appScope : String
(optional)
application system ID
is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
appSysId : String
(optional)
application scope
is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
branchName : String
(optional)
url : String
(optional)
$class: 'ApprendaBuilder'
appAlias : String
appName : String
versionAlias : String
stage : String
artifactName : String
credentialsId : String
prefix : String
advVersionAliasToBeForced : String
advancedNewVersionOption : String
customPackageDirectory : String
applicationPackageURL : String
archiveUploadMethod : String
buildWithParameters : boolean
aqua
locationType : String
registry : String
register : boolean
localImage : String
hostedImage : String
onDisallowed : String
notCompliesCmd : String
hideBase : boolean
showNegligible : boolean
policies : String
customFlags : String
localToken : String
(optional)
tarFilePath : String
(optional)
containerRuntime : String
(optional)
scannerPath : String
(optional)
aquaMicroscanner
imageName : String
onDisallowed : String
notCompliesCmd : String
outputFormat : String
aquaServerlessScanner
onDisallowed : String
notCompliesCmd : String
codeScanPath : String
customFlags : String
arachniScanner
url : String
checks : String
scope
pageLimit : int
excludePathPattern : String
userConfig
filename : String
format : String
aribot
credentialsID : String
(optional)
name : String
(optional)
$class: 'ArtifactDeployerBuilder'
includes : String
Can use wildcards like 'module/dist/**/*.zip'. See the @includes of Ant fileset for the exact format.
Artifacts are deployed from the workspace. You can change this basedir by specifying the basedir field under Advanced.
basedir : String
By default, the basedir is the job workspace.
Give a value to override the default value.
Path relative to workspace is permitted.
excludes : String
Optionally specify the 'excludes' pattern, such as "foo/bar/**/*". A file that matches this mask will not be deployed even if it matches the mask specified.
remote : String
Artifacts will be deployed in the specified output directory.
The remote location must be accessible through the build machine (controller and agent node).
If you want to have the ability to download deployed artifacts through the Jenkins dashboard, the location must be accessible from the Jenkins controller.
Make sure the Jenkins process have the right permissions to write to the remote location.
For example with a shared NFS storage, '/nfs/build/deploy/${BUILD_ID}' can be a valid value on a Unix machine.
flatten : boolean
Ignore the directory structure of the source files, and deploy all the artifacts into the output directory.
deleteRemote : boolean
Delete the output directory before deploying artifacts.
deleteRemoteArtifacts : boolean
failNoFilesDeploy : boolean
$class: 'ArtifactPromotionBuilder'
groupId : String
artifactId : String
classifier : String
version : String
extension : String
stagingRepository : String
stagingUser : String
stagingPW : String
releaseUser : String
releasePW : String
releaseRepository : String
promoterClass : String
debug : boolean
skipDeletion : boolean
'Skip deletion' option preserves the files in the staging repository.
Untick 'Skip deletion' only after you've promoted all the relevant files in previous steps.
reportArtifactRelease
applicationName : String
(optional)
applicationVersion : String
(optional)
applicationComponent : String
(optional)
artifactName : String
(optional)
artifactURL : String
(optional)
repositoryName : String
(optional)
tags : String
(optional)
artifactResolver
artifacts
groupId : String
artifactId : String
version : String
classifier : String
(optional)
deployToLocal : boolean
(optional)
deployToRemote : boolean
(optional)
extension : String
(optional)
failOnError : boolean
(optional)
pomFile : String
(optional)
targetFileName : String
(optional)
enableRepositoryLogging : boolean
(optional)
enableTransferLogging : boolean
(optional)
repositoryId : String
(optional)
targetDirectory : String
(optional)
artifactVersion
name : String
(optional)
description : String
(optional)
type : String
(optional)
groupId : String
(optional)
artifactId : String
(optional)
stage : String
(optional)
flow : String
(optional)
stageDescription : String
(optional)
version : String
(optional)
artifactVersion
variableName : String
name : String
(optional)
stage : String
(optional)
version : String
(optional)
assertthatBddFeatures
projectId : String
credentialsId : String
outputFolder : String
jql : String
tags : String
mode : String
proxyURI : String
proxyUsername : String
proxyPassword : String
jiraServerUrl : String
numbered : boolean
ignoreCertErrors : boolean
$class: 'AssociateItemToRelease'
releasePrefix : String
itemPrefix : String
$class: 'AstreeBuilder'
dax_file : String
analysis_id : String
output_dir : String
skip_analysis : boolean
genXMLOverview : boolean
genXMLCoverage : boolean
genXMLAlarmsByOccurence : boolean
genXMLAlarmsByCategory : boolean
genXMLAlarmsByFile : boolean
genXMLRulechecks : boolean
dropAnalysis : boolean
genPreprocessOutput : boolean
failonswitch
failon : String
audit
credentialsId : String
(optional)
minScore : int
(optional)
platformUrl : String
(optional)
apiTags : String
(optional)
branchName : String
(optional)
defaultCollectionName : String
(optional)
ignoreFailures : boolean
(optional)
ignoreNetworkErrors : boolean
(optional)
jsonReport : String
(optional)
logLevel : String
(optional)
prId : String
(optional)
prTargetBranch : String
(optional)
repositoryName : String
(optional)
rootDirectory : String
(optional)
shareEveryone : String
(optional)
skipLocalChecks : boolean
(optional)
tagName : String
(optional)
$class: 'AutEnvironmentBuilder'
autEnvironmentModel
almServerName : String
almUserName : String
almPassword : String
almDomain : String
almProject : String
clientType : String
autEnvironmentId : String
useExistingAutEnvConf : boolean
existingAutEnvConfId : String
createNewAutEnvConf : boolean
newAutEnvConfName : String
autEnvironmentParameters
name : String
value : String
paramType : String
shouldGetOnlyFirstValueFromJson : boolean
pathToJsonFile : String
outputParameter : String
autifyMobile
credentialsId : String
autifyUrl : String
https://mobile-app.autify.com/projects/<ID>/test_plans/<ID>
autifyPath : String
(optional)
buildId : String
(optional)
buildPath : String
(optional)
shellInstallerUrl : String
(optional)
timeout : String
(optional)
wait : boolean
(optional)
autifyMobileUpload
credentialsId : String
workspaceId : String
buildPath : String
autifyPath : String
(optional)
shellInstallerUrl : String
(optional)
autifyWeb
credentialsId : String
autifyUrl : String
https://app.autify.com/projects/<ID>/(scenarios|test_plans)/<ID>
autifyConnect : String
(optional)
autifyConnectClient : boolean
(optional)
autifyConnectClientExtraArguments : String
(optional)
autifyPath : String
(optional)
browser : String
(optional)
device : String
(optional)
deviceType : String
(optional)
os : String
(optional)
osVersion : String
(optional)
shellInstallerUrl : String
(optional)
testExecutionName : String
(optional)
timeout : String
(optional)
urlReplacements
(optional)
patternUrl : String
replacementUrl : String
wait : boolean
(optional)
$class: 'Autogen'
element : String
Specify the name of the element in your Endevor® sandbox that you want to include in the autogeneration process, for example, RUNCOB01. The maximum length is 8 characters.
You can specify several specific comma-separated elements within the sandbox, for example, RUNCOB01, RUNCOB02.
You can use wildcards % and * to define the name patterns for the element names.
Examples:
Specify * to include all elements from the sandbox in the autonegeration process.
Specify RUNCOB* to include all element names that start with "RUNCOB".
Specify %%%COB* to include elements that contain the substring COB starting after position three.
environment : String
Provide the environment for the Endevor® sandbox that you want to include in the autogeneration process, for example, DEV.
system : String
Provide the system name for the environment in your Endevor® sandbox that you want to include in the autogeneration process, for example, APCTTC0.
subsystem : String
Provide the subsystem name for the environment in your Endevor® sandbox that you want to include in the autogeneration process, for example, TESTCICD.
stage : String
Specify the environment stage in your Endevor® that you want to include in the autogeneration process, for example, 1.
instance : String
Specify the instance name of the environment that is associated with Endevor® Web services, for example, WEBSMFNE.
signout : boolean
Select this option to work with elements in Endevor® that might be currently worked on by another user.
Select the Override signout option only if you have the permission to override the signout of another user.
$class: 'AwsBatchBuilder'
jobname : String
jobdefinition : String
command : String
jobqueue : String
vcpu : String
memory : String
retries : String
azureCLI
principalCredentialId : String
commands
script : String
exportVariablesString : String
azureDownload
storageCredentialId : String
downloadType : String
buildSelector
(optional)
downstream
upstreamProjectName : String
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
upstreamBuildNumber : String
lastWithArtifacts
lastCompleted
$class: 'MultiJobBuildSelector'
buildParameter
parameterName : String
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
permalink
id : String
$class: 'PromotedBuildSelector'
level : int
latestSavedBuild
specific
buildNumber : String
lastSuccessful
stable : boolean
(optional)
upstream
allowUpstreamDependencies : boolean
(optional)
fallbackToLastSuccessful : boolean
(optional)
upstreamFilterStrategy
(optional)
UseGlobalSetting
, UseOldest
, UseNewest
workspace
containerName : String
(optional)
deleteFromAzureAfterDownload : boolean
(optional)
downloadDirLoc : String
(optional)
excludeFilesPattern : String
(optional)
fileShare : String
(optional)
flattenDirectories : boolean
(optional)
includeArchiveZips : boolean
(optional)
includeFilesPattern : String
(optional)
projectName : String
(optional)
verbose : boolean
(optional)
Enabling this will provide more logging on downloading files.
$class: 'BDSBuilder'
projectFile : String
switches : String
installationName : String
$class: 'BapFtpBuilder'
publishers
configName : String
Select an FTP configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the FTP server.
verbose : boolean
transfers
sourceFiles : String
Files to upload to a server.
The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
The base directory for this fileset is the workspace.
excludes : String
Exclude files from the Transfer set.
The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)
remoteDirectory : String
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder will be created if does not exist.
removePrefix : String
First part of the file path that should not be created on the remote server.
Directory structures are created relative to the base directory, which is usually the workspace.
You normally do not want the full path to these files to be created on the server.
For example if Source files were target/deployment/images/**/
then you may want Remove prefix to be target/deployment
This would create the images folder under the remote directory, and not target/deployment
Jenkins environment variables can be used in this path.
If you use remove prefix, then ALL source file paths MUST start with the prefix.
asciiMode : boolean
Select to enable ASCII mode for the transfer, otherwise binary transfer mode will be used.
Use with ASCII text files to fix the line terminators when transferring between different operating systems.
remoteDirectorySDF : boolean
Select this to include the timestamp in the remote directory.
The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
This setting turns the remote directory option into a java SimpleDateFormat.
The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.
Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.
Remote directory | Directories created |
---|---|
'qa-approved/'yyyyMMddHHmmss |
qa-approved/20101107154555 |
'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}' |
builds/2010/11/07/build-456 (if the build was number 456) |
yyyy_MM/'build'-EEE-d-HHmmss |
2010_11/build-Sun-7-154555 |
yyyy-MM-dd_HH-mm-ss |
2010-11-07_15-45-55 |
flatten : boolean
Only create files on the server, don't create directories (except for the remote directory, if present).
All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.
cleanRemote : boolean
Select to delete all files and directories within the remote directory before transferring files.
noDefaultExcludes : boolean
makeEmptyDirs : boolean
The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
Selecting this option will create any directories that match the Source files pattern, even if empty.
patternSeparator : String
The regular expression that is used to separate the Source files and Exclude files patterns.
The Source files and Exclude files both accept multiple patterns that by default are split using
[, ]+which is how Ant, by default, handles multiple patterns in a single string.
The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.
useWorkspaceInPromotion : boolean
Set the root directory for the Source files to the workspace.
By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.
If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.
If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory
usePromotionTimestamp : boolean
Use the build time of the promotion when the remote directory is a date format.
By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.
ftpRetry
If publishing to this server fails, try again.
Files that were successfully transferred will not be re-sent.
If the Clean remote option is selected, and succeeds, it will not be attempted again.
retries : int
retryDelay : long
ftpLabel
Set the label for this Server instance - for use with Parameterized publishing.
Expand the help for Parameterized publishing for more details.
label : String
Set the label for this Server instance - for use with Parameterized publishing.
Expand the help for Parameterized publishing for more details.
ftpCredentials
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set the username and password to use.
username : String
password : String
continueOnError : boolean
failOnError : boolean
alwaysPublishFromMaster : boolean
masterNodeName : String
paramPublish
parameterName : String
$class: 'BapSshBuilderPlugin'
publishers
configName : String
Select an SSH configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the SSH server.
verbose : boolean
transfers
sourceFiles : String
Files to upload to a server.
The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
The base directory for this fileset is the workspace.
excludes : String
Exclude files from the Transfer set.
The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)
remoteDirectory : String
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder will be created if does not exist.
removePrefix : String
First part of the file path that should not be created on the remote server.
Directory structures are created relative to the base directory, which is usually the workspace.
You normally do not want the full path to these files to be created on the server.
For example if Source files were target/deployment/images/**/
then you may want Remove prefix to be target/deployment
This would create the images folder under the remote directory, and not target/deployment
Jenkins environment variables can be used in this path.
If you use remove prefix, then ALL source file paths MUST start with the prefix.
remoteDirectorySDF : boolean
Select this to include the timestamp in the remote directory.
The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
This setting turns the remote directory option into a java SimpleDateFormat.
The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.
Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.
Remote directory | Directories created |
---|---|
'qa-approved/'yyyyMMddHHmmss |
qa-approved/20101107154555 |
'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}' |
builds/2010/11/07/build-456 (if the build was number 456) |
yyyy_MM/'build'-EEE-d-HHmmss |
2010_11/build-Sun-7-154555 |
yyyy-MM-dd_HH-mm-ss |
2010-11-07_15-45-55 |
flatten : boolean
Only create files on the server, don't create directories (except for the remote directory, if present).
All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.
cleanRemote : boolean
noDefaultExcludes : boolean
makeEmptyDirs : boolean
The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
Selecting this option will create any directories that match the Source files pattern, even if empty.
patternSeparator : String
The regular expression that is used to separate the Source files and Exclude files patterns.
The Source files and Exclude files both accept multiple patterns that by default are split using
[, ]+which is how Ant, by default, handles multiple patterns in a single string.
The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.
execCommand : String
(optional)
A command to execute on the remote server.
This command will be executed on the remote server after any files are transferred.
The SSH Transfer Set must include either a Source Files pattern, an Exec command, or both. If both are present, the files are transferred before the command is executed. If you want to Exec before the files are transferred, use 2 Transfer Sets and move the Exec command before the Transfer set that includes a Source files pattern.
execTimeout : int
(optional)
Timeout in milliseconds for the Exec command.
Set to zero to disable.
usePty : boolean
(optional)
Exec the command in a pseudo tty.
This will enable the execution of sudo commands that require a tty (and possibly help in other scenarios too.)
From the sudoers(5) man page:
requiretty If set, sudo will only run when the user is logged in to a real tty. When this flag is set, sudo can only be run from a login session and not via other means such as cron(8) or cgi-bin scripts. This flag is off by default.
keepFilePermissions : boolean
(optional)
Keep local file permissions of transferred files.
Changes file permissions of the file after transferring to the local one.
NB: only POSIX file permissions support is implemented.
useAgentForwarding : boolean
(optional)
Exec the command using Agent Forwarding.
Allows a chain of ssh connections to forward key challenges back to the original agent, thus eliminating the need for using a password or public/private keys for these connections.
From the ssh(1) man page:
Enables forwarding of the authentication agent connection. This can also be specified on a per-host basis in a configuration file. Agent forwarding should be enabled with caution. Users with the ability to bypass file permissions on the remote host (for the agent's UNIX-domain socket) can access the local agent through the forwarded connection. An attacker cannot obtain key material from the agent, however they can perform operations on the keys that enable them to authenticate using the identities loaded into the agent.
useSftpForExec : boolean
(optional)
Using SFTP protocol instead of SSH for Exec command.
Supported commands: mkdir, ln, symlink, rm, rmdir, cd, get, ls
useWorkspaceInPromotion : boolean
Set the root directory for the Source files to the workspace.
By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.
If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.
If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory.
usePromotionTimestamp : boolean
Use the build time of the promotion when the remote directory is a date format.
By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.
sshRetry
If publishing to this server or command execution fails, try again.
Files that were successfully transferred will not be re-sent.
If Exec command is configured, but fails in any way (including a non zero exit code), then it will be retried.
retries : int
retryDelay : long
sshLabel
Set the label for this Server instance - for use with Parameterized publishing.
Expand the help for Parameterized publishing for more details.
label : String
Set the label for this Server instance - for use with Parameterized publishing.
Expand the help for Parameterized publishing for more details.
sshCredentials
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set them here.
username : String
encryptedPassphrase : String
Key
or Path to key
is configured.
key : String
The private key.
Paste the private key here, or provide the path to the file containing the key in Path to key
.
keyPath : String
The path to the private key.
Either supply the path to the file containing the key, or paste the key into the Key
box.
The Path to key
can be absolute, or relative to $JENKINS_HOME
continueOnError : boolean
failOnError : boolean
alwaysPublishFromMaster : boolean
masterNodeName : String
paramPublish
parameterName : String
batchFile
command : String
configuredLocalRules
(optional)
retainOnlyVariables
Limit which environment variables are passed to a build step.
Environment variables passed to the build step are filtered, unless listed below.
The behavior of this filter depends on whether the environment variable is originally defined outside Jenkins:
JOB_URL
, it will not be passed to the build step unless specified here.PATH
, the behavior depends on the option Process environment variables handling : If that option is set to Retain , the original value will be passed to the build step, discarding any modifications inside Jenkins. If that option is set to Remove , the variable will not be passed to the build step.The following table shows the effect of filtering on an environment variable:
Behavior | Originally defined outside Jenkins | Originally defined inside Jenkins |
---|---|---|
Process environment variables handling: reset | Variable is reset to original value | Variable is removed |
Process environment variables handling: removed | Variable is removed | Variable is removed |
processVariablesHandling
(optional)
RESET
, REMOVE
retainCharacteristicEnvVars : boolean
(optional)
When checked, characteristic environment variables will be retained in addition to the variables listed above. These environment variables are job- and build-specific, defined by Jenkins, and are used to identify and kill processes started by this build step. See the documentation for more details on starting processes.
variables : String
(optional)
Whitespace separated, case insensitive list of environment variables that will be retained, i.e. not removed from the environment of this build step or reset to their default.
unstableReturn : int
(optional)
snBatchInstall
credentialsId : String
(optional)
apiVersion : String
(optional)
batchName : String
(optional)
file : String
(optional)
The field is required if Use file is checked. If the field is not changed default value will be used: now_batch_manifest.json
.
notes : String
(optional)
Default: null
packages : String
(optional)
[{
"id": "String",
"load_demo_data": Boolean,
"notes": "String",
"requested_customized_version": "String",
"requested_version": "String",
"type": "String"
}]
id | Required. Sys_id of the application or identifier of the plugin to install. |
---|---|
load_demo_data | Flag that indicates whether demo data is loaded when installing the package. Valid values: true : Demo data should be loaded. false : Demo data should not be loaded. Default: false |
notes | User specified notes about the package. Default: null |
requested_customized_version | Only applicable when packages.type is set to application. Version of the store application customization package to install, such as 1.0.2 or 2.3. |
requested_customized_version | Only applicable when packages.type is set to application. Version of the store application customization package to install, such as 1.0.2 or 2.3. Default: None. If this is not set, then the system does not look for customizations for the application. |
requested_version | Required if type is set to application; ignored if set to plugin. Version of the package to install, such as 1.0.2 or 2.3. |
type | Required. Type of package. Valid values:
|
url : String
(optional)
useFile : boolean
(optional)
Default: false
snBatchRollback
credentialsId : String
(optional)
apiVersion : String
(optional)
rollbackId : String
(optional)
sys_id
) of the rollback installed before.
url : String
(optional)
If ServiceNow Parameters are used, then the URL of installation instance will be used.
greet
apiKey
class hudson.util.Secret
appType : String
appPath : String
packageName : String
scanTimeout : String
severityThreshold : String
$class: 'BeaglePlugin'
apptoken
class hudson.util.Secret
accesstoken
class hudson.util.Secret
$class: 'BeakerBuilder'
jobSource
$class: 'FileJobSource'
jobPath : String
$class: 'StringJobSource'
jobContent : String
downloadFiles : boolean
$class: 'BeginAnalysis'
logLevel
OFF
, INFO
, DEBUG
, WARN
, ERROR
buildSessionId : String
appName : String
moduleName : String
branch : String
enableMultipleBuildFiles : boolean
overrideJars : boolean
multipleBuildFiles : boolean
labId : String
testStage : String
packagesIncluded : String
packagesExcluded : String
filesIncluded : String
filesExcluded : String
classLoadersExcluded : String
recursive : boolean
workspacepath : String
buildScannerJar : String
testListenerJar : String
testListenerConfigFile : String
autoRestoreBuildFile : boolean
sealightsMavenPluginInstallationArguments : String
buildFilesPatterns : String
buildFilesFolders : String
logEnabled : boolean
logDestination
CONSOLE
, FILE
logFolder : String
buildStrategy
ONE_BUILD
, BUILD_EACH_MODULE
slMvnPluginVersion : String
buildName
$class: 'DefaultBuildName'
$class: 'EmptyBuildName'
$class: 'LatestBuildName'
$class: 'ManualBuildName'
insertedBuildName : String
$class: 'UpstreamBuildName'
upstreamProjectName : String
executionType
FULL
, TESTS_ONLY
, ONLY_LISTENER
override_customerId : String
override_url : String
override_proxy : String
additionalArguments : String
Argument name | Description |
---|---|
token | The token provided to you by SeaLights (override the global 'token' value for this build). |
tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
buildsessionidfile | Set build session id file for this build. |
createbuildsessionid | When set to 'true' - forces SeaLights Maven Plugin to create new build session id (true by default). |
proxy | A valid URL to a proxy server. |
agentpath | Override the path to SeaLights jar. |
javapath | Override the path to the 'java' variable (default is 'java'). |
filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
sealightsJvmParams | Key value pairs of environments variables which will be added to both buildscanner and test listener ('$$$'- separated pairs, ':'- separated key and value. i.e: sealightsJvmParams=param:value$$$anotherparam:anothervalue) |
buildScannerParams | Key value pairs of environments variables which will be added to buildscanner ('$$$'- separated pairs, ':'- separated key and value. i.e: buildScannerParams=param:value$$$anotherparam:anothervalue) |
testListenerJvmParams | Key value pairs of environments variables which will be added to test listener ('$$$'- separated pairs, ':'- separated key and value i.e: testListenerJvmParams=param:value$$$anotherparam:anothervalue) |
includeResources : boolean
benchmark
filepath : String
$class: 'BitbucketPublisher'
serverUrl : String
(optional)
credentialsId : String
(optional)
projectKey : String
(optional)
createProject
(optional)
projectName : String
projectUsers : String
projectGroups : String
createJenkinsJobs
(optional)
ciServer : String
projectName : String
(optional)
$class: 'BladeBuilder'
blades
$class: 'CodeScan'
source : String
exclude : String
noCache : boolean
noProxy : boolean
noBlame : boolean
ruleset : String
severityLevel : String
severityThreshold : int
autoUpdate : boolean
(optional)
credentialsId : String
(optional)
debug : boolean
(optional)
directory : String
(optional)
environment : String
(optional)
forceVersion : String
(optional)
ignoreFailure : boolean
(optional)
onFailureCmd : String
(optional)
timeout : int
(optional)
$class: 'ImageScan'
image : String
exclude : String
noCache : boolean
noProxy : boolean
noBlame : boolean
ruleset : String
severityLevel : String
severityThreshold : int
autoUpdate : boolean
(optional)
credentialsId : String
(optional)
debug : boolean
(optional)
directory : String
(optional)
environment : String
(optional)
forceVersion : String
(optional)
ignoreFailure : boolean
(optional)
onFailureCmd : String
(optional)
timeout : int
(optional)
$class: 'BlueprintLaunch'
projectName : String
Project selection is mandatory.
blueprintName : String
Blueprint selection is mandatory.
applicationName : String
Application Name is mandatory.
This is the Application name used for blueprint launch in Nutanix Calm. Appending the _${BUILD_ID} to the Application name is recommended for unique application names. Other Jenkins Environment Variables may also be used.
appProfileName : String
Application Profile selection is mandatory.
actionName : String
The field is mandatory
Select the required action need to run after the application launch from the list of actions, else please select none.
runtimeVariables : String
Click on Fetch Runtime Variables to fetch all editable variables for the selected Application Profile in JSON format. Modify the key values from the defaults as needed.The values can also reference jenkins environment variables.
waitForSuccessFulLaunch : boolean
blueprintDescription : String
Description is fetched from the selected Calm blueprint
BMC DevOps for CFA Plugin
server : String
port : String
user : String
jclContent : String
chkfreq : String
jobCard : String
acctno : String
thresh : String
sortby : String
pswd : String
prilog : String
cfaLoadLibs
lib : String
cfaSldsLibs
sldsname : String
sldsver : String
sldsunit : String
sldsvolser : String
cfaDliLibs
dliname : String
dliver : String
dliunit : String
dlivolser : String
cfaJobnames
jobname : String
cfaReconSets
recon1 : String
recon2 : String
recon3 : String
goodRC : String
bmcSlds : boolean
You can use the SLDS keyword on the ANALYZE control statement to identify explicitly an input log data set to use as input to the analysis process. SLDS=(dataSetName,Rvr, unit,volser) If you want CFA to read multiple log data sets, specify multiple instances of the SLDS keyword.
Example: IMSA is an IMS version 14.1 system and creates generations of SLDSs that use the naming convention imsid.SLDS.Ddate.GENnnn. The SLDSs are cataloged. To analyze log records that IMSA wrote to generations 10 through 12 on March 29, 2015, specify the following keywords on the ANALYZE control statement:
SLDS=(IMSA.SLDS.D2008088.GEN010, R141)
SLDS=(IMSA.SLDS.D2008088.GEN011, R141)
SLDS=(IMSA.SLDS.D2008088.GEN012, R141)
bmcDb2log : boolean
You can use the DB2LOG keyword on the ANALYZE control statement to identify a DB2 log data set that was created by a DB2 subsystem.
Note: If you specify the DB2LOG keyword, do not specify the DB2BSDS keyword.
db2log : String
db2bsds : String
limit : String
skip : String
maxlogs : String
If you specify a value from 1 through 999, Log Analyzer stops reading log data sets after it reaches the specified number of log data sets. If Log Analyzer does not read other log data sets because the specified limit was reached, a warning message indicates the number of log data sets that were not read.
If you want Log Analyzer to read all log data sets, specify MAXLOGS=999.
The default is MAXLOGS=100 (Log Analyzer reads a maximum of 100 log data sets).
bmcDb2bsds : boolean
You can use the DB2BSDS keyword on the ANALYZE control statement to identify a DB2 bootstrap data set (BSDS).
Specify the fully qualified data set name. This name should refer to a VSAM key-sequenced data set (KSDS).
Do not specify the name of a BSDS archive copy, which is not a VSAM KSDS. BSDS cannot be a TAPE dataset.
Note:
bmcLimit : boolean
You can use the LIMIT keyword (or the LIM abbreviation) on the ANALYZE control statement to set a limit on the number (1 through 9999999999) of log records to process from an input log data set.
Note:
bmcSkip : boolean
You can use the SKIP keyword on the ANALYZE control statement to specify a number (1 through 9999999999) of log records in an input log data set to skip before CFA begins to process records.
The default is SKIP=0, which skips no records.
Note:
If you specify the SKIP keyword, you must specify one SLDS keyword. The SLDS keyword is required, and multiple SLDS keywords are not allowed.
bmcActiveOlds : boolean
bmcImsid : boolean
You can use the IMSID keyword on the ANALYZE control statement to specify one or more IMSIDs.
If you do not check this option,then the the default IMSID=ALL will be taken and all log records for all IMS systems that are associated with the input RECON data set (or data sets) will be considered.
Note:
If you specify the SLDS keyword, you cannot specify the IMSID keyword. The IMSID keyword applies only if CFA is reading RECON data sets to determine which log data sets to process.
bmcDlilog : boolean
You can use the DLILOG keyword on the ANALYZE control statement to identify explicitly an input dli log data set to use as input to the analysis process.
Specify the keyword values as follows:
DLILOG=(dataSetName,Rnn)
DLILOG=(dataSetName,Rvr,unit,volser)
Notes:
bmcMaxlogs : boolean
Use this keyword when you are using implicit specification of log data sets and Log Analyzer is reading RECON data sets to determine which log data sets to process. In this case, the number of log data sets to be processed is unknown. The MAXLOGS keyword can help you prevent a problem that could result from processing an excessive number of log data sets.
The MAXLOGS keyword works differently, depending on how you specify the value:
bmcJobname : boolean
You can use the JOBNAME keyword on the ANALYZE control statement to specify one or more JOBNAMEs. Each JOBNAME (one to eight characters) identifies a Job name. Log Analyzer uses the JOBNAME when determining which dli log data sets to use as input.
To process log records for all Job names that are associated with the input RECON data set (or data sets), specify JOBNAME=ALL.
If you omit the JOBNAME sub-keyword, Log Analyzer uses the default value ALL.
Note:
cfaImsids
imsid : String
bmcRecon : boolean
You can use the RECON keyword on the ANALYZE control statement to specify the names of a set of RECON data sets to examine during the CFA job.
If you want CFA to examine multiple sets of RECON data sets, you must specify each set with a separate RECON keyword.
If you specify the RECON keyword, your user ID must have Security Access Facility (SAF) READ access to the RECON data sets.
You can specify from one to three data set names. One of the specified data set names must be designated as COPY1 by IMS.
Example:
The RECON data sets for the IMSA system are named IMSA.RECON1 and IMSA.RECON2, and the RECON data sets for the IMSB system are named IMSB.RECON1 and IMSB.RECON2. To examine IMSA and IMSB RECON data sets in the CFA job, specify the following keywords on the ANALYZE control statement:
RECON=(IMSA.RECON1, IMSA.RECON2)
RECON=(IMSB.RECON1, IMSB.RECON2)
Note:
If you specify the RECON keyword, you must specify the INTERVAL control statement with a START time value and a STOP time value.
bmcTimezone : boolean
bmcStartInterval : boolean
You can use the START keyword on the INTERVAL control statement for the following purposes:
bmcStopInterval : boolean
You can use the STOP keyword on the INTERVAL control statement for the following purposes:
� Specify the end of a range of log records to identify as candidates for the record selection process
� Control the end of range of log data sets to allocate from RECON information
� Reduce the overall number of log records that are selected from input SLDS or extract files
start
value : String
startDate : String
startlogSeq : String
stop
value : String
stopDate : String
stoplogSeq : String
tz
value : String
timezoneoffset : String
jobInclude : String
jobExclude : String
psbInclude : String
psbExclude : String
maxlogsRc : String
If you specify a value from 1 through 999 followed by literal R and a return code (08 through 99), Log Analyzer issues the specified return code and terminates the job step if more than the specified number of log data sets would be read. Log Analyzer issues the return code at the conclusion of the RECON analysis phase without reading any input log data sets.
Example:
If you want Log Analyzer to issue return code 16 and terminate the job step if more than 10 log data sets would be read, specify the following keyword on the ANALYZE control statement:
MAXLOGS=(10,R16)
maxlogsAbend : String
If you specify a value from 1 through 999 followed by an abend code (1 through 4095), Log Analyzer issues a user abend code and terminates the job step if more than the specified number of log data sets would be read. Log Analyzer issues the user abend at the conclusion of the RECON analysis phase without reading any input log data sets.
Example:
If you want Log Analyzer to issue a user abend, with abend code U4000, if more than 120 log data sets would be read, specify the following keyword on the ANALYZE control statement:
MAXLOGS=(120,4000)
bmcJobInc : boolean
bmcJobExc : boolean
bmcPsbInc : boolean
bmcPsbExc : boolean
bmcChkfreq : boolean
bmcThresh : boolean
bmcPrilog : boolean
You can use the PRILOG keyword on the ANALYZE control statement to specify the logs type associated with the input RECON data set (or data sets) to use as input to the analysis process.
You can select one of the following values:
bmcAppcheck : boolean
bmcAll : boolean
bmcLsec : boolean
chkfreqval : String
bmcPlanInc : boolean
planInclude : String
bmcPlanExc : boolean
planExclude : String
bmcSortby : boolean
bmcCsv : boolean
bmcFullreport : boolean
BMC DevOps for BMC AMI Change Manager for IMS TM Plugin
server : String
port : String
user : String
pswd : String
jclContent : String
jclType : String
dlist : String
jobCard : String
acctno : String
dPds : String
dOptionsPds : String
Specify the name of the data set where the BMC AMI Change Manager for IMS TM Global Options load module (DLP$GBL0) should be stored or retrieved.
It is recommended that you use the same data set that contains the IMSID options modules (DLP#iiii), and Group options modules (DLPZgggg).
This data set should have been created during BMC AMI Change Manager for IMS TM installation. JCL to allocate this data set is included in the BMC AMI Change Manager for IMS TM control library.
target : String
mode : String
Note: You must select this option for a DELTA List that is defined as Dependent to execute in the fashion Dependent implies.
Option 'One element at a time', instructs BMC AMI Change Manager for IMS TM to execute the DELTA List sequentially, one element at a time. This mode is much slower than Optimize execution mode. However, there are certain occasions when one element at a time is desirable. For example, transactions T1, T2 and T3 all require the MAXRGN parameter be changed from 3 to 4. Since they must be stopped before they can be revised, you want them stopped for the shortest amount of time possible. With Optimized mode, ALL the /STOP commands are done BEFORE the DELTA revise is done, and ALL the /START commands are done AFTER the revise is done. Using 'One element at a time' mode, the /STOP is done for T1, T1 is revised, then the /START command for T1 is issued before any activity takes place for T2 or T3.
This mode contains suboption Pause after elements with errors which instructs BMC AMI Change Manager for IMS TM to stop the DELTA List execution when an error is encountered. For additional information on the Pause option, place the cursor on the phrase highlighted above, and press HELP (F1).
ims_cmd : String
It will process an EXECUTE input record to insert an IMS Command Element into the Delta List PDS Member.
The EXECUTE input record format is as follows: EXECUTE /CMD Command_Parameters
e.g.: EXECUTE /STO PROG PGMD
title : String
notes : String
dlistRecords
action : String
elementType : String
elementName : String
ims_cmd : String
appnewname : String
appres : String
dbnewname : String
dbres : String
acc : String
auto : String
rand : String
randonly : String
rldareas : String
iovfext : String
dbrelgsam : String
dbcopyacb : String
apprelgsam : String
appcopyacb : String
ty : String
schd : String
appfp : String
dyn : String
gpsb : String
lang : String
apptls : String
rtcnewname : String
rtcinq : String
rtcpsbname : String
psb : String
trannewname : String
wfi : String
npri : String
lpri : String
lco : String
mseg : String
resp : String
cl : String
plc : String
time : String
para : String
uschd : String
traninq : String
recv : String
tranfp : String
emhs : String
mper : String
uc : String
edit : String
lsid : String
rsid : String
spa : String
spad : String
segs : String
oseg : String
msc : String
dc : String
mreg : String
ser : String
aoi : String
trantls : String
exptm : String
terminalmask : String
terminalnewname : String
sign : String
ltermmask : String
ltermnewname : String
ass : String
msn : String
l61 : String
subpoolmask : String
subpoolnewname : String
msg : String
bmcAppNew : boolean
bmcAppRes : boolean
bmcDbNewname : boolean
bmcDbRes : boolean
bmcAcc : boolean
bmcAuto : boolean
bmcRand : boolean
bmcRandOnly : boolean
bmcRldAreas : boolean
bmcIoVfExt : boolean
bmcDbCopyAcb : boolean
bmcDbRelGsam : boolean
bmcAppCopyAcb : boolean
bmcAppRelGsam : boolean
bmcTy : boolean
bmcSchd : boolean
bmcAppFp : boolean
bmcDyn : boolean
bmcGpsb : boolean
bmcLang : boolean
bmcApptls : boolean
bmcRtcsPsbName : boolean
bmcRtcInq : boolean
bmcRtcsNew : boolean
bmcPsb : boolean
bmcTranNewName : boolean
bmcWfi : boolean
bmcNpri : boolean
bmcLpri : boolean
bmcLco : boolean
bmcMseg : boolean
bmcResp : boolean
bmcCl : boolean
bmcPlc : boolean
bmcTime : boolean
bmcPara : boolean
bmcUschd : boolean
bmcTranInq : boolean
bmcRecv : boolean
bmcTranFp : boolean
bmcEmhs : boolean
bmcMper : boolean
bmcUc : boolean
bmcEdit : boolean
bmcLsid : boolean
bmcRsid : boolean
bmcSpa : boolean
bmcSpad : boolean
bmcSegs : boolean
bmcOseg : boolean
bmcMsc : boolean
bmcDc : boolean
bmcMreg : boolean
bmcSer : boolean
bmcAoi : boolean
bmcTls : boolean
bmcExptm : boolean
bmcTermMask : boolean
bmcTermNew : boolean
bmcSign : boolean
bmcLtermMask : boolean
bmcLtermNew : boolean
bmcAss : boolean
bmcMsn : boolean
bmcL61 : boolean
bmcSpMask : boolean
bmcSpNewName : boolean
bmcMsg : boolean
dlpLoadLibs
lib : String
vds : String
goodRC : String
dependent : boolean
mark : boolean
Select this field to inform BMC AMI Change Manager for IMS TM to execute Marked elements only.
A beneficial use of this function is a DELTA List containing many elements that has failed. Instead of creating another DELTA List that contains corrections for the failed element(s) from the previous DELTA List, simply correct the error(s) in the original DELTA List, Mark only those elements which require execution, and select the 'Execute Marked elements only' option at DELTA List execution.
coord : boolean
$class: 'BootPluginBuilder'
tasks : String
jvmOpts : String
$class: 'BranchDestructionStep'
project : String
branch : String
$class: 'BranchGenerationStep'
projectConfig
pipelineConfig
destructor : boolean
authorisations : String
branchSCMParameter : boolean
branchParameters : String
generationExtension : String
pipelineGenerationExtension : String
disableDslScript : boolean
scriptDirectory : String
namingStrategy
projectFolderPath : String
branchFolderPath : String
projectSeedName : String
projectDestructorName : String
branchSeedName : String
branchStartName : String
branchName : String
ignoredBranchPrefixes : String
eventStrategy
delete : boolean
auto : boolean
trigger : boolean
commit : String
project : String
scmType : String
scmUrl : String
scmCredentials : String
triggerIdentifier : String
triggerType : String
triggerSecret : String
dotnetBuild
dotnet build
command builds the project and its dependencies into a set of binaries. The binaries include the project's code in Intermediate Language (IL) files with a .dll extension. Depending on the project type and settings, other files may be included, such as:
charset : String
(optional)
configuration : String
(optional)
Debug
, but you can override the build configuration settings in your project.
continueOnError : boolean
(optional)
FAILURE
(or UNSTABLE
, if configured that way), but the build will be allowed to continue. Otherwise, any such errors will cause the build to be terminated immediately.
force : boolean
(optional)
framework : String
(optional)
noDependencies : boolean
(optional)
noIncremental : boolean
(optional)
noRestore : boolean
(optional)
nologo : boolean
(optional)
option : String
(optional)
options : Array / List of String
(optional)
optionsString : String
(optional)
outputDirectory : String
(optional)
./bin/<configuration>/<framework>/
. For projects with multiple target frameworks (via the TargetFrameworks
property), you also need to specify a specific framework when you specify this option.
project : String
(optional)
properties
(optional)
java.util.Map<java.lang.String, java.lang.String>
propertiesString : String
(optional)
runtime : String
(optional)
sdk : String
(optional)
dotnet
will be in the path.
With .NETelement (or a
withDotNet
block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
showSdkInfo : boolean
(optional)
dotnet --info
will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
shutDownBuildServers : boolean
(optional)
dotnet build-server shutdown
will be executed after the main command, shutting down build servers that may have been started.
hanguntil those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
specificSdkVersion : boolean
(optional)
dotnet
executable may use the most recent SDK available on the system, even when PATH
is set up to find an older SDK deployment first; see this page for more information.
global.json
file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json
already present in the current directory.
target : String
(optional)
targets : Array / List of String
(optional)
targetsString : String
(optional)
unstableIfErrors : boolean
(optional)
unstableIfWarnings : boolean
(optional)
verbosity : String
(optional)
versionSuffix : String
(optional)
$(VersionSuffix)
property to use when building the project. This only works if the $(Version)
property isn't set. Then, $(Version)
is set to the $(VersionPrefix)
combined with the $(VersionSuffix)
, separated by a dash.
workDirectory : String
(optional)
reportBuild
applicationName : String
(optional)
applicationVersion : String
(optional)
applicationComponent : String
(optional)
artifactFileName : String
(optional)
artifactFileSizeLimit : int
(optional)
buildAddUrl
title : String
url : String
$class: 'BuildBuilder'
dbFolder
value
vcsroot
, subfolder
, scaproject
subfolder : String
projectPath : String
packageid : String
tempServer
value : String
serverName : String
dbName : String
serverAuth
value : String
username : String
password
class hudson.util.Secret
encryptConnection : boolean
trustServerCertificate : boolean
options : String
dataOptions : String
transactionIsolationLevel
Serializable
, Snapshot
, RepeatableRead
, ReadCommitted
, ReadUncommitted
filter : String
packageVersion : String
dlmDashboard
dlmDashboardHost : String
dlmDashboardPort : String
sqlChangeAutomationVersionOption
value
Latest
, Specific
specificVersion : String
buildDescription
descriptionTemplate : String
buildName
nameTemplate : String
$class: 'BuildNameUpdater'
fromFile : boolean
buildName : String
fromMacro : boolean
macroTemplate : String
macroFirst : boolean
crxBuild
packageId : String
(optional)
baseUrl : String
(optional)
username[:password]@
between the scheme and the hostname.
credentialsId : String
(optional)
/$username/keys/$fingerprint
.
download : boolean
(optional)
localDirectory : String
(optional)
requestTimeout : long
(optional)
serviceTimeout : long
(optional)
waitDelay : long
(optional)
wspFilter : String
(optional)
/etc # define /etc as the filter root +/etc(/.*)? # include everything under /etc -/etc/packages(/.)? # exclude package pathsTo create a package for a project "acme" defined in CRX DE Lite, a filter may look like this:
/content/acme # include the site content /apps/acme # include the app codeThis field supports parameter tokens.
$class: 'BuildScanner'
profile : String
target : String
repTemp : String
threat : String
stopScan : boolean
svRep : boolean
incScan : boolean
incScanId : String
stopTargetScans : boolean
$class: 'BuildStepBuilder'
sourceFolderMode : String
subfolder : String
packageId : String
serverType : String
server : String
authenticationType : String
userName : String
password
class hudson.util.Secret
database : String
compareOptions : String
(optional)
filterFile : String
(optional)
transactionIsoLvl : String
(optional)
$class: 'BuildStepWithTimeout'
buildStep : Build Step (hudson.tasks.BuildStep
)
strategy
$class: 'AbsoluteTimeOutStrategy'
Terminate a build based on a fixed time-out period.
timeoutMinutes : String
$class: 'DeadlineTimeOutStrategy'
Terminate a build based on a deadline time specified in HH:MM:SS or HH:MM (24-hour time format).
deadlineTime : String
deadlineToleranceInMinutes : int
$class: 'ElasticTimeOutStrategy'
Terminate a build based on a specified percentage of the mean of the duration of the n most recent non-failing builds.
timeoutPercentage : String
timeoutMinutesElasticDefault : String
numberOfBuilds : String
failSafeTimeoutDuration : boolean
$class: 'LikelyStuckTimeOutStrategy'
Terminate a build when it has taken many times longer than previous ones.
$class: 'NoActivityTimeOutStrategy'
timeoutSecondsString : String
$class: 'RunConditionTimeoutStrategy'
This extension uses run condition as condition sources.
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
timeout : long
defaultTimeout : long
operationList
$class: 'AbortAndRestartOperation'
maxRestarts : String
$class: 'AbortOperation'
$class: 'BuildStepOperation'
buildstep : Build Step (hudson.tasks.BuildStep
)
continueEvenFailed : boolean
createLauncher : boolean
$class: 'FailOperation'
$class: 'WriteDescriptionOperation'
description : String
$class: 'BuildStepsFromJsonBuilder'
$class: 'BuildoutBuilder'
pythonName : String
buildoutCfg : String
nature : String
command : String
ignoreExitCode : boolean
byteguardGreet
token : String
task_id : String
$class: 'CFLaunchBuilder'
cfComposition : String
setCFVars
vars
Variable : String
Value : String
$class: 'CIMessageBuilder'
providerData
(optional)
activeMQPublisher
failOnError : boolean
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
messageContent : String
(optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
messageProperties : String
(optional)
KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
messageType
(optional)
Type of CI message to be sent.
CodeQualityChecksDone
, ComponentBuildDone
, Custom
, EarlyPerformanceTestingDone
, EarlySecurityTestingDone
, ImageUploaded
, FunctionalTestCoverageDone
, FunctionalTestingDone
, NonfunctionalTestingDone
, OotbTestingDone
, PeerReviewDone
, ProductAcceptedForReleaseTesting
, ProductBuildDone
, ProductBuildInStaging
, ProductTestCoverageDone
, PullRequest
, SecurityChecksDone
, TestingStarted
, TestingCompleted
, Tier0TestingDone
, Tier1TestingDone
, Tier2IntegrationTestingDone
, Tier2ValidationTestingDone
, Tier3TestingDone
, UnitTestCoverageDone
, UpdateDefectStatus
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
activeMQSubscriber
checks
(optional)
field : String
expectedValue : String
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
selector : String
(optional)
JMS selector to choose messages that will fire the trigger.
timeout : int
(optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
variable : String
(optional)
Environment variable to hold received message content.
fedmsgPublisher
failOnError : boolean
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
messageContent : String
(optional)
Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
fedmsgSubscriber
checks
(optional)
field : String
expectedValue : String
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
timeout : int
(optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
variable : String
(optional)
Environment variable to hold received message content.
rabbitMQPublisher
failOnError : boolean
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
fedoraMessaging : boolean
(optional)
messageContent : String
(optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
schema : String
(optional)
Path to message schema.
severity : int
(optional)
Severity of the message.
rabbitMQSubscriber
checks
(optional)
field : String
expectedValue : String
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
timeout : int
(optional)
Value (in minutes) to wait for a message.
variable : String
(optional)
Environment variable to hold received message content.
$class: 'CIMessageSubscriberBuilder'
Subscribe to the CI message bus and wait for a message matching the specified JMS selector.
The variable value specifies the name of an environment variable in which to place the received message body.
The timeout value specifies the maximum number of minutes to wait for a message matching the JMS selector to appear.
providerData
(optional)
activeMQPublisher
failOnError : boolean
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
messageContent : String
(optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
messageProperties : String
(optional)
KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
messageType
(optional)
Type of CI message to be sent.
CodeQualityChecksDone
, ComponentBuildDone
, Custom
, EarlyPerformanceTestingDone
, EarlySecurityTestingDone
, ImageUploaded
, FunctionalTestCoverageDone
, FunctionalTestingDone
, NonfunctionalTestingDone
, OotbTestingDone
, PeerReviewDone
, ProductAcceptedForReleaseTesting
, ProductBuildDone
, ProductBuildInStaging
, ProductTestCoverageDone
, PullRequest
, SecurityChecksDone
, TestingStarted
, TestingCompleted
, Tier0TestingDone
, Tier1TestingDone
, Tier2IntegrationTestingDone
, Tier2ValidationTestingDone
, Tier3TestingDone
, UnitTestCoverageDone
, UpdateDefectStatus
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
activeMQSubscriber
checks
(optional)
field : String
expectedValue : String
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
selector : String
(optional)
JMS selector to choose messages that will fire the trigger.
timeout : int
(optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
variable : String
(optional)
Environment variable to hold received message content.
fedmsgPublisher
failOnError : boolean
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
messageContent : String
(optional)
Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
fedmsgSubscriber
checks
(optional)
field : String
expectedValue : String
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
timeout : int
(optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
variable : String
(optional)
Environment variable to hold received message content.
rabbitMQPublisher
failOnError : boolean
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
fedoraMessaging : boolean
(optional)
messageContent : String
(optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
schema : String
(optional)
Path to message schema.
severity : int
(optional)
Severity of the message.
rabbitMQSubscriber
checks
(optional)
field : String
expectedValue : String
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
timeout : int
(optional)
Value (in minutes) to wait for a message.
variable : String
(optional)
Environment variable to hold received message content.
$class: 'CRDABuilder'
file : String
(optional)
consentTelemetry : boolean
(optional)
CRDA CLI is constantly improving and we would like to know more about usage. Click here to find more details.
execMan
requestType : String
(optional)
altCTMConfig
(optional)
url : String
credentials : String
execParams
(optional)
list
(optional)
key : String
value : String
postExecute
(optional)
action : String
params : String
request
(optional)
name : String
waitConfig
(optional)
pollInterval : String
maxRunTime : String
$class: 'CToolBuilder'
cmake -P <script file>
) or command mode (cmake -E <command>
).
installationName : String
arguments : String
(optional)
ignoredExitCodes : String
(optional)
toolId : String
(optional)
workingDir : String
(optional)
generateCache
caches
type
A2L
, ELF
, BUS
, MODEL
, SERVICE
filePath : String
dbChannel : String
clear : boolean
$class: 'CallFunction'
functionName : String
(optional)
argumentList : Array / List of String
(optional)
argument : String
(optional)
$class: 'CallOtherJenkinsBuilder'
hostName : String
jobName : String
span : String
retry : String
userName : String
password : String
parameters : String
$class: 'CaptureIOSDeviceScreenshot'
url : String
cloudTestServerID : String
additionalOptions : String
carbonetes
name : String
credentialsId : String
(optional)
engineTimeout : int
(optional)
failBuildOnPluginError : boolean
(optional)
failBuildOnPolicyEvaluationFailResult : boolean
(optional)
image : String
(optional)
policyBundleID : String
(optional)
registryURI : String
(optional)
carl
installationName : String
sourcePath : String
applicationName : String
archivePdf : boolean
(optional)
displayLog : boolean
(optional)
logPath : String
(optional)
outputPath : String
(optional)
qualityGate : String
(optional)
venafiVcertRequestCertificate
connectorName : String
zoneConfigName : String
The name of the zone configuration to use.
When using Venafi as a Service, zone names are in the format of app name\api alias
commonName : String
privKeyOutput : String
certOutput : String
certChainOutput : String
country : String
(optional)
dnsNames
(optional)
hostName : String
emailAddresses
(optional)
address : String
expirationWindow : int
(optional)
ipAddresses
(optional)
address : String
keyType
(optional)
RSA
, ECDSA
locality : String
(optional)
organization : String
(optional)
organizationalUnit : String
(optional)
province : String
(optional)
changeAsmVer
versionPattern : String
assemblyCompany : String
(optional)
assemblyCopyright : String
(optional)
assemblyCulture : String
(optional)
assemblyDescription : String
(optional)
assemblyFile : String
(optional)
assemblyProduct : String
(optional)
assemblyTitle : String
(optional)
assemblyTrademark : String
(optional)
regexPattern : String
(optional)
replacementPattern : String
(optional)
$class: 'ChangeEventBuilder'
integrationKey : String
customDetails : String
(optional)
summaryText : String
(optional)
chatterPost
postToChatter "Build Started - ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"
credentialsId : String
If you're connecting from outside of your organizations trusted network, you'll also need to append your API security token to your password.
See Identity Confirmation in the salesforce.com online help for more information.
body : String
buildUrlTitle : String
(optional)
recordId : String
(optional)
server : String
(optional)
$class: 'CheckGate'
pipelineId : String
stageName : String
versionId : String
fatal : String
$class: 'CheckGateBuilder'
project : String
gate : String
checkmarxASTScanner
useOwnServerCredentials : boolean
(optional)
serverUrl : String
(optional)
useAuthenticationUrl : boolean
(optional)
baseAuthUrl : String
(optional)
tenantName : String
(optional)
projectName : String
(optional)
credentialsId : String
(optional)
useOwnAdditionalOptions : boolean
(optional)
additionalOptions : String
(optional)
branchName : String
(optional)
checkmarxInstallation : String
(optional)
chlAtuoAction
content : String
browserString : String
runScriptOnly : boolean
rootPath : String
libPath : String
$class: 'ChrootBuilder'
chrootName : String
ignoreExit : boolean
additionalPackages : String
packagesFile : String
clear : boolean
command : String
loginAsRoot : boolean
noUpdate : boolean
forceInstall : boolean
$class: 'CifsBuilderPlugin'
publishers
configName : String
verbose : boolean
transfers
sourceFiles : String
excludes : String
remoteDirectory : String
removePrefix : String
remoteDirectorySDF : boolean
flatten : boolean
cleanRemote : boolean
noDefaultExcludes : boolean
makeEmptyDirs : boolean
patternSeparator : String
useWorkspaceInPromotion : boolean
usePromotionTimestamp : boolean
retry
retries : int
retryDelay : long
label
label : String
continueOnError : boolean
failOnError : boolean
alwaysPublishFromMaster : boolean
masterNodeName : String
paramPublish
parameterName : String
$class: 'ClangScanBuildBuilder'
target : String
targetSdk : String
xcodebuild -showsdks
config : String
clangInstallationName : String
xcodeProjectSubPath : String
workspace : String
scheme : String
scanbuildargs : String
xcodebuildargs : String
outputFolderName : String
googleStorageUpload
credentialsId : String
bucket : String
pattern : String
pathPrefix : String
(optional)
sharedPublicly : boolean
(optional)
showInline : boolean
(optional)
dotnetClean
dotnet clean
command cleans the output of the previous build. It's implemented as an MSBuild target, so the project is evaluated when the command is run. Only the outputs created during the build are cleaned. Both intermediate (obj) and final output (bin) folders are cleaned.
charset : String
(optional)
configuration : String
(optional)
Debug
, but you can override the build configuration settings in your project. This option is only required when cleaning if you specified it during build time.
continueOnError : boolean
(optional)
FAILURE
(or UNSTABLE
, if configured that way), but the build will be allowed to continue. Otherwise, any such errors will cause the build to be terminated immediately.
framework : String
(optional)
nologo : boolean
(optional)
option : String
(optional)
options : Array / List of String
(optional)
optionsString : String
(optional)
outputDirectory : String
(optional)
project : String
(optional)
properties
(optional)
java.util.Map<java.lang.String, java.lang.String>
propertiesString : String
(optional)
runtime : String
(optional)
sdk : String
(optional)
dotnet
will be in the path.
With .NETelement (or a
withDotNet
block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
showSdkInfo : boolean
(optional)
dotnet --info
will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
shutDownBuildServers : boolean
(optional)
dotnet build-server shutdown
will be executed after the main command, shutting down build servers that may have been started.
hanguntil those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
specificSdkVersion : boolean
(optional)
dotnet
executable may use the most recent SDK available on the system, even when PATH
is set up to find an older SDK deployment first; see this page for more information.
global.json
file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json
already present in the current directory.
unstableIfErrors : boolean
(optional)
unstableIfWarnings : boolean
(optional)
verbosity : String
(optional)
workDirectory : String
(optional)
cleanPerformanceMeasurement
cleanMeasurement : boolean
(optional)
cleanRCA : boolean
(optional)
cleanRTS : boolean
(optional)
examCleanTarget
validNetwork
username : String
password : String
projectId : String
filepath : String
$class: 'ClifBuilder'
clifName : String
clifOpts : String
testPlanFile : String
reportDir : String
$class: 'CloudBuildBuilder'
input
credentialsId : String
request
file
filename : String
inline
request : String
source
(optional)
local
path : String
.tgz
or .tar.gz
) or zip file (.zip
), or.tgz
) and uploaded to a temporary Cloud Storage bucket.repo
branch : String
(optional)
commit : String
(optional)
projectId : String
(optional)
repoName : String
(optional)
tag : String
(optional)
storage
bucket : String
object : String
substitutionList
(optional)
items
key : String
_
) and use only numbers, uppercase letters, and underscores (respecting the regular expression _[A-Z0-9_]+
). The key may not be longer than 100 characters. For details, see Build Requests - User-defined substitutions.
value : String
substitutions
(optional)
java.util.Map<java.lang.String, java.lang.String>
pushToCloudFoundry
target : String
organization : String
cloudSpace : String
credentialsId : String
manifestChoice
(optional)
appName : String
(optional)
appPath : String
(optional)
buildpack : String
(optional)
command : String
(optional)
domain : String
(optional)
envVars
(optional)
key : String
value : String
hostname : String
(optional)
instances : String
(optional)
manifestFile : String
(optional)
memory : String
(optional)
noRoute : String
(optional)
servicesNames
(optional)
name : String
stack : String
(optional)
timeout : String
(optional)
value : String
(optional)
pluginTimeout : String
(optional)
selfSigned : String
(optional)
servicesToCreate
(optional)
name : String
type : String
plan : String
resetService : boolean
(optional)
cloudhubDeployer
environmentId : String
orgId : String
appName : String
muleVersion : String
filePath : String
credentialsId : String
(optional)
requestMode
(optional)
CREATE
, UPDATE
, CREATE_OR_UPDATE
, UPDATE_FILE
, RESTART
, DELETE
region : String
(optional)
autoScalePolicy
(optional)
autoScalePolicyName : String
(optional)
enableAutoScalePolicy : boolean
(optional)
id : String
(optional)
maxScale : int
(optional)
minScale : int
(optional)
scaleBasedOn : String
(optional)
scaleDown
(optional)
class org.jenkinsci.plugins.cloudhubdeployer.data.Scale
scaleDownNextScaleWaitMins : int
(optional)
scaleDownPeriodCount : int
(optional)
scaleDownValue : int
(optional)
scaleType : String
(optional)
scaleUp
(optional)
class org.jenkinsci.plugins.cloudhubdeployer.data.Scale
scaleUpNextScaleWaitMins : int
(optional)
scaleUpPeriodCount : int
(optional)
scaleUpValue : int
(optional)
autoStart : boolean
(optional)
debugMode
(optional)
ENABLED
, DISABLED
enableAutoScalePolicy : boolean
(optional)
envVars
(optional)
key : String
(optional)
value : String
(optional)
ignoreGlobalSettings : boolean
(optional)
logLevels
(optional)
levelCategory
(optional)
DEBUG
, WARN
, ERROR
, INFO
packageName : String
(optional)
loggingNgEnabled : boolean
(optional)
monitoringAutoRestart : boolean
(optional)
monitoringEnabled : boolean
(optional)
objectStoreV1 : boolean
(optional)
persistentQueues : boolean
(optional)
persistentQueuesEncrypted : boolean
(optional)
timeoutConnection : int
(optional)
timeoutResponse : int
(optional)
verifyDeployments : boolean
(optional)
verifyIntervalInSeconds : int
(optional)
workerAmount : int
(optional)
workerCpu : String
(optional)
workerMemory : String
(optional)
workerType : String
(optional)
workerWeight : String
(optional)
$class: 'CloudShellConfig'
buildStep
$class: 'StartSandbox'
blueprintName : String
sandboxDuration : String
maxWaitForSandboxAvailability : int
setupTimeout : int
params : String
(optional)
sandboxDomain : String
(optional)
sandboxName : String
(optional)
$class: 'CmakeBuilder'
cmake -G
with the given options.
CMAKE_BUILD_TOOL
build environment variable if the chosen generator supports that.
installationName : String
buildDir : String
(optional)
buildType : String
(optional)
cleanBuild : boolean
(optional)
cmakeArgs : String
(optional)
generator : String
(optional)
preloadScript : String
(optional)
sourceDir : String
(optional)
steps
(optional)
args : String
(optional)
cmake
. Arguments must be separated by spaces but may contain spaces if they are enclosed in double quotes (will be handled like a Unix shell does),
envVars : String
(optional)
DESTDIR=${WORKSPACE}/artifacts/dir
KEY=VALUE
withCmake : boolean
(optional)
$CMAKE_BUILD_TOOL
) or to have cmake
run the build tool (by invoking cmake --build <dir>
).
$class: 'CocoaPodsBuilder'
cleanpods : boolean
$class: 'CodeBuilder'
credentialsType : String
credentialsId : String
proxyHost : String
proxyPort : String
awsAccessKey : String
awsSecretKey
class hudson.util.Secret
awsSessionToken : String
region : String
projectName : String
sourceVersion : String
sseAlgorithm : String
sourceControlType : String
localSourcePath : String
workspaceSubdir : String
gitCloneDepthOverride : String
reportBuildStatusOverride : String
secondarySourcesOverride : String
secondarySourcesVersionOverride : String
artifactTypeOverride : String
artifactLocationOverride : String
artifactNameOverride : String
artifactNamespaceOverride : String
artifactPackagingOverride : String
artifactPathOverride : String
artifactEncryptionDisabledOverride : String
overrideArtifactName : String
secondaryArtifactsOverride : String
envVariables : String
envParameters : String
buildSpecFile : String
buildTimeoutOverride : String
sourceTypeOverride : String
sourceLocationOverride : String
environmentTypeOverride : String
imageOverride : String
computeTypeOverride : String
cacheTypeOverride : String
cacheLocationOverride : String
cacheModesOverride : String
cloudWatchLogsStatusOverride : String
cloudWatchLogsGroupNameOverride : String
cloudWatchLogsStreamNameOverride : String
s3LogsStatusOverride : String
s3LogsEncryptionDisabledOverride : String
s3LogsLocationOverride : String
certificateOverride : String
serviceRoleOverride : String
insecureSslOverride : String
privilegedModeOverride : String
cwlStreamingDisabled : String
exceptionFailureMode : String
downloadArtifacts : String
downloadArtifactsRelativePath : String
workspaceExcludes : String
(optional)
workspaceIncludes : String
(optional)
$class: 'CodeCoverageBuilder'
connectionId : String
credentialsId : String
analysisPropertiesPath : String
analysisProperties : String
codescene
credentialsId : String
deltaAnalysisUrl : String
repository : String
analyzeBranchDiff : boolean
(optional)
analyzeLatestIndividually : boolean
(optional)
baseRevision : String
(optional)
couplingThresholdPercent : int
(optional)
failOnDecliningCodeHealth : boolean
(optional)
failOnFailedGoal : boolean
(optional)
letBuildPassOnFailedAnalysis : boolean
(optional)
markBuildAsUnstable : boolean
(optional)
originUrl : String
(optional)
riskThreshold : int
(optional)
$class: 'CodeStreamBuilder'
serverUrl : String
userName : String
password : String
tenant : String
pipelineName : String
waitExec : boolean
pipelineParams
value : String
name : String
CodeThreatScan
ctServer : String
project_name : String
fileName : String
credentialsId : String
organization_name : String
condition : String
(optional)
maxNumberOfCritical : int
(optional)
maxNumberOfHigh : int
(optional)
weaknessIs : String
(optional)
$class: 'CodefreshPipelineBuilder'
selectPipeline
cfPipeline : String
cfBranch : String
setCFVars
vars
Variable : String
Value : String
$class: 'CommentsRemoverBuilder'
filename : String
language : String
outputDir : String
$class: 'CompareBuilder'
outputFolder : String
Path to the folder in that should be used to store compare output.
It serves as input for following steps like Generate create SQL script or Generate Report.
Folder location must be specified as:
srcInputType : String
tgtInputType : String
srcInputFileOrFolder : String
Specify input folder/file that will be used as source side input for compare. Following inputs are expected.
Folder/file location must be specified as:
tgtInputFileOrFolder : String
Specify input folder/file that will be used as target side input for compare. Following inputs are expected.
Folder/file location must be specified as:
configFile : String
Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
File location must be specified as:
$class: 'CompareWithBaselineBuilder'
outputFolder : String
Path to the folder in that should be used to store baseline compare output.
It serves as input for following steps like Generate create SQL script or Generate Report.
Folder location must be specified as:
srcInputType : String
tgtInputType : String
srcInputFileOrFolder : String
Specify input folder/file that will be used as source side input for baseline compare. Following inputs are expected.
Folder/file location must be specified as:
tgtInputFileOrFolder : String
Specify input folder/file that will be used as target side input for baseline compare. Following inputs are expected.
Folder/file location must be specified as:
configFile : String
Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
File location must be specified as:
$class: 'CompoundBuilder'
role : String
number : String
actualBuilder
$class: 'A3Builder'
project_file : String
analysis_ids : String
pedantic_level : String
export_a3apxworkspace : String
copy_report_file : boolean
copy_result_file : boolean
skip_a3_analysis : boolean
$class: 'ACSDeploymentBuilder'
context
java.lang.TypeNotPresentException: Type org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint not present
ACXScanBuilder
ncScanType : String
ncWebsiteId : String
ncProfileId : String
ncDoNotFail : boolean
(optional)
ncReportType : String
(optional)
acxServerURL : String
(optional)
credentialsId : String
(optional)
ncApiToken : Object
(optional)
ncConfirmed : boolean
(optional)
ncIgnoreFalsePositive : boolean
(optional)
ncIgnoreRiskAccepted : boolean
(optional)
ncSeverity : String
(optional)
ncStopScan : boolean
(optional)
cfyAzureArm
azureCredentialsId : String
(optional)
The ID of the credentials to use when accessing Azure. Parameters' expansion is supported when using freestyle jobs.
credentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugOutput : boolean
(optional)
deploymentId : String
(optional)
echoEnvData : boolean
(optional)
If checked, then the created environment's data will be printed to the job's log.
echoInputs : boolean
(optional)
envDataLocation : String
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
location : String
(optional)
The Azure location where the created resource group should reside in. If omitted, the value of the azure_default_location
Cloudify secret will be used.
parameters
(optional)
YAML/JSON of parameters to pass to the template.
java.util.Map<java.lang.String, java.lang.Object>
parametersAsString : String
(optional)
parametersFile : String
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
resourceGroupName : String
(optional)
Name of resource group to create for the template.
templateFile : String
(optional)
Workspace-relative path of the ARM template file.
tenant : String
(optional)
$class: 'AWSEBBuilder'
extensions
awsRegion
GovCloud
, US_GOV_EAST_1
, US_EAST_1
, US_EAST_2
, US_WEST_1
, US_WEST_2
, EU_WEST_1
, EU_WEST_2
, EU_WEST_3
, EU_CENTRAL_1
, EU_CENTRAL_2
, EU_NORTH_1
, EU_SOUTH_1
, EU_SOUTH_2
, AP_EAST_1
, AP_SOUTH_1
, AP_SOUTH_2
, AP_SOUTHEAST_1
, AP_SOUTHEAST_2
, AP_SOUTHEAST_3
, AP_SOUTHEAST_4
, AP_NORTHEAST_1
, AP_NORTHEAST_2
, AP_NORTHEAST_3
, SA_EAST_1
, CN_NORTH_1
, CN_NORTHWEST_1
, CA_CENTRAL_1
, ME_CENTRAL_1
, ME_SOUTH_1
, AF_SOUTH_1
, US_ISO_EAST_1
, US_ISOB_EAST_1
, US_ISO_WEST_1
, IL_CENTRAL_1
awsRegionText : String
credentialsString : String
credentialsText : String
applicationName : String
versionLabelFormat : String
versionDescriptionFormat : String
failOnError : boolean
extensions
$class: 'AWSEBElasticBeanstalkSetup'
$class: 'AWSEBS3Setup'
bucketName : String
bucketRegion : String
keyPrefix : String
rootObject : String
Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.
It could be either a path to a zip file or a directory.
If its a directory, includes and excludes are used to build the zip file
includes : String
excludes : String
overwriteExistingFile : boolean
useTransferAcceleration : boolean
$class: 'ByName'
envNameList : String
$class: 'ByUrl'
urlList : String
envLookup
$class: 'AWSEBElasticBeanstalkSetup'
$class: 'AWSEBS3Setup'
bucketName : String
bucketRegion : String
keyPrefix : String
rootObject : String
Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.
It could be either a path to a zip file or a directory.
If its a directory, includes and excludes are used to build the zip file
includes : String
excludes : String
overwriteExistingFile : boolean
useTransferAcceleration : boolean
$class: 'ByName'
envNameList : String
$class: 'ByUrl'
urlList : String
$class: 'AWSEBDeploymentBuilder'
config
class br.com.ingenieux.jenkins.plugins.awsebdeployment.AWSEBDeploymentConfig
applicationName : String
(optional)
awsRegion : String
(optional)
bucketName : String
(optional)
S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
(Optional, will call createStorageLocation
if blank)
checkHealth : boolean
(optional)
credentialId : String
(optional)
environmentName : String
(optional)
Optional: AWS EB Environment name(s) to deploy to.
Can accept single or multiple comma-separated values. Examples:
When this value is set and each requested environment exists, an UpdateEnvironment call will be triggered as the Application Version is created.
excludes : String
(optional)
includes : String
(optional)
keyPrefix : String
(optional)
maxAttempts : int
(optional)
rootObject : String
(optional)
Workspace-relative path of the artifact file to upload (if it's a file), or if it's a directory, the base directory to build the zip/war against
Examples:
target/mywebapp.war
: The war file will be uploaded.
' or 'target/war
': A Zip file will be built and uploaded instead (using includes and excludes).skipEnvironmentUpdates : boolean
(optional)
sleepTime : int
(optional)
versionDescriptionFormat : String
(optional)
versionLabelFormat : String
(optional)
zeroDowntime : boolean
(optional)
awsebReleaser
credentialId : String
awsRegion : String
applicationName : String
environmentId : String
versionLabel : String
abapCi
abapPackagename : String
(optional)
atcVariant : String
(optional)
sapSystemLabel : String
(optional)
runAtcChecks : boolean
(optional)
runUnitTests : boolean
(optional)
treatWarningAtcChecksAsErrors : boolean
(optional)
useJenkinsProjectName : boolean
(optional)
withCoverage : boolean
(optional)
snActivatePlugin
credentialsId : String
(optional)
apiVersion : String
(optional)
pluginId : String
(optional)
url : String
(optional)
addchangestobuildchangelog
changelogPath : String
changelogText : String
$class: 'AddComment'
prefix : String
note : String
logfile : String
$class: 'AddTestToSetStep'
domain : String
project : String
testPlanPath : String
testSetPath : String
allocateDS
dsn : String
dsOrg
PO
, POE
, PS
, VS
primary : int
secondary : int
recFm
F
, FB
, V
, VB
, U
, VSAM
, VA
alcUnit
(optional)
TRK
, CYL
avgBlk : int
(optional)
blkSize : int
(optional)
dataClass : String
(optional)
dirBlk : int
(optional)
dsModel : String
(optional)
dsnType
(optional)
LIBRARY
, HFS
, PDS
, LARGE
, BASIC
, EXTREQ
, EXTPREF
lrecl : int
(optional)
mgntClass : String
(optional)
storClass : String
(optional)
unit : String
(optional)
volser : String
(optional)
$class: 'AmxEclipseAntBuilder'
targets : String
name : String
Jenkins supplies some environment variables that can be used from within the build script.
antOpts : String
buildFile : String
properties : String
# comment name1=value1 name2=$VAR2These are passed to amx_eclipse_ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as amx_eclipse_ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname= Please refer to TIBCO Documentation for any detail
amxEclipseAntTra : String
businessStudioWs : String
anchore
name : String
annotations
(optional)
key : String
value : String
autoSubscribeTagUpdates : boolean
(optional)
bailOnFail : boolean
(optional)
bailOnPluginFail : boolean
(optional)
engineCredentialsId : String
(optional)
engineRetries : String
(optional)
engineurl : String
(optional)
engineverify : boolean
(optional)
forceAnalyze : boolean
(optional)
policyBundleId : String
(optional)
$class: 'AnsibleAdHocCommandBuilder'
hostPattern : String
inventory
$class: 'InventoryContent'
content : String
dynamic : boolean
$class: 'InventoryDoNotSpecify'
$class: 'InventoryPath'
path : String
module : String
command : String
additionalParameters : String
(optional)
ansibleName : String
(optional)
becomeUser : String
(optional)
colorizedOutput : boolean
(optional)
credentialsId : String
(optional)
disableHostKeyChecking : boolean
(optional)
extraVars
(optional)
hidden : boolean
(optional)
key : String
(optional)
secretValue
(optional)
class hudson.util.Secret
forks : int
(optional)
hostKeyChecking : boolean
(optional)
sudo : boolean
(optional)
sudoUser : String
(optional)
unbufferedOutput : boolean
(optional)
vaultCredentialsId : String
(optional)
cfyAnsible
additionalArgs : String
(optional)
ansibleEnvVars : String
(optional)
credentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugLevel : int
(optional)
debugOutput : boolean
(optional)
deploymentId : String
(optional)
echoEnvData : boolean
(optional)
echoInputs : boolean
(optional)
envDataLocation : String
(optional)
optionsConfig : String
(optional)
playbookPath : String
(optional)
remergeSources : boolean
(optional)
runData : String
(optional)
savePlaybook : boolean
(optional)
scpExtraArgs : String
(optional)
sensitiveKeys : String
(optional)
sftpExtraArgs : String
(optional)
sourcePath : String
(optional)
sources : String
(optional)
sshCommonArgs : String
(optional)
sshExtraArgs : String
(optional)
startAtTask : String
(optional)
tenant : String
(optional)
timeout : int
(optional)
$class: 'AnsiblePlaybookBuilder'
playbook : String
inventory
$class: 'InventoryContent'
content : String
dynamic : boolean
$class: 'InventoryDoNotSpecify'
$class: 'InventoryPath'
path : String
additionalParameters : String
(optional)
ansibleName : String
(optional)
becomeUser : String
(optional)
colorizedOutput : boolean
(optional)
credentialsId : String
(optional)
disableHostKeyChecking : boolean
(optional)
extraVars
(optional)
hidden : boolean
(optional)
key : String
(optional)
secretValue
(optional)
class hudson.util.Secret
forks : int
(optional)
hostKeyChecking : boolean
(optional)
limit : String
(optional)
skippedTags : String
(optional)
startAtTask : String
(optional)
sudo : boolean
(optional)
sudoUser : String
(optional)
tags : String
(optional)
unbufferedOutput : boolean
(optional)
vaultCredentialsId : String
(optional)
$class: 'AnsibleTower'
towerServer : String
(optional)
jobTemplate : String
(optional)
towerCredentialsId : String
(optional)
jobType : String
(optional)
extraVars : String
(optional)
jobTags : String
(optional)
skipJobTags : String
(optional)
limit : String
(optional)
inventory : String
(optional)
credential : String
(optional)
scmBranch : String
(optional)
verbose : boolean
(optional)
importTowerLogs : boolean
(optional)
removeColor : boolean
(optional)
templateType : String
(optional)
importWorkflowChildLogs : boolean
(optional)
$class: 'AnsibleTowerProjectRevisionFreestyle'
towerServer : String
(optional)
towerCredentialsId : String
(optional)
project : String
(optional)
revision : String
(optional)
verbose : boolean
(optional)
throwExceptionWhenFail : boolean
(optional)
$class: 'AnsibleTowerProjectSyncFreestyle'
towerServer : String
(optional)
towerCredentialsId : String
(optional)
project : String
(optional)
verbose : boolean
(optional)
importTowerLogs : boolean
(optional)
removeColor : boolean
(optional)
$class: 'AnsibleVaultBuilder'
action : String
(optional)
ansibleName : String
(optional)
content : String
(optional)
input : String
(optional)
newVaultCredentialsId : String
(optional)
output : String
(optional)
vaultCredentialsId : String
(optional)
ant
Jenkins supplies some environment variables that can be used from within the build script.
targets : String
antName : String
antOpts : String
-Xmx512m
. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
buildFile : String
build.xml
in the root directory; this option can be used to use build files with a different name or in a subdirectory.
properties : String
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
$class: 'AntExec'
scriptSource : String
extendedScriptSource : String
scriptName : String
properties : String
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname=
antName : String
antOpts : String
keepBuildfile : boolean
verbose : boolean
emacs : boolean
noAntcontrib : boolean
Disabling usage of Ant-Contrib Tasks in this build step.
antws
Jenkins supplies some environment variables that can be used from within the build script.
targets : String
antName : String
antOpts : String
-Xmx512m
. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
buildFile : String
build.xml
in the root directory; this option can be used to use build files with a different name or in a subdirectory.
properties : String
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
$class: 'ApiFortressBuilder'
mode : String
hook : String
id : String
blocking : boolean
dryrun : boolean
silent : boolean
param1name : String
param1value : String
param2name : String
param2value : String
param3name : String
param3value : String
appray
appRayUrl : String
outputFilePath : String
waitTimeout : int
riskScoreThreshold : int
credentialsId : String
appscan
scanner
dynamic_analyzer
target : String
hasOptions : boolean
extraField : String
(optional)
loginPassword : String
(optional)
loginType : String
(optional)
loginUser : String
(optional)
optimization : String
(optional)
presenceId : String
(optional)
scanFile : String
(optional)
scanType : String
(optional)
trafficFile : String
(optional)
static_analyzer
target : String
hasOptions : boolean
openSourceOnly : boolean
(optional)
scanMethod : String
(optional)
scanSpeed : String
(optional)
sourceCodeOnly : boolean
(optional)
name : String
type : String
application : String
credentials : String
email : boolean
(optional)
failBuild : boolean
(optional)
failBuildNonCompliance : boolean
(optional)
failureConditions
(optional)
failureType : String
threshold : int
intervention : boolean
(optional)
target : String
(optional)
wait : boolean
(optional)
appscanenterprise
credentials : String
folder : String
testPolicy : String
template : String
jobName : String
accessId : String
(optional)
agent : String
(optional)
application : String
(optional)
email : boolean
(optional)
exploreData : String
(optional)
failBuild : boolean
(optional)
failureConditions
(optional)
failureType : String
threshold : int
loginType : String
(optional)
scanType : String
(optional)
secretKey : String
(optional)
target : String
(optional)
testOptimization : String
(optional)
trafficFile : String
(optional)
wait : boolean
(optional)
$class: 'AppScanSourceBuilder'
disableScan : boolean
applicationFile : String
acceptSSL : boolean
customScanWorkspace : String
This value will be passed to AppScan Source as the scan workspace. AppScan Source assessment and working files will be stored in this directory.
If this field is blank, the default scan directory will be used.
The default directory is this job's build folder, as defined by Jenkins.
installation : String
(optional)
$class: 'AppScanStandardBuilder'
startingURL : String
Spiders will find the remaining URLs in the domain to be included for scanning.
installation : String
additionalCommands : String
(optional)
AppScanCMD exec|ex|e Parameters: [ /dest_scan|/dest|/d ] [ /base_scan|/base|/b ] [ /old_host|/ohost|/oh ] [ /new_host|/nhost|/nh ] [ /scan_template|/stemplate|/st ] [ /login_file|/lfile|/lf ] [ /multi_step_file|/mstepfile|/mf ] [ /manual_explore_file|/mexplorefile|/mef ] [ /policy_file|/pfile|/pf ] [ /additional_domains|/adomains|/ad ] [ /report_file|/rf ] [ /report_type|/rt {xml} ] [ /min_severity|/msev {informational} ] [ /test_type|/tt ] [ /report_template|/rtemplate|/rtm {CliDefault} ] Flags: [ /verbose|/v {false} ] [ /scan_log|/sl {false} ] [ /explore_only|/eo {false} ] [ /test_only|/to {false} ] [ /multi_step|/mstep|/ms {false} ] [ /continue|/c {false} ] [ /merge_manual_explore_requests|/mmer {false} ] [ /include_responses|/ir {false} ] [ /open_proxy|/oprxy|/opr /listening_port|/lport|/lp ] Creates new scan with base_scan's configuration saving dest_scan and creating report, if configured. AppScanCMD report|rep|r Parametrs: /base_scan|/base|/b /report_file|/rf /report_type|/rt [ /min_severity|/msev {informational} ] [ /test_type|/tt ] [ /report_template|/rtemplate|/rtm {CliDefault} ] Flags: [ /verbose|/v {false} ] Creates a report for base_scan. AppScanCMD close_proxy|cprxy|cpr Closes AppScan proxy if was previously opened. More info. at: (9.0.3.2 User Guide) CLI - Chapter 15 - CLI - Page 315 http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
authScan : boolean
(optional)
If the website contains private information accessed only by logging in this option should be checked and credentials provided to increase dynamic security coverage.
authScanPw : String
(optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
authScanRadio : boolean
(optional)
A login sequence may be recorded using AppScan Standard's GUI by following these steps:
"Scan" > "Scan Configuration" > "Login Management" > "Record" > [ record your login...] > "I am logged in to the site" > "Details" (Tab) > "Export" (small icon on the right side).
Check "Form Based Authentication" if you do not have a recorded login sequence, this option will require an user name and password combination and is not guaranteed to work for all scenarios.
authScanUser : String
(optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
generateReport : boolean
(optional)
The report is available in HTML and PDF.
The HTML report generated is ready to be integrated with the HTML Publisher Plugin.
htmlReport : boolean
(optional)
includeURLS : String
(optional)
Some URLs might not be found by AppScan Standard's spiders, include them to get the best possible coverage.
pathRecordedLoginSequence : String
(optional)
pdfReport : boolean
(optional)
policyFile : String
(optional)
A Test Policy File can be created following these steps:
"Scan" > "Scan Configuration" > "Test Policy" > "Export".
reportName : String
(optional)
To configure HTML Publisher Plugin properly, the names in the configuration must match.
verbose : boolean
(optional)
xooa
name : String
appId : String
AppdomeBuilder
token
class hudson.util.Secret
teamId : String
platform
AndroidPlatform
certificateMethod
Android_AutoDevSign
fingerprint : String
googleSigning : boolean
(optional)
Android_AutoSign
keystorePath : String
keystorePassword
class hudson.util.Secret
keystoreAlias
class hudson.util.Secret
keyPass
class hudson.util.Secret
googleSignFingerPrint
(optional)
googleSignFingerPrint : String
(optional)
googleSign
(optional)
googleSignFingerPrint : String
(optional)
Android_PrivateSign
fingerprint : String
googleSigning : boolean
(optional)
appPath : String
(optional)
fusionSetId : String
(optional)
IosPlatform
certificateMethod
iOS_AutoDevSign
provisioningProfiles
item : String
entitlements
item : String
iOS_AutoSign
keystorePath : String
keystorePassword
class hudson.util.Secret
entitlements
item : String
provisioningProfiles
(optional)
item : String
iOS_PrivateSign
provisioningProfiles
item : String
appPath : String
(optional)
fusionSetId : String
(optional)
secondOutput
(optional)
item : String
buildToTest
(optional)
selectedVendor : String
(optional)
buildWithLogs : boolean
(optional)
outputLocation : String
(optional)
AppdomeValidator
token
class hudson.util.Secret
appPath : String
outputLocation : String
(optional)
applatix
axUrl : String
axUsername : String
axPassword : String
axServiceTemplateName : String
axServiceTemplateRepository : String
axServiceTemplateBranch : String
axServiceTemplateParameters
key : String
value : String
snApplyChanges
credentialsId : String
(optional)
apiVersion : String
(optional)
appScope : String
(optional)
application system ID
is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
appSysId : String
(optional)
application scope
is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
branchName : String
(optional)
url : String
(optional)
$class: 'ApprendaBuilder'
appAlias : String
appName : String
versionAlias : String
stage : String
artifactName : String
credentialsId : String
prefix : String
advVersionAliasToBeForced : String
advancedNewVersionOption : String
customPackageDirectory : String
applicationPackageURL : String
archiveUploadMethod : String
buildWithParameters : boolean
aqua
locationType : String
registry : String
register : boolean
localImage : String
hostedImage : String
onDisallowed : String
notCompliesCmd : String
hideBase : boolean
showNegligible : boolean
policies : String
customFlags : String
localToken : String
(optional)
tarFilePath : String
(optional)
containerRuntime : String
(optional)
scannerPath : String
(optional)
aquaMicroscanner
imageName : String
onDisallowed : String
notCompliesCmd : String
outputFormat : String
aquaServerlessScanner
onDisallowed : String
notCompliesCmd : String
codeScanPath : String
customFlags : String
arachniScanner
url : String
checks : String
scope
pageLimit : int
excludePathPattern : String
userConfig
filename : String
format : String
aribot
credentialsID : String
(optional)
name : String
(optional)
$class: 'ArtifactDeployerBuilder'
includes : String
Can use wildcards like 'module/dist/**/*.zip'. See the @includes of Ant fileset for the exact format.
Artifacts are deployed from the workspace. You can change this basedir by specifying the basedir field under Advanced.
basedir : String
By default, the basedir is the job workspace.
Give a value to override the default value.
Path relative to workspace is permitted.
excludes : String
Optionally specify the 'excludes' pattern, such as "foo/bar/**/*". A file that matches this mask will not be deployed even if it matches the mask specified.
remote : String
Artifacts will be deployed in the specified output directory.
The remote location must be accessible through the build machine (controller and agent node).
If you want to have the ability to download deployed artifacts through the Jenkins dashboard, the location must be accessible from the Jenkins controller.
Make sure the Jenkins process have the right permissions to write to the remote location.
For example with a shared NFS storage, '/nfs/build/deploy/${BUILD_ID}' can be a valid value on a Unix machine.
flatten : boolean
Ignore the directory structure of the source files, and deploy all the artifacts into the output directory.
deleteRemote : boolean
Delete the output directory before deploying artifacts.
deleteRemoteArtifacts : boolean
failNoFilesDeploy : boolean
$class: 'ArtifactPromotionBuilder'
groupId : String
artifactId : String
classifier : String
version : String
extension : String
stagingRepository : String
stagingUser : String
stagingPW : String
releaseUser : String
releasePW : String
releaseRepository : String
promoterClass : String
debug : boolean
skipDeletion : boolean
'Skip deletion' option preserves the files in the staging repository.
Untick 'Skip deletion' only after you've promoted all the relevant files in previous steps.
reportArtifactRelease
applicationName : String
(optional)
applicationVersion : String
(optional)
applicationComponent : String
(optional)
artifactName : String
(optional)
artifactURL : String
(optional)
repositoryName : String
(optional)
tags : String
(optional)
artifactResolver
artifacts
groupId : String
artifactId : String
version : String
classifier : String
(optional)
deployToLocal : boolean
(optional)
deployToRemote : boolean
(optional)
extension : String
(optional)
failOnError : boolean
(optional)
pomFile : String
(optional)
targetFileName : String
(optional)
enableRepositoryLogging : boolean
(optional)
enableTransferLogging : boolean
(optional)
repositoryId : String
(optional)
targetDirectory : String
(optional)
artifactVersion
name : String
(optional)
description : String
(optional)
type : String
(optional)
groupId : String
(optional)
artifactId : String
(optional)
stage : String
(optional)
flow : String
(optional)
stageDescription : String
(optional)
version : String
(optional)
artifactVersion
variableName : String
name : String
(optional)
stage : String
(optional)
version : String
(optional)
assertthatBddFeatures
projectId : String
credentialsId : String
outputFolder : String
jql : String
tags : String
mode : String
proxyURI : String
proxyUsername : String
proxyPassword : String
jiraServerUrl : String
numbered : boolean
ignoreCertErrors : boolean
$class: 'AssociateItemToRelease'
releasePrefix : String
itemPrefix : String
$class: 'AstreeBuilder'
dax_file : String
analysis_id : String
output_dir : String
skip_analysis : boolean
genXMLOverview : boolean
genXMLCoverage : boolean
genXMLAlarmsByOccurence : boolean
genXMLAlarmsByCategory : boolean
genXMLAlarmsByFile : boolean
genXMLRulechecks : boolean
dropAnalysis : boolean
genPreprocessOutput : boolean
failonswitch
failon : String
audit
credentialsId : String
(optional)
minScore : int
(optional)
platformUrl : String
(optional)
apiTags : String
(optional)
branchName : String
(optional)
defaultCollectionName : String
(optional)
ignoreFailures : boolean
(optional)
ignoreNetworkErrors : boolean
(optional)
jsonReport : String
(optional)
logLevel : String
(optional)
prId : String
(optional)
prTargetBranch : String
(optional)
repositoryName : String
(optional)
rootDirectory : String
(optional)
shareEveryone : String
(optional)
skipLocalChecks : boolean
(optional)
tagName : String
(optional)
$class: 'AutEnvironmentBuilder'
autEnvironmentModel
almServerName : String
almUserName : String
almPassword : String
almDomain : String
almProject : String
clientType : String
autEnvironmentId : String
useExistingAutEnvConf : boolean
existingAutEnvConfId : String
createNewAutEnvConf : boolean
newAutEnvConfName : String
autEnvironmentParameters
name : String
value : String
paramType : String
shouldGetOnlyFirstValueFromJson : boolean
pathToJsonFile : String
outputParameter : String
autifyMobile
credentialsId : String
autifyUrl : String
https://mobile-app.autify.com/projects/<ID>/test_plans/<ID>
autifyPath : String
(optional)
buildId : String
(optional)
buildPath : String
(optional)
shellInstallerUrl : String
(optional)
timeout : String
(optional)
wait : boolean
(optional)
autifyMobileUpload
credentialsId : String
workspaceId : String
buildPath : String
autifyPath : String
(optional)
shellInstallerUrl : String
(optional)
autifyWeb
credentialsId : String
autifyUrl : String
https://app.autify.com/projects/<ID>/(scenarios|test_plans)/<ID>
autifyConnect : String
(optional)
autifyConnectClient : boolean
(optional)
autifyConnectClientExtraArguments : String
(optional)
autifyPath : String
(optional)
browser : String
(optional)
device : String
(optional)
deviceType : String
(optional)
os : String
(optional)
osVersion : String
(optional)
shellInstallerUrl : String
(optional)
testExecutionName : String
(optional)
timeout : String
(optional)
urlReplacements
(optional)
patternUrl : String
replacementUrl : String
wait : boolean
(optional)
$class: 'Autogen'
element : String
Specify the name of the element in your Endevor® sandbox that you want to include in the autogeneration process, for example, RUNCOB01. The maximum length is 8 characters.
You can specify several specific comma-separated elements within the sandbox, for example, RUNCOB01, RUNCOB02.
You can use wildcards % and * to define the name patterns for the element names.
Examples:
Specify * to include all elements from the sandbox in the autonegeration process.
Specify RUNCOB* to include all element names that start with "RUNCOB".
Specify %%%COB* to include elements that contain the substring COB starting after position three.
environment : String
Provide the environment for the Endevor® sandbox that you want to include in the autogeneration process, for example, DEV.
system : String
Provide the system name for the environment in your Endevor® sandbox that you want to include in the autogeneration process, for example, APCTTC0.
subsystem : String
Provide the subsystem name for the environment in your Endevor® sandbox that you want to include in the autogeneration process, for example, TESTCICD.
stage : String
Specify the environment stage in your Endevor® that you want to include in the autogeneration process, for example, 1.
instance : String
Specify the instance name of the environment that is associated with Endevor® Web services, for example, WEBSMFNE.
signout : boolean
Select this option to work with elements in Endevor® that might be currently worked on by another user.
Select the Override signout option only if you have the permission to override the signout of another user.
$class: 'AwsBatchBuilder'
jobname : String
jobdefinition : String
command : String
jobqueue : String
vcpu : String
memory : String
retries : String
azureCLI
principalCredentialId : String
commands
script : String
exportVariablesString : String
azureDownload
storageCredentialId : String
downloadType : String
buildSelector
(optional)
downstream
upstreamProjectName : String
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
upstreamBuildNumber : String
lastWithArtifacts
lastCompleted
$class: 'MultiJobBuildSelector'
buildParameter
parameterName : String
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
permalink
id : String
$class: 'PromotedBuildSelector'
level : int
latestSavedBuild
specific
buildNumber : String
lastSuccessful
stable : boolean
(optional)
upstream
allowUpstreamDependencies : boolean
(optional)
fallbackToLastSuccessful : boolean
(optional)
upstreamFilterStrategy
(optional)
UseGlobalSetting
, UseOldest
, UseNewest
workspace
containerName : String
(optional)
deleteFromAzureAfterDownload : boolean
(optional)
downloadDirLoc : String
(optional)
excludeFilesPattern : String
(optional)
fileShare : String
(optional)
flattenDirectories : boolean
(optional)
includeArchiveZips : boolean
(optional)
includeFilesPattern : String
(optional)
projectName : String
(optional)
verbose : boolean
(optional)
Enabling this will provide more logging on downloading files.
$class: 'BDSBuilder'
projectFile : String
switches : String
installationName : String
$class: 'BapFtpBuilder'
publishers
configName : String
Select an FTP configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the FTP server.
verbose : boolean
transfers
sourceFiles : String
Files to upload to a server.
The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
The base directory for this fileset is the workspace.
excludes : String
Exclude files from the Transfer set.
The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)
remoteDirectory : String
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder will be created if does not exist.
removePrefix : String
First part of the file path that should not be created on the remote server.
Directory structures are created relative to the base directory, which is usually the workspace.
You normally do not want the full path to these files to be created on the server.
For example if Source files were target/deployment/images/**/
then you may want Remove prefix to be target/deployment
This would create the images folder under the remote directory, and not target/deployment
Jenkins environment variables can be used in this path.
If you use remove prefix, then ALL source file paths MUST start with the prefix.
asciiMode : boolean
Select to enable ASCII mode for the transfer, otherwise binary transfer mode will be used.
Use with ASCII text files to fix the line terminators when transferring between different operating systems.
remoteDirectorySDF : boolean
Select this to include the timestamp in the remote directory.
The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
This setting turns the remote directory option into a java SimpleDateFormat.
The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.
Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.
Remote directory | Directories created |
---|---|
'qa-approved/'yyyyMMddHHmmss |
qa-approved/20101107154555 |
'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}' |
builds/2010/11/07/build-456 (if the build was number 456) |
yyyy_MM/'build'-EEE-d-HHmmss |
2010_11/build-Sun-7-154555 |
yyyy-MM-dd_HH-mm-ss |
2010-11-07_15-45-55 |
flatten : boolean
Only create files on the server, don't create directories (except for the remote directory, if present).
All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.
cleanRemote : boolean
Select to delete all files and directories within the remote directory before transferring files.
noDefaultExcludes : boolean
makeEmptyDirs : boolean
The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
Selecting this option will create any directories that match the Source files pattern, even if empty.
patternSeparator : String
The regular expression that is used to separate the Source files and Exclude files patterns.
The Source files and Exclude files both accept multiple patterns that by default are split using
[, ]+which is how Ant, by default, handles multiple patterns in a single string.
The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.
useWorkspaceInPromotion : boolean
Set the root directory for the Source files to the workspace.
By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.
If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.
If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory
usePromotionTimestamp : boolean
Use the build time of the promotion when the remote directory is a date format.
By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.
ftpRetry
If publishing to this server fails, try again.
Files that were successfully transferred will not be re-sent.
If the Clean remote option is selected, and succeeds, it will not be attempted again.
retries : int
retryDelay : long
ftpLabel
Set the label for this Server instance - for use with Parameterized publishing.
Expand the help for Parameterized publishing for more details.
label : String
Set the label for this Server instance - for use with Parameterized publishing.
Expand the help for Parameterized publishing for more details.
ftpCredentials
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set the username and password to use.
username : String
password : String
continueOnError : boolean
failOnError : boolean
alwaysPublishFromMaster : boolean
masterNodeName : String
paramPublish
parameterName : String
$class: 'BapSshBuilderPlugin'
publishers
configName : String
Select an SSH configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the SSH server.
verbose : boolean
transfers
sourceFiles : String
Files to upload to a server.
The string is a comma separated list of includes for an Ant fileset eg. '**/*.jar' (see Patterns in the Ant manual).
The base directory for this fileset is the workspace.
excludes : String
Exclude files from the Transfer set.
The string is a comma separated list of excludes for an Ant fileset eg. '**/*.log,**/*.tmp,.git/' (see Patterns in the Ant manual)
remoteDirectory : String
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder will be created if does not exist.
removePrefix : String
First part of the file path that should not be created on the remote server.
Directory structures are created relative to the base directory, which is usually the workspace.
You normally do not want the full path to these files to be created on the server.
For example if Source files were target/deployment/images/**/
then you may want Remove prefix to be target/deployment
This would create the images folder under the remote directory, and not target/deployment
Jenkins environment variables can be used in this path.
If you use remove prefix, then ALL source file paths MUST start with the prefix.
remoteDirectorySDF : boolean
Select this to include the timestamp in the remote directory.
The timestamp is the date of build. If this publisher is being used during a promotion, then the timestamp is that of the build that is being promoted.
This setting turns the remote directory option into a java SimpleDateFormat.
The SimpleDateFormat(SDF) uses letters to represent components of the date, like the month, year, or day of the week. Click here for more information about the date patterns.
As the SDF reserves all of the letters [A-Z][a-z], any that you want to appear literally in the directory that is created will need to be quoted.
Some examples follow - all examples are based on a build with a timestamp of 3:45 pm and 55 seconds on the 7th November 2010.
Remote directory | Directories created |
---|---|
'qa-approved/'yyyyMMddHHmmss |
qa-approved/20101107154555 |
'builds/'yyyy/MM/dd/'build-${BUILD_NUMBER}' |
builds/2010/11/07/build-456 (if the build was number 456) |
yyyy_MM/'build'-EEE-d-HHmmss |
2010_11/build-Sun-7-154555 |
yyyy-MM-dd_HH-mm-ss |
2010-11-07_15-45-55 |
flatten : boolean
Only create files on the server, don't create directories (except for the remote directory, if present).
All files that have been selected to transfer must have unique filenames. The publisher will stop and fail as soon as a duplicate filename is found when using the flatten option.
cleanRemote : boolean
noDefaultExcludes : boolean
makeEmptyDirs : boolean
The default behaviour of this plugin is to match files, and then create any directories required to preserve the paths to the files.
Selecting this option will create any directories that match the Source files pattern, even if empty.
patternSeparator : String
The regular expression that is used to separate the Source files and Exclude files patterns.
The Source files and Exclude files both accept multiple patterns that by default are split using
[, ]+which is how Ant, by default, handles multiple patterns in a single string.
The above expression makes it difficult to reference files or directories that contain spaces. This option allows the expression to be set to something that will preserve the spaces in a pattern eg. a single comma.
execCommand : String
(optional)
A command to execute on the remote server.
This command will be executed on the remote server after any files are transferred.
The SSH Transfer Set must include either a Source Files pattern, an Exec command, or both. If both are present, the files are transferred before the command is executed. If you want to Exec before the files are transferred, use 2 Transfer Sets and move the Exec command before the Transfer set that includes a Source files pattern.
execTimeout : int
(optional)
Timeout in milliseconds for the Exec command.
Set to zero to disable.
usePty : boolean
(optional)
Exec the command in a pseudo tty.
This will enable the execution of sudo commands that require a tty (and possibly help in other scenarios too.)
From the sudoers(5) man page:
requiretty If set, sudo will only run when the user is logged in to a real tty. When this flag is set, sudo can only be run from a login session and not via other means such as cron(8) or cgi-bin scripts. This flag is off by default.
keepFilePermissions : boolean
(optional)
Keep local file permissions of transferred files.
Changes file permissions of the file after transferring to the local one.
NB: only POSIX file permissions support is implemented.
useAgentForwarding : boolean
(optional)
Exec the command using Agent Forwarding.
Allows a chain of ssh connections to forward key challenges back to the original agent, thus eliminating the need for using a password or public/private keys for these connections.
From the ssh(1) man page:
Enables forwarding of the authentication agent connection. This can also be specified on a per-host basis in a configuration file. Agent forwarding should be enabled with caution. Users with the ability to bypass file permissions on the remote host (for the agent's UNIX-domain socket) can access the local agent through the forwarded connection. An attacker cannot obtain key material from the agent, however they can perform operations on the keys that enable them to authenticate using the identities loaded into the agent.
useSftpForExec : boolean
(optional)
Using SFTP protocol instead of SSH for Exec command.
Supported commands: mkdir, ln, symlink, rm, rmdir, cd, get, ls
useWorkspaceInPromotion : boolean
Set the root directory for the Source files to the workspace.
By default this plugin uses the artifacts directory (where archived artifacts are stored). This allows the artifacts from the build number that you are promoting to be sent somewhere else.
If you run tasks that produce files in the workspace during the promotion and you want to publish them, then set this option.
If you need to send files from both the workspace and the archive directory, then you need to add a second server, even if you want to send the files to the same place. This is due to the fact that the workspace is not necessarily on the same host as the archive directory.
usePromotionTimestamp : boolean
Use the build time of the promotion when the remote directory is a date format.
By default this plugin uses the time of the original build (the one that is being promoted) when formatting the remote directory. Setting this option will mean that if you use the remote directory is a date format option, it will use the time that the promotion process runs, instead of the original build.
sshRetry
If publishing to this server or command execution fails, try again.
Files that were successfully transferred will not be re-sent.
If Exec command is configured, but fails in any way (including a non zero exit code), then it will be retried.
retries : int
retryDelay : long
sshLabel
Set the label for this Server instance - for use with Parameterized publishing.
Expand the help for Parameterized publishing for more details.
label : String
Set the label for this Server instance - for use with Parameterized publishing.
Expand the help for Parameterized publishing for more details.
sshCredentials
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set them here.
username : String
encryptedPassphrase : String
Key
or Path to key
is configured.
key : String
The private key.
Paste the private key here, or provide the path to the file containing the key in Path to key
.
keyPath : String
The path to the private key.
Either supply the path to the file containing the key, or paste the key into the Key
box.
The Path to key
can be absolute, or relative to $JENKINS_HOME
continueOnError : boolean
failOnError : boolean
alwaysPublishFromMaster : boolean
masterNodeName : String
paramPublish
parameterName : String
batchFile
command : String
configuredLocalRules
(optional)
retainOnlyVariables
Limit which environment variables are passed to a build step.
Environment variables passed to the build step are filtered, unless listed below.
The behavior of this filter depends on whether the environment variable is originally defined outside Jenkins:
JOB_URL
, it will not be passed to the build step unless specified here.PATH
, the behavior depends on the option Process environment variables handling : If that option is set to Retain , the original value will be passed to the build step, discarding any modifications inside Jenkins. If that option is set to Remove , the variable will not be passed to the build step.The following table shows the effect of filtering on an environment variable:
Behavior | Originally defined outside Jenkins | Originally defined inside Jenkins |
---|---|---|
Process environment variables handling: reset | Variable is reset to original value | Variable is removed |
Process environment variables handling: removed | Variable is removed | Variable is removed |
processVariablesHandling
(optional)
RESET
, REMOVE
retainCharacteristicEnvVars : boolean
(optional)
When checked, characteristic environment variables will be retained in addition to the variables listed above. These environment variables are job- and build-specific, defined by Jenkins, and are used to identify and kill processes started by this build step. See the documentation for more details on starting processes.
variables : String
(optional)
Whitespace separated, case insensitive list of environment variables that will be retained, i.e. not removed from the environment of this build step or reset to their default.
unstableReturn : int
(optional)
snBatchInstall
credentialsId : String
(optional)
apiVersion : String
(optional)
batchName : String
(optional)
file : String
(optional)
The field is required if Use file is checked. If the field is not changed default value will be used: now_batch_manifest.json
.
notes : String
(optional)
Default: null
packages : String
(optional)
[{
"id": "String",
"load_demo_data": Boolean,
"notes": "String",
"requested_customized_version": "String",
"requested_version": "String",
"type": "String"
}]
id | Required. Sys_id of the application or identifier of the plugin to install. |
---|---|
load_demo_data | Flag that indicates whether demo data is loaded when installing the package. Valid values: true : Demo data should be loaded. false : Demo data should not be loaded. Default: false |
notes | User specified notes about the package. Default: null |
requested_customized_version | Only applicable when packages.type is set to application. Version of the store application customization package to install, such as 1.0.2 or 2.3. |
requested_customized_version | Only applicable when packages.type is set to application. Version of the store application customization package to install, such as 1.0.2 or 2.3. Default: None. If this is not set, then the system does not look for customizations for the application. |
requested_version | Required if type is set to application; ignored if set to plugin. Version of the package to install, such as 1.0.2 or 2.3. |
type | Required. Type of package. Valid values:
|
url : String
(optional)
useFile : boolean
(optional)
Default: false
snBatchRollback
credentialsId : String
(optional)
apiVersion : String
(optional)
rollbackId : String
(optional)
sys_id
) of the rollback installed before.
url : String
(optional)
If ServiceNow Parameters are used, then the URL of installation instance will be used.
greet
apiKey
class hudson.util.Secret
appType : String
appPath : String
packageName : String
scanTimeout : String
severityThreshold : String
$class: 'BeaglePlugin'
apptoken
class hudson.util.Secret
accesstoken
class hudson.util.Secret
$class: 'BeakerBuilder'
jobSource
$class: 'FileJobSource'
jobPath : String
$class: 'StringJobSource'
jobContent : String
downloadFiles : boolean
$class: 'BeginAnalysis'
logLevel
OFF
, INFO
, DEBUG
, WARN
, ERROR
buildSessionId : String
appName : String
moduleName : String
branch : String
enableMultipleBuildFiles : boolean
overrideJars : boolean
multipleBuildFiles : boolean
labId : String
testStage : String
packagesIncluded : String
packagesExcluded : String
filesIncluded : String
filesExcluded : String
classLoadersExcluded : String
recursive : boolean
workspacepath : String
buildScannerJar : String
testListenerJar : String
testListenerConfigFile : String
autoRestoreBuildFile : boolean
sealightsMavenPluginInstallationArguments : String
buildFilesPatterns : String
buildFilesFolders : String
logEnabled : boolean
logDestination
CONSOLE
, FILE
logFolder : String
buildStrategy
ONE_BUILD
, BUILD_EACH_MODULE
slMvnPluginVersion : String
buildName
$class: 'DefaultBuildName'
$class: 'EmptyBuildName'
$class: 'LatestBuildName'
$class: 'ManualBuildName'
insertedBuildName : String
$class: 'UpstreamBuildName'
upstreamProjectName : String
executionType
FULL
, TESTS_ONLY
, ONLY_LISTENER
override_customerId : String
override_url : String
override_proxy : String
additionalArguments : String
Argument name | Description |
---|---|
token | The token provided to you by SeaLights (override the global 'token' value for this build). |
tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
buildsessionidfile | Set build session id file for this build. |
createbuildsessionid | When set to 'true' - forces SeaLights Maven Plugin to create new build session id (true by default). |
proxy | A valid URL to a proxy server. |
agentpath | Override the path to SeaLights jar. |
javapath | Override the path to the 'java' variable (default is 'java'). |
filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
sealightsJvmParams | Key value pairs of environments variables which will be added to both buildscanner and test listener ('$$$'- separated pairs, ':'- separated key and value. i.e: sealightsJvmParams=param:value$$$anotherparam:anothervalue) |
buildScannerParams | Key value pairs of environments variables which will be added to buildscanner ('$$$'- separated pairs, ':'- separated key and value. i.e: buildScannerParams=param:value$$$anotherparam:anothervalue) |
testListenerJvmParams | Key value pairs of environments variables which will be added to test listener ('$$$'- separated pairs, ':'- separated key and value i.e: testListenerJvmParams=param:value$$$anotherparam:anothervalue) |
includeResources : boolean
benchmark
filepath : String
$class: 'BitbucketPublisher'
serverUrl : String
(optional)
credentialsId : String
(optional)
projectKey : String
(optional)
createProject
(optional)
projectName : String
projectUsers : String
projectGroups : String
createJenkinsJobs
(optional)
ciServer : String
projectName : String
(optional)
$class: 'BladeBuilder'
blades
$class: 'CodeScan'
source : String
exclude : String
noCache : boolean
noProxy : boolean
noBlame : boolean
ruleset : String
severityLevel : String
severityThreshold : int
autoUpdate : boolean
(optional)
credentialsId : String
(optional)
debug : boolean
(optional)
directory : String
(optional)
environment : String
(optional)
forceVersion : String
(optional)
ignoreFailure : boolean
(optional)
onFailureCmd : String
(optional)
timeout : int
(optional)
$class: 'ImageScan'
image : String
exclude : String
noCache : boolean
noProxy : boolean
noBlame : boolean
ruleset : String
severityLevel : String
severityThreshold : int
autoUpdate : boolean
(optional)
credentialsId : String
(optional)
debug : boolean
(optional)
directory : String
(optional)
environment : String
(optional)
forceVersion : String
(optional)
ignoreFailure : boolean
(optional)
onFailureCmd : String
(optional)
timeout : int
(optional)
$class: 'BlueprintLaunch'
projectName : String
Project selection is mandatory.
blueprintName : String
Blueprint selection is mandatory.
applicationName : String
Application Name is mandatory.
This is the Application name used for blueprint launch in Nutanix Calm. Appending the _${BUILD_ID} to the Application name is recommended for unique application names. Other Jenkins Environment Variables may also be used.
appProfileName : String
Application Profile selection is mandatory.
actionName : String
The field is mandatory
Select the required action need to run after the application launch from the list of actions, else please select none.
runtimeVariables : String
Click on Fetch Runtime Variables to fetch all editable variables for the selected Application Profile in JSON format. Modify the key values from the defaults as needed.The values can also reference jenkins environment variables.
waitForSuccessFulLaunch : boolean
blueprintDescription : String
Description is fetched from the selected Calm blueprint
BMC DevOps for CFA Plugin
server : String
port : String
user : String
jclContent : String
chkfreq : String
jobCard : String
acctno : String
thresh : String
sortby : String
pswd : String
prilog : String
cfaLoadLibs
lib : String
cfaSldsLibs
sldsname : String
sldsver : String
sldsunit : String
sldsvolser : String
cfaDliLibs
dliname : String
dliver : String
dliunit : String
dlivolser : String
cfaJobnames
jobname : String
cfaReconSets
recon1 : String
recon2 : String
recon3 : String
goodRC : String
bmcSlds : boolean
You can use the SLDS keyword on the ANALYZE control statement to identify explicitly an input log data set to use as input to the analysis process. SLDS=(dataSetName,Rvr, unit,volser) If you want CFA to read multiple log data sets, specify multiple instances of the SLDS keyword.
Example: IMSA is an IMS version 14.1 system and creates generations of SLDSs that use the naming convention imsid.SLDS.Ddate.GENnnn. The SLDSs are cataloged. To analyze log records that IMSA wrote to generations 10 through 12 on March 29, 2015, specify the following keywords on the ANALYZE control statement:
SLDS=(IMSA.SLDS.D2008088.GEN010, R141)
SLDS=(IMSA.SLDS.D2008088.GEN011, R141)
SLDS=(IMSA.SLDS.D2008088.GEN012, R141)
bmcDb2log : boolean
You can use the DB2LOG keyword on the ANALYZE control statement to identify a DB2 log data set that was created by a DB2 subsystem.
Note: If you specify the DB2LOG keyword, do not specify the DB2BSDS keyword.
db2log : String
db2bsds : String
limit : String
skip : String
maxlogs : String
If you specify a value from 1 through 999, Log Analyzer stops reading log data sets after it reaches the specified number of log data sets. If Log Analyzer does not read other log data sets because the specified limit was reached, a warning message indicates the number of log data sets that were not read.
If you want Log Analyzer to read all log data sets, specify MAXLOGS=999.
The default is MAXLOGS=100 (Log Analyzer reads a maximum of 100 log data sets).
bmcDb2bsds : boolean
You can use the DB2BSDS keyword on the ANALYZE control statement to identify a DB2 bootstrap data set (BSDS).
Specify the fully qualified data set name. This name should refer to a VSAM key-sequenced data set (KSDS).
Do not specify the name of a BSDS archive copy, which is not a VSAM KSDS. BSDS cannot be a TAPE dataset.
Note:
bmcLimit : boolean
You can use the LIMIT keyword (or the LIM abbreviation) on the ANALYZE control statement to set a limit on the number (1 through 9999999999) of log records to process from an input log data set.
Note:
bmcSkip : boolean
You can use the SKIP keyword on the ANALYZE control statement to specify a number (1 through 9999999999) of log records in an input log data set to skip before CFA begins to process records.
The default is SKIP=0, which skips no records.
Note:
If you specify the SKIP keyword, you must specify one SLDS keyword. The SLDS keyword is required, and multiple SLDS keywords are not allowed.
bmcActiveOlds : boolean
bmcImsid : boolean
You can use the IMSID keyword on the ANALYZE control statement to specify one or more IMSIDs.
If you do not check this option,then the the default IMSID=ALL will be taken and all log records for all IMS systems that are associated with the input RECON data set (or data sets) will be considered.
Note:
If you specify the SLDS keyword, you cannot specify the IMSID keyword. The IMSID keyword applies only if CFA is reading RECON data sets to determine which log data sets to process.
bmcDlilog : boolean
You can use the DLILOG keyword on the ANALYZE control statement to identify explicitly an input dli log data set to use as input to the analysis process.
Specify the keyword values as follows:
DLILOG=(dataSetName,Rnn)
DLILOG=(dataSetName,Rvr,unit,volser)
Notes:
bmcMaxlogs : boolean
Use this keyword when you are using implicit specification of log data sets and Log Analyzer is reading RECON data sets to determine which log data sets to process. In this case, the number of log data sets to be processed is unknown. The MAXLOGS keyword can help you prevent a problem that could result from processing an excessive number of log data sets.
The MAXLOGS keyword works differently, depending on how you specify the value:
bmcJobname : boolean
You can use the JOBNAME keyword on the ANALYZE control statement to specify one or more JOBNAMEs. Each JOBNAME (one to eight characters) identifies a Job name. Log Analyzer uses the JOBNAME when determining which dli log data sets to use as input.
To process log records for all Job names that are associated with the input RECON data set (or data sets), specify JOBNAME=ALL.
If you omit the JOBNAME sub-keyword, Log Analyzer uses the default value ALL.
Note:
cfaImsids
imsid : String
bmcRecon : boolean
You can use the RECON keyword on the ANALYZE control statement to specify the names of a set of RECON data sets to examine during the CFA job.
If you want CFA to examine multiple sets of RECON data sets, you must specify each set with a separate RECON keyword.
If you specify the RECON keyword, your user ID must have Security Access Facility (SAF) READ access to the RECON data sets.
You can specify from one to three data set names. One of the specified data set names must be designated as COPY1 by IMS.
Example:
The RECON data sets for the IMSA system are named IMSA.RECON1 and IMSA.RECON2, and the RECON data sets for the IMSB system are named IMSB.RECON1 and IMSB.RECON2. To examine IMSA and IMSB RECON data sets in the CFA job, specify the following keywords on the ANALYZE control statement:
RECON=(IMSA.RECON1, IMSA.RECON2)
RECON=(IMSB.RECON1, IMSB.RECON2)
Note:
If you specify the RECON keyword, you must specify the INTERVAL control statement with a START time value and a STOP time value.
bmcTimezone : boolean
bmcStartInterval : boolean
You can use the START keyword on the INTERVAL control statement for the following purposes:
bmcStopInterval : boolean
You can use the STOP keyword on the INTERVAL control statement for the following purposes:
� Specify the end of a range of log records to identify as candidates for the record selection process
� Control the end of range of log data sets to allocate from RECON information
� Reduce the overall number of log records that are selected from input SLDS or extract files
start
value : String
startDate : String
startlogSeq : String
stop
value : String
stopDate : String
stoplogSeq : String
tz
value : String
timezoneoffset : String
jobInclude : String
jobExclude : String
psbInclude : String
psbExclude : String
maxlogsRc : String
If you specify a value from 1 through 999 followed by literal R and a return code (08 through 99), Log Analyzer issues the specified return code and terminates the job step if more than the specified number of log data sets would be read. Log Analyzer issues the return code at the conclusion of the RECON analysis phase without reading any input log data sets.
Example:
If you want Log Analyzer to issue return code 16 and terminate the job step if more than 10 log data sets would be read, specify the following keyword on the ANALYZE control statement:
MAXLOGS=(10,R16)
maxlogsAbend : String
If you specify a value from 1 through 999 followed by an abend code (1 through 4095), Log Analyzer issues a user abend code and terminates the job step if more than the specified number of log data sets would be read. Log Analyzer issues the user abend at the conclusion of the RECON analysis phase without reading any input log data sets.
Example:
If you want Log Analyzer to issue a user abend, with abend code U4000, if more than 120 log data sets would be read, specify the following keyword on the ANALYZE control statement:
MAXLOGS=(120,4000)
bmcJobInc : boolean
bmcJobExc : boolean
bmcPsbInc : boolean
bmcPsbExc : boolean
bmcChkfreq : boolean
bmcThresh : boolean
bmcPrilog : boolean
You can use the PRILOG keyword on the ANALYZE control statement to specify the logs type associated with the input RECON data set (or data sets) to use as input to the analysis process.
You can select one of the following values:
bmcAppcheck : boolean
bmcAll : boolean
bmcLsec : boolean
chkfreqval : String
bmcPlanInc : boolean
planInclude : String
bmcPlanExc : boolean
planExclude : String
bmcSortby : boolean
bmcCsv : boolean
bmcFullreport : boolean
BMC DevOps for BMC AMI Change Manager for IMS TM Plugin
server : String
port : String
user : String
pswd : String
jclContent : String
jclType : String
dlist : String
jobCard : String
acctno : String
dPds : String
dOptionsPds : String
Specify the name of the data set where the BMC AMI Change Manager for IMS TM Global Options load module (DLP$GBL0) should be stored or retrieved.
It is recommended that you use the same data set that contains the IMSID options modules (DLP#iiii), and Group options modules (DLPZgggg).
This data set should have been created during BMC AMI Change Manager for IMS TM installation. JCL to allocate this data set is included in the BMC AMI Change Manager for IMS TM control library.
target : String
mode : String
Note: You must select this option for a DELTA List that is defined as Dependent to execute in the fashion Dependent implies.
Option 'One element at a time', instructs BMC AMI Change Manager for IMS TM to execute the DELTA List sequentially, one element at a time. This mode is much slower than Optimize execution mode. However, there are certain occasions when one element at a time is desirable. For example, transactions T1, T2 and T3 all require the MAXRGN parameter be changed from 3 to 4. Since they must be stopped before they can be revised, you want them stopped for the shortest amount of time possible. With Optimized mode, ALL the /STOP commands are done BEFORE the DELTA revise is done, and ALL the /START commands are done AFTER the revise is done. Using 'One element at a time' mode, the /STOP is done for T1, T1 is revised, then the /START command for T1 is issued before any activity takes place for T2 or T3.
This mode contains suboption Pause after elements with errors which instructs BMC AMI Change Manager for IMS TM to stop the DELTA List execution when an error is encountered. For additional information on the Pause option, place the cursor on the phrase highlighted above, and press HELP (F1).
ims_cmd : String
It will process an EXECUTE input record to insert an IMS Command Element into the Delta List PDS Member.
The EXECUTE input record format is as follows: EXECUTE /CMD Command_Parameters
e.g.: EXECUTE /STO PROG PGMD
title : String
notes : String
dlistRecords
action : String
elementType : String
elementName : String
ims_cmd : String
appnewname : String
appres : String
dbnewname : String
dbres : String
acc : String
auto : String
rand : String
randonly : String
rldareas : String
iovfext : String
dbrelgsam : String
dbcopyacb : String
apprelgsam : String
appcopyacb : String
ty : String
schd : String
appfp : String
dyn : String
gpsb : String
lang : String
apptls : String
rtcnewname : String
rtcinq : String
rtcpsbname : String
psb : String
trannewname : String
wfi : String
npri : String
lpri : String
lco : String
mseg : String
resp : String
cl : String
plc : String
time : String
para : String
uschd : String
traninq : String
recv : String
tranfp : String
emhs : String
mper : String
uc : String
edit : String
lsid : String
rsid : String
spa : String
spad : String
segs : String
oseg : String
msc : String
dc : String
mreg : String
ser : String
aoi : String
trantls : String
exptm : String
terminalmask : String
terminalnewname : String
sign : String
ltermmask : String
ltermnewname : String
ass : String
msn : String
l61 : String
subpoolmask : String
subpoolnewname : String
msg : String
bmcAppNew : boolean
bmcAppRes : boolean
bmcDbNewname : boolean
bmcDbRes : boolean
bmcAcc : boolean
bmcAuto : boolean
bmcRand : boolean
bmcRandOnly : boolean
bmcRldAreas : boolean
bmcIoVfExt : boolean
bmcDbCopyAcb : boolean
bmcDbRelGsam : boolean
bmcAppCopyAcb : boolean
bmcAppRelGsam : boolean
bmcTy : boolean
bmcSchd : boolean
bmcAppFp : boolean
bmcDyn : boolean
bmcGpsb : boolean
bmcLang : boolean
bmcApptls : boolean
bmcRtcsPsbName : boolean
bmcRtcInq : boolean
bmcRtcsNew : boolean
bmcPsb : boolean
bmcTranNewName : boolean
bmcWfi : boolean
bmcNpri : boolean
bmcLpri : boolean
bmcLco : boolean
bmcMseg : boolean
bmcResp : boolean
bmcCl : boolean
bmcPlc : boolean
bmcTime : boolean
bmcPara : boolean
bmcUschd : boolean
bmcTranInq : boolean
bmcRecv : boolean
bmcTranFp : boolean
bmcEmhs : boolean
bmcMper : boolean
bmcUc : boolean
bmcEdit : boolean
bmcLsid : boolean
bmcRsid : boolean
bmcSpa : boolean
bmcSpad : boolean
bmcSegs : boolean
bmcOseg : boolean
bmcMsc : boolean
bmcDc : boolean
bmcMreg : boolean
bmcSer : boolean
bmcAoi : boolean
bmcTls : boolean
bmcExptm : boolean
bmcTermMask : boolean
bmcTermNew : boolean
bmcSign : boolean
bmcLtermMask : boolean
bmcLtermNew : boolean
bmcAss : boolean
bmcMsn : boolean
bmcL61 : boolean
bmcSpMask : boolean
bmcSpNewName : boolean
bmcMsg : boolean
dlpLoadLibs
lib : String
vds : String
goodRC : String
dependent : boolean
mark : boolean
Select this field to inform BMC AMI Change Manager for IMS TM to execute Marked elements only.
A beneficial use of this function is a DELTA List containing many elements that has failed. Instead of creating another DELTA List that contains corrections for the failed element(s) from the previous DELTA List, simply correct the error(s) in the original DELTA List, Mark only those elements which require execution, and select the 'Execute Marked elements only' option at DELTA List execution.
coord : boolean
$class: 'BootPluginBuilder'
tasks : String
jvmOpts : String
$class: 'BranchDestructionStep'
project : String
branch : String
$class: 'BranchGenerationStep'
projectConfig
pipelineConfig
destructor : boolean
authorisations : String
branchSCMParameter : boolean
branchParameters : String
generationExtension : String
pipelineGenerationExtension : String
disableDslScript : boolean
scriptDirectory : String
namingStrategy
projectFolderPath : String
branchFolderPath : String
projectSeedName : String
projectDestructorName : String
branchSeedName : String
branchStartName : String
branchName : String
ignoredBranchPrefixes : String
eventStrategy
delete : boolean
auto : boolean
trigger : boolean
commit : String
project : String
scmType : String
scmUrl : String
scmCredentials : String
triggerIdentifier : String
triggerType : String
triggerSecret : String
dotnetBuild
dotnet build
command builds the project and its dependencies into a set of binaries. The binaries include the project's code in Intermediate Language (IL) files with a .dll extension. Depending on the project type and settings, other files may be included, such as:
charset : String
(optional)
configuration : String
(optional)
Debug
, but you can override the build configuration settings in your project.
continueOnError : boolean
(optional)
FAILURE
(or UNSTABLE
, if configured that way), but the build will be allowed to continue. Otherwise, any such errors will cause the build to be terminated immediately.
force : boolean
(optional)
framework : String
(optional)
noDependencies : boolean
(optional)
noIncremental : boolean
(optional)
noRestore : boolean
(optional)
nologo : boolean
(optional)
option : String
(optional)
options : Array / List of String
(optional)
optionsString : String
(optional)
outputDirectory : String
(optional)
./bin/<configuration>/<framework>/
. For projects with multiple target frameworks (via the TargetFrameworks
property), you also need to specify a specific framework when you specify this option.
project : String
(optional)
properties
(optional)
java.util.Map<java.lang.String, java.lang.String>
propertiesString : String
(optional)
runtime : String
(optional)
sdk : String
(optional)
dotnet
will be in the path.
With .NETelement (or a
withDotNet
block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
showSdkInfo : boolean
(optional)
dotnet --info
will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
shutDownBuildServers : boolean
(optional)
dotnet build-server shutdown
will be executed after the main command, shutting down build servers that may have been started.
hanguntil those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
specificSdkVersion : boolean
(optional)
dotnet
executable may use the most recent SDK available on the system, even when PATH
is set up to find an older SDK deployment first; see this page for more information.
global.json
file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json
already present in the current directory.
target : String
(optional)
targets : Array / List of String
(optional)
targetsString : String
(optional)
unstableIfErrors : boolean
(optional)
unstableIfWarnings : boolean
(optional)
verbosity : String
(optional)
versionSuffix : String
(optional)
$(VersionSuffix)
property to use when building the project. This only works if the $(Version)
property isn't set. Then, $(Version)
is set to the $(VersionPrefix)
combined with the $(VersionSuffix)
, separated by a dash.
workDirectory : String
(optional)
reportBuild
applicationName : String
(optional)
applicationVersion : String
(optional)
applicationComponent : String
(optional)
artifactFileName : String
(optional)
artifactFileSizeLimit : int
(optional)
buildAddUrl
title : String
url : String
$class: 'BuildBuilder'
dbFolder
value
vcsroot
, subfolder
, scaproject
subfolder : String
projectPath : String
packageid : String
tempServer
value : String
serverName : String
dbName : String
serverAuth
value : String
username : String
password
class hudson.util.Secret
encryptConnection : boolean
trustServerCertificate : boolean
options : String
dataOptions : String
transactionIsolationLevel
Serializable
, Snapshot
, RepeatableRead
, ReadCommitted
, ReadUncommitted
filter : String
packageVersion : String
dlmDashboard
dlmDashboardHost : String
dlmDashboardPort : String
sqlChangeAutomationVersionOption
value
Latest
, Specific
specificVersion : String
buildDescription
descriptionTemplate : String
buildName
nameTemplate : String
$class: 'BuildNameUpdater'
fromFile : boolean
buildName : String
fromMacro : boolean
macroTemplate : String
macroFirst : boolean
crxBuild
packageId : String
(optional)
baseUrl : String
(optional)
username[:password]@
between the scheme and the hostname.
credentialsId : String
(optional)
/$username/keys/$fingerprint
.
download : boolean
(optional)
localDirectory : String
(optional)
requestTimeout : long
(optional)
serviceTimeout : long
(optional)
waitDelay : long
(optional)
wspFilter : String
(optional)
/etc # define /etc as the filter root +/etc(/.*)? # include everything under /etc -/etc/packages(/.)? # exclude package pathsTo create a package for a project "acme" defined in CRX DE Lite, a filter may look like this:
/content/acme # include the site content /apps/acme # include the app codeThis field supports parameter tokens.
$class: 'BuildScanner'
profile : String
target : String
repTemp : String
threat : String
stopScan : boolean
svRep : boolean
incScan : boolean
incScanId : String
stopTargetScans : boolean
$class: 'BuildStepBuilder'
sourceFolderMode : String
subfolder : String
packageId : String
serverType : String
server : String
authenticationType : String
userName : String
password
class hudson.util.Secret
database : String
compareOptions : String
(optional)
filterFile : String
(optional)
transactionIsoLvl : String
(optional)
$class: 'BuildStepWithTimeout'
buildStep : Build Step (hudson.tasks.BuildStep
)
strategy
$class: 'AbsoluteTimeOutStrategy'
Terminate a build based on a fixed time-out period.
timeoutMinutes : String
$class: 'DeadlineTimeOutStrategy'
Terminate a build based on a deadline time specified in HH:MM:SS or HH:MM (24-hour time format).
deadlineTime : String
deadlineToleranceInMinutes : int
$class: 'ElasticTimeOutStrategy'
Terminate a build based on a specified percentage of the mean of the duration of the n most recent non-failing builds.
timeoutPercentage : String
timeoutMinutesElasticDefault : String
numberOfBuilds : String
failSafeTimeoutDuration : boolean
$class: 'LikelyStuckTimeOutStrategy'
Terminate a build when it has taken many times longer than previous ones.
$class: 'NoActivityTimeOutStrategy'
timeoutSecondsString : String
$class: 'RunConditionTimeoutStrategy'
This extension uses run condition as condition sources.
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
timeout : long
defaultTimeout : long
operationList
$class: 'AbortAndRestartOperation'
maxRestarts : String
$class: 'AbortOperation'
$class: 'BuildStepOperation'
buildstep : Build Step (hudson.tasks.BuildStep
)
continueEvenFailed : boolean
createLauncher : boolean
$class: 'FailOperation'
$class: 'WriteDescriptionOperation'
description : String
$class: 'BuildStepsFromJsonBuilder'
$class: 'BuildoutBuilder'
pythonName : String
buildoutCfg : String
nature : String
command : String
ignoreExitCode : boolean
byteguardGreet
token : String
task_id : String
$class: 'CFLaunchBuilder'
cfComposition : String
setCFVars
vars
Variable : String
Value : String
$class: 'CIMessageBuilder'
providerData
(optional)
activeMQPublisher
failOnError : boolean
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
messageContent : String
(optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
messageProperties : String
(optional)
KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
messageType
(optional)
Type of CI message to be sent.
CodeQualityChecksDone
, ComponentBuildDone
, Custom
, EarlyPerformanceTestingDone
, EarlySecurityTestingDone
, ImageUploaded
, FunctionalTestCoverageDone
, FunctionalTestingDone
, NonfunctionalTestingDone
, OotbTestingDone
, PeerReviewDone
, ProductAcceptedForReleaseTesting
, ProductBuildDone
, ProductBuildInStaging
, ProductTestCoverageDone
, PullRequest
, SecurityChecksDone
, TestingStarted
, TestingCompleted
, Tier0TestingDone
, Tier1TestingDone
, Tier2IntegrationTestingDone
, Tier2ValidationTestingDone
, Tier3TestingDone
, UnitTestCoverageDone
, UpdateDefectStatus
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
activeMQSubscriber
checks
(optional)
field : String
expectedValue : String
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
selector : String
(optional)
JMS selector to choose messages that will fire the trigger.
timeout : int
(optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
variable : String
(optional)
Environment variable to hold received message content.
fedmsgPublisher
failOnError : boolean
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
messageContent : String
(optional)
Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
fedmsgSubscriber
checks
(optional)
field : String
expectedValue : String
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
timeout : int
(optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
variable : String
(optional)
Environment variable to hold received message content.
rabbitMQPublisher
failOnError : boolean
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
fedoraMessaging : boolean
(optional)
messageContent : String
(optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
schema : String
(optional)
Path to message schema.
severity : int
(optional)
Severity of the message.
rabbitMQSubscriber
checks
(optional)
field : String
expectedValue : String
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
timeout : int
(optional)
Value (in minutes) to wait for a message.
variable : String
(optional)
Environment variable to hold received message content.
$class: 'CIMessageSubscriberBuilder'
Subscribe to the CI message bus and wait for a message matching the specified JMS selector.
The variable value specifies the name of an environment variable in which to place the received message body.
The timeout value specifies the maximum number of minutes to wait for a message matching the JMS selector to appear.
providerData
(optional)
activeMQPublisher
failOnError : boolean
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
messageContent : String
(optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
messageProperties : String
(optional)
KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
messageType
(optional)
Type of CI message to be sent.
CodeQualityChecksDone
, ComponentBuildDone
, Custom
, EarlyPerformanceTestingDone
, EarlySecurityTestingDone
, ImageUploaded
, FunctionalTestCoverageDone
, FunctionalTestingDone
, NonfunctionalTestingDone
, OotbTestingDone
, PeerReviewDone
, ProductAcceptedForReleaseTesting
, ProductBuildDone
, ProductBuildInStaging
, ProductTestCoverageDone
, PullRequest
, SecurityChecksDone
, TestingStarted
, TestingCompleted
, Tier0TestingDone
, Tier1TestingDone
, Tier2IntegrationTestingDone
, Tier2ValidationTestingDone
, Tier3TestingDone
, UnitTestCoverageDone
, UpdateDefectStatus
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
activeMQSubscriber
checks
(optional)
field : String
expectedValue : String
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
selector : String
(optional)
JMS selector to choose messages that will fire the trigger.
timeout : int
(optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
variable : String
(optional)
Environment variable to hold received message content.
fedmsgPublisher
failOnError : boolean
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
messageContent : String
(optional)
Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
fedmsgSubscriber
checks
(optional)
field : String
expectedValue : String
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
timeout : int
(optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
variable : String
(optional)
Environment variable to hold received message content.
rabbitMQPublisher
failOnError : boolean
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
fedoraMessaging : boolean
(optional)
messageContent : String
(optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
schema : String
(optional)
Path to message schema.
severity : int
(optional)
Severity of the message.
rabbitMQSubscriber
checks
(optional)
field : String
expectedValue : String
name : String
(optional)
overrides
(optional)
topic : String
(optional)
queue : String
(optional)
timeout : int
(optional)
Value (in minutes) to wait for a message.
variable : String
(optional)
Environment variable to hold received message content.
$class: 'CRDABuilder'
file : String
(optional)
consentTelemetry : boolean
(optional)
CRDA CLI is constantly improving and we would like to know more about usage. Click here to find more details.
execMan
requestType : String
(optional)
altCTMConfig
(optional)
url : String
credentials : String
execParams
(optional)
list
(optional)
key : String
value : String
postExecute
(optional)
action : String
params : String
request
(optional)
name : String
waitConfig
(optional)
pollInterval : String
maxRunTime : String
$class: 'CToolBuilder'
cmake -P <script file>
) or command mode (cmake -E <command>
).
installationName : String
arguments : String
(optional)
ignoredExitCodes : String
(optional)
toolId : String
(optional)
workingDir : String
(optional)
generateCache
caches
type
A2L
, ELF
, BUS
, MODEL
, SERVICE
filePath : String
dbChannel : String
clear : boolean
$class: 'CallFunction'
functionName : String
(optional)
argumentList : Array / List of String
(optional)
argument : String
(optional)
$class: 'CallOtherJenkinsBuilder'
hostName : String
jobName : String
span : String
retry : String
userName : String
password : String
parameters : String
$class: 'CaptureIOSDeviceScreenshot'
url : String
cloudTestServerID : String
additionalOptions : String
carbonetes
name : String
credentialsId : String
(optional)
engineTimeout : int
(optional)
failBuildOnPluginError : boolean
(optional)
failBuildOnPolicyEvaluationFailResult : boolean
(optional)
image : String
(optional)
policyBundleID : String
(optional)
registryURI : String
(optional)
carl
installationName : String
sourcePath : String
applicationName : String
archivePdf : boolean
(optional)
displayLog : boolean
(optional)
logPath : String
(optional)
outputPath : String
(optional)
qualityGate : String
(optional)
venafiVcertRequestCertificate
connectorName : String
zoneConfigName : String
The name of the zone configuration to use.
When using Venafi as a Service, zone names are in the format of app name\api alias
commonName : String
privKeyOutput : String
certOutput : String
certChainOutput : String
country : String
(optional)
dnsNames
(optional)
hostName : String
emailAddresses
(optional)
address : String
expirationWindow : int
(optional)
ipAddresses
(optional)
address : String
keyType
(optional)
RSA
, ECDSA
locality : String
(optional)
organization : String
(optional)
organizationalUnit : String
(optional)
province : String
(optional)
changeAsmVer
versionPattern : String
assemblyCompany : String
(optional)
assemblyCopyright : String
(optional)
assemblyCulture : String
(optional)
assemblyDescription : String
(optional)
assemblyFile : String
(optional)
assemblyProduct : String
(optional)
assemblyTitle : String
(optional)
assemblyTrademark : String
(optional)
regexPattern : String
(optional)
replacementPattern : String
(optional)
$class: 'ChangeEventBuilder'
integrationKey : String
customDetails : String
(optional)
summaryText : String
(optional)
chatterPost
postToChatter "Build Started - ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"
credentialsId : String
If you're connecting from outside of your organizations trusted network, you'll also need to append your API security token to your password.
See Identity Confirmation in the salesforce.com online help for more information.
body : String
buildUrlTitle : String
(optional)
recordId : String
(optional)
server : String
(optional)
$class: 'CheckGate'
pipelineId : String
stageName : String
versionId : String
fatal : String
$class: 'CheckGateBuilder'
project : String
gate : String
checkmarxASTScanner
useOwnServerCredentials : boolean
(optional)
serverUrl : String
(optional)
useAuthenticationUrl : boolean
(optional)
baseAuthUrl : String
(optional)
tenantName : String
(optional)
projectName : String
(optional)
credentialsId : String
(optional)
useOwnAdditionalOptions : boolean
(optional)
additionalOptions : String
(optional)
branchName : String
(optional)
checkmarxInstallation : String
(optional)
chlAtuoAction
content : String
browserString : String
runScriptOnly : boolean
rootPath : String
libPath : String
$class: 'ChrootBuilder'
chrootName : String
ignoreExit : boolean
additionalPackages : String
packagesFile : String
clear : boolean
command : String
loginAsRoot : boolean
noUpdate : boolean
forceInstall : boolean
$class: 'CifsBuilderPlugin'
publishers
configName : String
verbose : boolean
transfers
sourceFiles : String
excludes : String
remoteDirectory : String
removePrefix : String
remoteDirectorySDF : boolean
flatten : boolean
cleanRemote : boolean
noDefaultExcludes : boolean
makeEmptyDirs : boolean
patternSeparator : String
useWorkspaceInPromotion : boolean
usePromotionTimestamp : boolean
retry
retries : int
retryDelay : long
label
label : String
continueOnError : boolean
failOnError : boolean
alwaysPublishFromMaster : boolean
masterNodeName : String
paramPublish
parameterName : String
$class: 'ClangScanBuildBuilder'
target : String
targetSdk : String
xcodebuild -showsdks
config : String
clangInstallationName : String
xcodeProjectSubPath : String
workspace : String
scheme : String
scanbuildargs : String
xcodebuildargs : String
outputFolderName : String
googleStorageUpload
credentialsId : String
bucket : String
pattern : String
pathPrefix : String
(optional)
sharedPublicly : boolean
(optional)
showInline : boolean
(optional)
dotnetClean
dotnet clean
command cleans the output of the previous build. It's implemented as an MSBuild target, so the project is evaluated when the command is run. Only the outputs created during the build are cleaned. Both intermediate (obj) and final output (bin) folders are cleaned.
charset : String
(optional)
configuration : String
(optional)
Debug
, but you can override the build configuration settings in your project. This option is only required when cleaning if you specified it during build time.
continueOnError : boolean
(optional)
FAILURE
(or UNSTABLE
, if configured that way), but the build will be allowed to continue. Otherwise, any such errors will cause the build to be terminated immediately.
framework : String
(optional)
nologo : boolean
(optional)
option : String
(optional)
options : Array / List of String
(optional)
optionsString : String
(optional)
outputDirectory : String
(optional)
project : String
(optional)
properties
(optional)
java.util.Map<java.lang.String, java.lang.String>
propertiesString : String
(optional)
runtime : String
(optional)
sdk : String
(optional)
dotnet
will be in the path.
With .NETelement (or a
withDotNet
block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
showSdkInfo : boolean
(optional)
dotnet --info
will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
shutDownBuildServers : boolean
(optional)
dotnet build-server shutdown
will be executed after the main command, shutting down build servers that may have been started.
hanguntil those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
specificSdkVersion : boolean
(optional)
dotnet
executable may use the most recent SDK available on the system, even when PATH
is set up to find an older SDK deployment first; see this page for more information.
global.json
file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json
already present in the current directory.
unstableIfErrors : boolean
(optional)
unstableIfWarnings : boolean
(optional)
verbosity : String
(optional)
workDirectory : String
(optional)
cleanPerformanceMeasurement
cleanMeasurement : boolean
(optional)
cleanRCA : boolean
(optional)
cleanRTS : boolean
(optional)
examCleanTarget
validNetwork
username : String
password : String
projectId : String
filepath : String
$class: 'ClifBuilder'
clifName : String
clifOpts : String
testPlanFile : String
reportDir : String
$class: 'CloudBuildBuilder'
input
credentialsId : String
request
file
filename : String
inline
request : String
source
(optional)
local
path : String
.tgz
or .tar.gz
) or zip file (.zip
), or.tgz
) and uploaded to a temporary Cloud Storage bucket.repo
branch : String
(optional)
commit : String
(optional)
projectId : String
(optional)
repoName : String
(optional)
tag : String
(optional)
storage
bucket : String
object : String
substitutionList
(optional)
items
key : String
_
) and use only numbers, uppercase letters, and underscores (respecting the regular expression _[A-Z0-9_]+
). The key may not be longer than 100 characters. For details, see Build Requests - User-defined substitutions.
value : String
substitutions
(optional)
java.util.Map<java.lang.String, java.lang.String>
pushToCloudFoundry
target : String
organization : String
cloudSpace : String
credentialsId : String
manifestChoice
(optional)
appName : String
(optional)
appPath : String
(optional)
buildpack : String
(optional)
command : String
(optional)
domain : String
(optional)
envVars
(optional)
key : String
value : String
hostname : String
(optional)
instances : String
(optional)
manifestFile : String
(optional)
memory : String
(optional)
noRoute : String
(optional)
servicesNames
(optional)
name : String
stack : String
(optional)
timeout : String
(optional)
value : String
(optional)
pluginTimeout : String
(optional)
selfSigned : String
(optional)
servicesToCreate
(optional)
name : String
type : String
plan : String
resetService : boolean
(optional)
cloudhubDeployer
environmentId : String
orgId : String
appName : String
muleVersion : String
filePath : String
credentialsId : String
(optional)
requestMode
(optional)
CREATE
, UPDATE
, CREATE_OR_UPDATE
, UPDATE_FILE
, RESTART
, DELETE
region : String
(optional)
autoScalePolicy
(optional)
autoScalePolicyName : String
(optional)
enableAutoScalePolicy : boolean
(optional)
id : String
(optional)
maxScale : int
(optional)
minScale : int
(optional)
scaleBasedOn : String
(optional)
scaleDown
(optional)
class org.jenkinsci.plugins.cloudhubdeployer.data.Scale
scaleDownNextScaleWaitMins : int
(optional)
scaleDownPeriodCount : int
(optional)
scaleDownValue : int
(optional)
scaleType : String
(optional)
scaleUp
(optional)
class org.jenkinsci.plugins.cloudhubdeployer.data.Scale
scaleUpNextScaleWaitMins : int
(optional)
scaleUpPeriodCount : int
(optional)
scaleUpValue : int
(optional)
autoStart : boolean
(optional)
debugMode
(optional)
ENABLED
, DISABLED
enableAutoScalePolicy : boolean
(optional)
envVars
(optional)
key : String
(optional)
value : String
(optional)
ignoreGlobalSettings : boolean
(optional)
logLevels
(optional)
levelCategory
(optional)
DEBUG
, WARN
, ERROR
, INFO
packageName : String
(optional)
loggingNgEnabled : boolean
(optional)
monitoringAutoRestart : boolean
(optional)
monitoringEnabled : boolean
(optional)
objectStoreV1 : boolean
(optional)
persistentQueues : boolean
(optional)
persistentQueuesEncrypted : boolean
(optional)
timeoutConnection : int
(optional)
timeoutResponse : int
(optional)
verifyDeployments : boolean
(optional)
verifyIntervalInSeconds : int
(optional)
workerAmount : int
(optional)
workerCpu : String
(optional)
workerMemory : String
(optional)
workerType : String
(optional)
workerWeight : String
(optional)
$class: 'CloudShellConfig'
buildStep
$class: 'StartSandbox'
blueprintName : String
sandboxDuration : String
maxWaitForSandboxAvailability : int
setupTimeout : int
params : String
(optional)
sandboxDomain : String
(optional)
sandboxName : String
(optional)
$class: 'CmakeBuilder'
cmake -G
with the given options.
CMAKE_BUILD_TOOL
build environment variable if the chosen generator supports that.
installationName : String
buildDir : String
(optional)
buildType : String
(optional)
cleanBuild : boolean
(optional)
cmakeArgs : String
(optional)
generator : String
(optional)
preloadScript : String
(optional)
sourceDir : String
(optional)
steps
(optional)
args : String
(optional)
cmake
. Arguments must be separated by spaces but may contain spaces if they are enclosed in double quotes (will be handled like a Unix shell does),
envVars : String
(optional)
DESTDIR=${WORKSPACE}/artifacts/dir
KEY=VALUE
withCmake : boolean
(optional)
$CMAKE_BUILD_TOOL
) or to have cmake
run the build tool (by invoking cmake --build <dir>
).
$class: 'CocoaPodsBuilder'
cleanpods : boolean
$class: 'CodeBuilder'
credentialsType : String
credentialsId : String
proxyHost : String
proxyPort : String
awsAccessKey : String
awsSecretKey
class hudson.util.Secret
awsSessionToken : String
region : String
projectName : String
sourceVersion : String
sseAlgorithm : String
sourceControlType : String
localSourcePath : String
workspaceSubdir : String
gitCloneDepthOverride : String
reportBuildStatusOverride : String
secondarySourcesOverride : String
secondarySourcesVersionOverride : String
artifactTypeOverride : String
artifactLocationOverride : String
artifactNameOverride : String
artifactNamespaceOverride : String
artifactPackagingOverride : String
artifactPathOverride : String
artifactEncryptionDisabledOverride : String
overrideArtifactName : String
secondaryArtifactsOverride : String
envVariables : String
envParameters : String
buildSpecFile : String
buildTimeoutOverride : String
sourceTypeOverride : String
sourceLocationOverride : String
environmentTypeOverride : String
imageOverride : String
computeTypeOverride : String
cacheTypeOverride : String
cacheLocationOverride : String
cacheModesOverride : String
cloudWatchLogsStatusOverride : String
cloudWatchLogsGroupNameOverride : String
cloudWatchLogsStreamNameOverride : String
s3LogsStatusOverride : String
s3LogsEncryptionDisabledOverride : String
s3LogsLocationOverride : String
certificateOverride : String
serviceRoleOverride : String
insecureSslOverride : String
privilegedModeOverride : String
cwlStreamingDisabled : String
exceptionFailureMode : String
downloadArtifacts : String
downloadArtifactsRelativePath : String
workspaceExcludes : String
(optional)
workspaceIncludes : String
(optional)
$class: 'CodeCoverageBuilder'
connectionId : String
credentialsId : String
analysisPropertiesPath : String
analysisProperties : String
codescene
credentialsId : String
deltaAnalysisUrl : String
repository : String
analyzeBranchDiff : boolean
(optional)
analyzeLatestIndividually : boolean
(optional)
baseRevision : String
(optional)
couplingThresholdPercent : int
(optional)
failOnDecliningCodeHealth : boolean
(optional)
failOnFailedGoal : boolean
(optional)
letBuildPassOnFailedAnalysis : boolean
(optional)
markBuildAsUnstable : boolean
(optional)
originUrl : String
(optional)
riskThreshold : int
(optional)
$class: 'CodeStreamBuilder'
serverUrl : String
userName : String
password : String
tenant : String
pipelineName : String
waitExec : boolean
pipelineParams
value : String
name : String
CodeThreatScan
ctServer : String
project_name : String
fileName : String
credentialsId : String
organization_name : String
condition : String
(optional)
maxNumberOfCritical : int
(optional)
maxNumberOfHigh : int
(optional)
weaknessIs : String
(optional)
$class: 'CodefreshPipelineBuilder'
selectPipeline
cfPipeline : String
cfBranch : String
setCFVars
vars
Variable : String
Value : String
$class: 'CommentsRemoverBuilder'
filename : String
language : String
outputDir : String
$class: 'CompareBuilder'
outputFolder : String
Path to the folder in that should be used to store compare output.
It serves as input for following steps like Generate create SQL script or Generate Report.
Folder location must be specified as:
srcInputType : String
tgtInputType : String
srcInputFileOrFolder : String
Specify input folder/file that will be used as source side input for compare. Following inputs are expected.
Folder/file location must be specified as:
tgtInputFileOrFolder : String
Specify input folder/file that will be used as target side input for compare. Following inputs are expected.
Folder/file location must be specified as:
configFile : String
Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
File location must be specified as:
$class: 'CompareWithBaselineBuilder'
outputFolder : String
Path to the folder in that should be used to store baseline compare output.
It serves as input for following steps like Generate create SQL script or Generate Report.
Folder location must be specified as:
srcInputType : String
tgtInputType : String
srcInputFileOrFolder : String
Specify input folder/file that will be used as source side input for baseline compare. Following inputs are expected.
Folder/file location must be specified as:
tgtInputFileOrFolder : String
Specify input folder/file that will be used as target side input for baseline compare. Following inputs are expected.
Folder/file location must be specified as:
configFile : String
Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
File location must be specified as:
$class: 'CompoundBuilder'
$class: 'ConditionalBuilder'
runCondition
$class: 'AlwaysRun'
$class: 'And'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command : String
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
$class: 'BooleanCondition'
token : String
$class: 'CauseCondition'
buildCause : String
exclusiveCause : boolean
$class: 'DayCondition'
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
daySelector
$class: 'SelectDays'
days
day : int
selected : boolean
$class: 'Weekday'
$class: 'Weekend'
$class: 'ExpressionCondition'
expression : String
label : String
$class: 'ExtendedCauseCondition'
condition
$class: 'UpstreamCauseCondition'
projects : String
$class: 'UserBuildCauseCondition'
users : String
exclusiveCause : boolean
$class: 'FileExistsCondition'
file : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'FilesMatchCondition'
includes : String
excludes : String
baseDir
$class: 'ArtifactsDir'
$class: 'JenkinsHome'
$class: 'Workspace'
$class: 'LegacyBuildstepCondition'
condition : String
invert : boolean
$class: 'NeverRun'
$class: 'NodeCondition'
allowedNodes : Array / List of String
$class: 'Not'
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'NumericalComparisonCondition'
lhs : String
rhs : String
comparator
$class: 'EqualTo'
$class: 'GreaterThan'
$class: 'GreaterThanOrEqualTo'
$class: 'LessThan'
$class: 'LessThanOrEqualTo'
$class: 'NotEqualTo'
$class: 'OntrackDSLRunCondition'
ontrackScriptLocation
value : String
scriptPath : String
scriptText : String
sandbox : boolean
injectEnvironment : String
BUILD_NUMBER
) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER
, you can access the BUILD_NUMBER
value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
injectProperties : String
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0 BUILD = ${VERSION}
would inject the corresponding BRANCH
and BUILD
variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value
syntax#
are ignored${VAR}
are expanded using VAR
from the current environment variables.ontrackLog : boolean
$class: 'Or'
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
$class: 'ShellCondition'
command : String
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
$class: 'StatusCondition'
worstResult : String
bestResult : String
$class: 'StringsMatchCondition'
arg1 : String
arg2 : String
ignoreCase : boolean
$class: 'TextFinderCondition'
fileSet : String
regexp : String
checkConsoleOutput : boolean
$class: 'TimeCondition'
earliest : String
latest : String
useBuildTime : boolean
For long running builds, there can be a considerable difference between these two times.
$class: 'VariableExistsCondition'
variableName : String
runner
A run condition evaluation may fail to run cleanly - especially if it is dependent on expanding tokens provided by the Token Macro Plugin and the values are expected to be present or look like a certain type i.e. be a number.
...its about the action to take when the condition can not be evaluated - this is not same as evaluating to false
.
$class: 'DontRun'
$class: 'Fail'
$class: 'Run'
$class: 'RunUnstable'
$class: 'Unstable'
conditionalbuilders : Array / List of Build Step (hudson.tasks.BuildStep
)
$class: 'ConfigFileBuildStep'
managedFiles
fileId : String
Name of the file.
replaceTokens : boolean
(optional)
Decides whether the token should be replaced using macro.
targetLocation : String
(optional)
Name of the file (with optional file relative to workspace directory) where the config file should be copied.
variable : String
(optional)
Name of the variable which can be used as the reference for further configuration.
$class: 'ConfluenceReleaseNotesPublisher'
jiraCredentialsID : String
confluenceCredentialsID : String
spaceKey : String
jqlFilter : String
pageTitle : String
parentPageTitle : String
$class: 'ConsulBuilder'
installationName : String
operationList
$class: 'ConsulGetKV'
valuePath : String
environmentVariableName : String
$class: 'ConsulServiceDiscoveryOperation'
serviceName : String
serviceTag : String
environmentVariableName : String
healthStatus : String
addPort : boolean
$class: 'ConsulSetKV'
valuePath : String
value : String
consulSettingsProfileName : String
$class: 'ConsulKVBuilder'
hostUrl : String
key : String
aclToken : String
(optional)
apiUri : String
(optional)
debugMode
(optional)
ENABLED
, DISABLED
envVarKey : String
(optional)
ignoreGlobalSettings : boolean
(optional)
keyValue : String
(optional)
requestMode
(optional)
READ
, WRITE
, DELETE
timeoutConnection : int
(optional)
timeoutResponse : int
(optional)
assessContainerImage
failOnPluginError : boolean
(optional)
imageId : String
(optional)
nameRules
(optional)
packageName
action : String
contains : String
vulnerabilityCategory
action : String
contains : String
vulnerabilityTitle
action : String
contains : String
vulnerablePackageName
action : String
contains : String
thresholdRules
(optional)
criticalVulnerabilities
action : String
threshold : String
cvssV2Score
action : String
threshold : String
exploitableVulnerabilities
action : String
threshold : String
vulnerabilitiesWithMalwareKits
action : String
threshold : String
moderateVulnerabilities
action : String
threshold : String
packageRiskScore
action : String
threshold : String
riskScore
action : String
threshold : String
severeVulnerabilities
action : String
threshold : String
totalVulnerabilities
action : String
threshold : String
treatWarningsAsErrors : boolean
(optional)
workspaceDir : String
(optional)
contentReplace
configs
(optional)
filePath : String
fileEncoding : String
configs
matchCount : int
(optional)
Set "Match count" to 0 will do replace all
replace : String
(optional)
You can use variables enclosed in ${}. e.g. $11.0.${BUILD_ID}
So, The string "Version=0.0.1" would be replace to Version=1.0.9 when the value of BUILD_ID is 9
search : String
(optional)
Regex expression for search. e.g. (Version=)([0-9]+\.[0-9]+\.[0-9]+)
verbose : boolean
(optional)
Check "Verbose" to display in the console all the replacements made.
lineSeparator : String
(optional)
$class: 'ContinuousReleaseProperties'
properties
java.util.Map<java.lang.String, java.lang.String>
$class: 'CoordinatorBuilder'
executionPlan
class org.jenkinsci.plugins.coordinator.model.TreeNode
$class: 'CopadoBuilder'
stepName : String
webhookUrl : String
api_key : String
timeout : int
copyArtifacts
projectName : String
The name of the project to copy artifacts from.
Artifacts from all modules will be copied. Enter JOBNAME/MODULENAME here to copy from a particular module; you may copy/paste this from the URL for that module when browsing Jenkins.
Example: MyMavenJob/my.group$MyModule
Artifacts from all configurations will be copied, each into a subdirectory with the name of the configuration as seen in its URL when browsing Jenkins.
Example: If the target directory is given as fromMatrix then the copy could create $WORKSPACE/fromMatrix/label=agentA/dist/mybuild.jar and $WORKSPACE/fromMatrix/label=agentB/dist/mybuild.jar.
To copy from a particular configuration, enter JOBNAME/AXIS=VALUE,.. as seen in the URL for that configuration.
Example: MyMatrixJob/jdk=Java6u17
To copy artifacts from one matrix project to another, use a parameter to select the matching configuration in the source project.
Example: OtherMatrixJob/jdk=$jdk
Use a path consisting of the project name followed by the branch name.
Example: /MyMultibranchProject/MyBranch
Special letters like '/' in branch names should be escaped. You can see the exact name in "Full project name" in job pages of each branch.
Example: ../MyMultibranchProject/feature%2Fnavigation
See "How to reference another project by name" for more information.
excludes : String
(optional)
filter : String
(optional)
fingerprintArtifacts : boolean
(optional)
flatten : boolean
(optional)
includeBuildNumberInTargetPath : boolean
(optional)
When true, the build number of the source project will be included in the target path. This is particularly useful when the selector is specific and the value is a permalink, e.g. lastSuccessfulBuild.
optional : boolean
(optional)
parameters : String
(optional)
Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.
You shouldn't use "Build selector for Copy Artifact" parameters here, as it doesn't preserve compatibility when you upgrade plugins, and doesn't work for builds built before upgrading.
resultVariableSuffix : String
(optional)
If not specified, the source project name will be used instead (in all uppercase, and sequences of characters other than A-Z replaced by a single underscore).
Example:
Source project name | Suffix to be used |
---|---|
Project-ABC | PROJECT_ABC |
tool1-release1.2 | TOOL_RELEASE_ |
selector
(optional)
downstream
upstreamProjectName : String
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
upstreamBuildNumber : String
lastWithArtifacts
lastCompleted
$class: 'MultiJobBuildSelector'
buildParameter
parameterName : String
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
permalink
id : String
$class: 'PromotedBuildSelector'
level : int
latestSavedBuild
specific
buildNumber : String
lastSuccessful
stable : boolean
(optional)
upstream
allowUpstreamDependencies : boolean
(optional)
fallbackToLastSuccessful : boolean
(optional)
upstreamFilterStrategy
(optional)
UseGlobalSetting
, UseOldest
, UseNewest
workspace
target : String
(optional)
$class: 'CreateBaselineBuilder'
outputFile : String
Path to the file that should be used to store baseline.
File location must be specified as:
inputFileOrFolder : String
Specify input folder/file for creating baseline. It should depend on input type you have selected.
Folder/file location must be specified as:
$class: 'CreateBuildBuilder'
Creates a new build for the selected BuildMaster application and sets the BUILDMASTER_BUILD_NUMBER environment variable with the value returned from BuildMaster for the new build.
If your Jenkins job has produced artifacts to be loaded into BuildMaster, you have the following options. The choice is largely dependent on how you import the build artifacts into BuildMaster:
applicationId : String
The identifier of the BuildMaster application to trigger the build for.
Options are:
releaseNumber : String
The BuildMaster release number to trigger the build for. Options are:
The job will fail if there is no active BuildMaster release.
deployToFirstStage
(optional)
waitUntilCompleted : boolean
printLogOnFailure : boolean
(optional)
variables : String
(optional)
Provide a list of variables to pass to the build.
$class: 'CreateCustomTaskrun'
name : String
generateName : String
namespace : String
clusterName : String
workspaces
name : String
claimName : String
params
name : String
value : String
taskRef : String
createCloudifyEnv
Creates a topology from an environment blueprint.
The "Output File" parameter denotes where the new environment's outputs will be written to. Later build steps can inspect this file in order to grab information pertinent to them (such as IP addresses, user names and so forth).
All input fields support standard Jenkins parameters' expansion. For example, the string ${app_name}
will be expanded, in runtime, to the value of a build parameter called app_name
.
For explanation about the format of the outputs file, refer to the help tooltip for that parameter.
blueprintId : String
(optional)
Unique identifier for the created deployment.
credentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugOutput : boolean
(optional)
deploymentId : String
(optional)
Identifies the blueprint to create a deployment off.
echoInputs : boolean
(optional)
echoOutputs : boolean
(optional)
inputs : String
(optional)
A YAML/JSON containing inputs for the deployment. These inputs will be merged with inputs provided through the " inputs file
" parameter.
inputsFile : String
(optional)
A path (relative to the workspace root) to a YAML/JSON file containing inputs for the deployment. These inputs will be merged with inputs provided through the " inputs
" parameter.
mapping : String
(optional)
If specified, this YAML/JSON will be used to transform a YAML/JSON coming from the "inputs file" parameter. This is useful if the "inputs file" is the result of a different Cloudify environment build.
This parameter must not be provided if "mapping file" is provided.
mappingFile : String
(optional)
If specified, this YAML/JSON file will be used to transform a YAML/JSON coming from the "inputs file" parameter. This is useful if the "inputs file" is the result of a different Cloudify environment build.
This parameter must not be provided if "mapping" is provided.
outputFile : String
(optional)
Name of file into which the deployment's outputs and capabilities will be written. The file will be a JSON, adhering to the following format:
{ "outputs": <outputs_dictionary>, "capabilities": <capabilities_dictionary> }
skipInstall : boolean
(optional)
install
workflow.
tenant : String
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
$class: 'CreateFingerprint'
Create Fingerprints of specified files during a build process
targets : String
$class: 'CreateRelease'
prefix : String
itemPrefix : String
releaseName : String
description : String
stage : String
owner : String
period : String
$class: 'CreateSnapshotBuilder'
outputFile : String
Path to the file that should be used to store snapshots.
File location must be specified as:
inputFileOrFolder : String
Specify input folder/file for creating snapshot. It should depend on input type you have selected.
Folder/file location must be specified as:
createTask
artifact : String
(optional)
artifactType : String
(optional)
autoUpgradable : boolean
(optional)
environment : String
(optional)
isjob : boolean
(optional)
overrideWithDefaultParameters : boolean
(optional)
parameters : String
(optional)
runtime : String
(optional)
runtimeType : String
(optional)
workspace : String
(optional)
$class: 'CreateTemplate'
cloud : String
workspace : String
instanceTags : String
templateName : String
provider : String
datacenter : String
folder : String
datastore : String
claimFilter : String
policyName : String
claims : String
$class: 'CreateVM'
INSTANCE_NAME : String
GCP_PROJECT_ID : String
IMAGE_NAME : String
scriptType : String
$class: 'CreateVirtualService'
config : String
rrFilePath : String
host : String
username : String
password
class hudson.util.Secret
isstart : boolean
token
class hudson.util.Secret
$class: 'CriticalBlockEnd'
Release all resources that Critical block start had allocated for this job.
$class: 'CriticalBlockStart'
Delimit the beginning of the exclusion zone. All build steps that follow will be managed by exclusion plugin.
crowdStrikeSecurity
imageName : String
(optional)
Image Name is the name of the Docker container image. This plugin will attempt to "docker push" that image name to the Falcon API servers to enqueue the image layers for image assessment. May only contain letters (a-z), numbers (0-9), underscore (_), hyphen (-), and period (.). Must not exceed 4096 characters in length.
imageTag : String
(optional)
Image Tag is the name of the Docker container image tag. This determines which version of the given Docker container image to assess. If you aren't sure, you can try a value like "latest”. May only contain letters (a-z), numbers (0-9), underscore (_), hyphen (-), and period (.). Must not exceed 127 characters in length.
enforce : boolean
(optional)
Enforce CrowdStrike Falcon API recommendation by immediately aborting and failing the build.
skipImageUpload : boolean
(optional)
Select this option only if the image is already uploaded to CrowdStrike as part of a previous step in your build pipeline. When selected, the plugin retrieves an image scan report but does not upload the image to CrowdStrike for assessment.
timeout : int
(optional)
Timeout is the number of seconds to wait before giving up (ie. if there is some issue, such as network connectivity to Falcon). To err on the side of safety, when a timeout is reached, it will be treated the same as if Falcon had recommended to prevent the build. This timeout is for the entire build step. Must be an integer between 1 and 1799.The maximum timeout session would be 30 minutes.
$class: 'CucumberSlackBuildStepNotifier'
channel : String
json : String
hideSuccessfulResults : boolean
$class: 'CustomPythonBuilder'
home : String
nature : String
command : String
ignoreExitCode : boolean
$class: 'CxScanBuilder'
credentialsId : String
sastCredentialsId : String
buildStep : String
teamPath : String
sastEnabled : boolean
exclusionsSetting : String
failBuildOnNewResults : boolean
failBuildOnNewSeverity : String
useOwnServerCredentials : boolean
(optional)
serverUrl : String
(optional)
username : String
(optional)
password : String
(optional)
isProxy : boolean
(optional)
configAsCode : boolean
(optional)
projectName : String
(optional)
projectId : long
(optional)
projectRetentionRate : int
(optional)
groupId : String
(optional)
preset : String
(optional)
jobStatusOnError
(optional)
GLOBAL
, FAILURE
, UNSTABLE
, ABORTED
scaReportFormat
(optional)
PDF
, XML
, CSV
, JSON
, cyclonedxjson
, cyclonedxxml
presetSpecified : boolean
(optional)
excludeFolders : String
(optional)
Conversion is done as follows: fold1, fold2 fold3
is converted to: !**/fold1/**/*, !**/fold2/**/*, !**/fold3/**/*,
filterPattern : String
(optional)
Example: **/*.java,
**/*.html, !**\test\**\XYZ*
Pattern Syntax
A given directory is recursively scanned for all files and directories. Each file/directory is matched against a set of selectors, including special support for matching against filenames with include and exclude patterns. Only files/directories which match at least one pattern of the include pattern list, and don't match any pattern of the exclude pattern list will be placed in the list of files/directories found.
When no list of include patterns is supplied, "**" will be used, which means that everything will be matched. When no list of exclude patterns is supplied, an empty list is used, such that nothing will be excluded. When no selectors are supplied, none are applied.
The filename pattern matching is done as follows: The name to be matched is split up in path segments. A path segment is the name of a directory or file, which is bounded by File.separator
('/' under UNIX, '\' under Windows). For example, "abc/def/ghi/xyz.java" is split up in the segments "abc", "def","ghi" and "xyz.java". The same is done for the pattern against which should be matched.
The segments of the name and the pattern are then matched against each other. When '**' is used for a path segment in the pattern, it matches zero or more path segments of the name.
There is a special case regarding the use of File.separator
s at the beginning of the pattern and the string to match:
When a pattern starts with a File.separator
, the string to match must also start with a File.separator
. When a pattern does not start with a File.separator
, the string to match may not start with a File.separator
. When one of these rules is not obeyed, the string will not match.
When a name path segment is matched against a pattern path segment, the following special characters can be used:
'*' matches zero or more characters
'?' matches one character.
May reference build parameters like ${PARAM}.
Examples:
"**\*.class" matches all .class files/dirs in a directory tree.
"test\a??.java" matches all files/dirs which start with an 'a', then two more characters and then ".java", in a directory called test.
"**" matches everything in a directory tree.
"**\test\**\XYZ*" matches all files/dirs which start with "XYZ" and where there is a parent directory called test (e.g. "abc\test\def\ghi\XYZ123").
incremental : boolean
(optional)
fullScansScheduled : boolean
(optional)
fullScanCycle : int
(optional)
postScanActionId : int
(optional)
sourceEncoding : String
(optional)
comment : String
(optional)
skipSCMTriggers : boolean
(optional)
waitForResultsEnabled : boolean
(optional)
vulnerabilityThresholdEnabled : boolean
(optional)
highThreshold : int
(optional)
mediumThreshold : int
(optional)
lowThreshold : int
(optional)
osaHighThreshold : int
(optional)
osaMediumThreshold : int
(optional)
osaLowThreshold : int
(optional)
generatePdfReport : boolean
(optional)
generateScaReport : boolean
(optional)
enableProjectPolicyEnforcement : boolean
(optional)
thresholdSettings : String
(optional)
vulnerabilityThresholdResult : String
(optional)
avoidDuplicateProjectScans : boolean
(optional)
addGlobalCommenToBuildCommet : boolean
(optional)
generateXmlReport : boolean
(optional)
hideDebugLogs : boolean
(optional)
forceScan : boolean
(optional)
customFields : String
(optional)
dependencyScanConfig
(optional)
SASTUserName : String
(optional)
dependencyScanExcludeFolders : String
(optional)
dependencyScanPatterns : String
(optional)
dependencyScannerType
(optional)
OSA
, SCA
enableScaResolver
(optional)
SCA_RESOLVER
, MANIFEST
fsaVariables : String
(optional)
generateScaReport : boolean
(optional)
globalScaResolverAddParameters : String
(optional)
isExploitablePath : boolean
(optional)
isExploitablePathByScaResolver : boolean
(optional)
isGlobalExploitablePathByScaResolver : boolean
(optional)
isIncludeSources : boolean
(optional)
osaArchiveIncludePatterns : String
(optional)
osaInstallBeforeScan : boolean
(optional)
overrideGlobalConfig : boolean
(optional)
pathToScaResolver : String
(optional)
sastCredentialsId : String
(optional)
scaAccessControlUrl : String
(optional)
scaConfigFile : String
(optional)
scaCredentialsId : String
(optional)
scaEnvVariables : String
(optional)
scaResolverAddParameters : String
(optional)
scaSASTProjectFullPath : String
(optional)
scaSASTProjectID : String
(optional)
scaSastServerUrl : String
(optional)
scaServerUrl : String
(optional)
scaTeamId : String
(optional)
scaTeamPath : String
(optional)
scaTenant : String
(optional)
scaTimeout : int
(optional)
scaWebAppUrl : String
(optional)
useJobLevelSastDetails : boolean
(optional)
excludeOpenSourceFolders : String
(optional)
includeOpenSourceFolders : String
(optional)
osaArchiveIncludePatterns : String
(optional)
osaEnabled : boolean
(optional)
osaInstallBeforeScan : boolean
(optional)
overrideGlobalRetentionRate : boolean
(optional)
overrideProjectSetting : boolean
(optional)
thisBuildIncremental : boolean
(optional)
DASTScan
apikey
(optional)
Your API key can be found on the Breachlock Platform under
Organization settings > Integrations > Jenkins
class hudson.util.Secret
asset : String
(optional)
Select the asset that will be scanned on build.
If the asset you are looking for is missing:
email : String
(optional)
The email-address you registered on Breachlock Platform.
osfBuilderSuiteForSFCCDataImport
hostname : String
(optional)
tfCredentialsId : String
(optional)
ocCredentialsId : String
(optional)
ocVersion : String
(optional)
archiveName : String
(optional)
sourcePath : String
(optional)
includePatterns
(optional)
includePattern : String
excludePatterns
(optional)
excludePattern : String
importStrategy : String
(optional)
tempDirectory : String
(optional)
$class: 'DaticalDBBuilder'
daticalDBProjectDir : String
daticalDBServer : String
daticalDBAction : String
daticalDBCmdProject : String
daticalDBExportSQL : String
daticalDBExportRollbackSQL : String
daticalDBScriptDir : String
debianPbuilder
additionalBuildResults : String
(optional)
When running a build in the chroot environment, there are occasionally files that you must retrieve from the chroot that are not part of the normal build. For example, some files that you may need to get back would include test results, auto-generated files, etc.
Set this variable in order to get the files back from the chroot build environment.
The files that are retrieved will also automatically be archived as well with the other build results.
This must be a comma-separated list; spaces are allowed.
architecture : String
(optional)
The architecture to build this as.
If the project is using the Matrix Build plugin, leave this blank (the architectures to build for are defined by the 'architecture' environment variable).
This is mostly to support Pipeline, however it can be used as a normal parameter as well.
artifactoryRepoName : String
(optional)
If you are generating a spec file for use with Artifactory, this defines the repository that you would like to upload it to.
buildAsTag : boolean
(optional)
Set this to mark this as building a tag. When a build comes from a tag, the deb version does not get incremented(i.e. it is exactly as set in the debian/changelog file). If using SVN, this plugin automatically looks at the SVN_URL_1 environment variable to see if the string "tags/" exists. If it does, the build will act as though this parameter is set. If using Git, this plugin automatically looks at the GIT_BRANCH environment variable to see if the string "tags/" exists. If it does, the build will act as though this parameter is set. Alternatively, you can also set the environment variable DEB_PBUILDER_BUILDING_TAG to either true or false.
components : String
(optional)
The components to build with. By default, pbuilder sets this to 'main'. If you're building an Ubuntu package, you may need to set this to "main restricted universe multiverse"
The setting guessComponents must be false for this setting to be honored.
debianDirLocation : String
(optional)
The location of the debian/ directory, relative to workspace root
This may also be set globally
distribution : String
(optional)
The distribution to build for. By default, this checks the distribution that is set in debian/changelog. If the version in the changelog is UNRELEASED, it attempts to use the currently running distribution if this parameter is NULL or a 0-length string.
extraPackages : String
(optional)
Extra packages to install in the chroot environment. Corresponds to EXTRAPACKAGES in the pbuilder configuration
generateArtifactorySpecFile : boolean
(optional)
Generate a spec file to be used with Artifactory in order to upload files. By default, this will generate the file with the .deb, .tar* and .gz files for uploading.
This will generate a spec file in the workspace called artifactory-spec-debian-pbuilder/debian-pbuilder.spec which you can then use to upload the binaries to Artifactory. This is intended to be used in conjunction with the Artifactory Jenkins plugin.
guessComponents : boolean
(optional)
If set to true, automatically try to guess the components. This means that if we think we are building an Ubuntu package on Debian, our components will be automatically set to "main restricted universe multiverse"
keyring : String
(optional)
The keyring to build with. By default, we will attempt to figure out if we are building a Debian package on Ubuntu, and if we think that we are this will be set to /usr/share/keyrings/debian-archive-keyring.gpg. This file is part of the debian-archive-keyring package. If you need to use a custom keyring, put it in here. If for some reason the auto-detection is not working properly, set this to the string 'disabled' and no keyring settings for pbuilder will be set.
mirrorSite : String
(optional)
The mirror site to use. If this is not set or a 0-length string, then the default mirror site for this distribution will be used. The default mirror site is defined in /etc/pbuilderrc
numberCores : int
(optional)
The number of cores to use when building. By default, this is 1. Set to -1 in order to use as many cores as possible when building. In order for this to take effect, you need to make sure that your debian/rules is setup properly. See this post.
otherMirror : String
(optional)
The extra mirror to use. Corresponds to OTHERMIRROR configuration option in pbuilder
pbuilderType : String
(optional)
pristineTarName : String
(optional)
If this field set, and if source/format indicates that this is a quilt package, we will attempt to checkout the given original tar file.
runAutomationHubBuild
testSuiteId : String
startOnly : boolean
(optional)
userKeyId : String
(optional)
userKeySecret
(optional)
class hudson.util.Secret
dotnetNuGetDelete
dotnet nuget delete
command deletes or unlists a package from the server. For nuget.org, the action is to unlist the package.
apiKeyId : String
(optional)
charset : String
(optional)
continueOnError : boolean
(optional)
FAILURE
(or UNSTABLE
, if configured that way), but the build will be allowed to continue. Otherwise, any such errors will cause the build to be terminated immediately.
forceEnglishOutput : boolean
(optional)
noServiceEndpoint : boolean
(optional)
api/v2/package
" to the source URL.
packageName : String
(optional)
packageVersion : String
(optional)
sdk : String
(optional)
dotnet
will be in the path.
With .NETelement (or a
withDotNet
block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
showSdkInfo : boolean
(optional)
dotnet --info
will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
source : String
(optional)
https://www.nuget.org
, https://www.nuget.org/api/v3
, and https://www.nuget.org/api/v2/package
. For private feeds, replace the host name (for example, %hostname%/api/v3
).
specificSdkVersion : boolean
(optional)
dotnet
executable may use the most recent SDK available on the system, even when PATH
is set up to find an older SDK deployment first; see this page for more information.
global.json
file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json
already present in the current directory.
workDirectory : String
(optional)
$class: 'DeleteApplication'
serverName : String
appName : String
domain : String
deleteCloudifyBlueprint
blueprintId : String
(optional)
credentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
tenant : String
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
deleteCloudifyEnv
credentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugOutput : boolean
(optional)
deleteBlueprintIfLast : boolean
(optional)
If checked, and this is the last environment for the associated blueprint, then also delete the blueprint.
deploymentId : String
(optional)
ignoreFailure : boolean
(optional)
If checked, then failures during the removal of the environment will be ignored.
skipUninstall : boolean
(optional)
uninstall
workflow.
tenant : String
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
$class: 'DeleteEnvironmentBuilder'
systemId : int
environmentName : String
$class: 'DeleteRaw'
deleteAllStatus
resourceName : String
resourceType : String
(optional)
clusterName : String
(optional)
resourceName : String
(optional)
deleteVDB
credentialId : String
(optional)
force : boolean
(optional)
loadFromProperties : boolean
(optional)
name : String
(optional)
skipPolling : boolean
(optional)
vdbId : String
(optional)
$class: 'DeleteVirtualService'
serviceName : String
$class: 'DeleteVirtualizeBuilder'
serverType : String
serverHost : String
serverName : String
dependencyCheck
odcInstallation : String
additionalArguments : String
(optional)
--project | The name of the Jenkins job |
--scan | The build workspace |
--format | XML |
skipOnScmChange : boolean
(optional)
skipOnUpstreamChange : boolean
(optional)
stopBuild : boolean
(optional)
$class: 'DeployApplication'
This plugin creates a container on the OpenShift PaaS and deploys the application into the container.
serverName : String
appName : String
cartridges : String
Specify a space delimited list of cartridges to be assigned to the application. e.g. jbosseap-6 mysql-5.5
Note that the specified cartridges need to be available on the selected OpenShift server. For a complete list of available cartridges on OpenShift refer to OpenShift web console or use the command line too 'rhc cartridges'. Here is the list of some of the most common cartridges:
domain : String
gearProfile : String
deploymentPackage : String
In case of URL or when only one deployment package exists in the given directory, the package is deployed under the root ("/") context. When multiple packages are found, all are deployed under their own context paths.
Token macro expressions can be used for specifying a URL:
https://repo/nexus/service/local/artifact/maven/redirect?r=central&g=${ENV,var="GROUPID"}&a=${ENV,var="ARTIFACTID"}&v=${ENV, var="VERSION"}&e=war
Check Token Macro Plugin for further details.
environmentVariables : String
Specify a space delimited list of environment variables (key=value) to be assigned to the application. e.g. LOAD_DATA=true MVN_DEPLOY=true
autoScale : boolean
deploymentType
GIT
, BINARY
openshiftDirectory : String
$class: 'DeployBox'
id : String
cloud : String
workspace : String
box : String
boxVersion : String
instanceName : String
profile : String
claims : String
provider : String
location : String
instanceEnvVariable : String
Additional instance properties will also be available via other environment variables that have the defined variable as prefix of their name. For example, if INSTANCE is specified for this field then the following environment variables are available:
INSTANCE - ID of the deployed instance
INSTANCE_URL - URL of the deployed instance
INSTANCE_SERVICE_ID - service ID of the deployed instance
INSTANCE_TAGS - comma-separate list of tags of the deployed instance
If 1 is specified for Number of Instances then the following environment variables are available:
INSTANCE_MACHINE_NAME - VM name of the deployed instance
INSTANCE_PUBLIC_ADDRESS - VM public address of the deployed instance
INSTANCE_PRIVATE_ADDRESS - VM private address of the deployed instance
If Number of Instances is greater than 1, the following environment variable are available:
INSTANCE_MACHINE_NAMES - space-separate list of VM names
INSTANCE_PUBLIC_ADDRESSES - space-separate list of public addresses of the VMs
INSTANCE_PRIVATE_ADDRESSES - space-separate list of private addresses of the VMs
tags : String
variables : String
expiration
$class: 'AlwaysOn'
$class: 'ShutDown'
hours : String
date : String
time : String
$class: 'Terminate'
hours : String
date : String
time : String
autoUpdates : String
alternateAction : String
waitForCompletion : boolean
waitForCompletionTimeout : int
boxDeploymentType : String
samDeploy
settings
credentialsId : String
region : String
s3Bucket : String
stackName : String
templateFile : String
template.yaml
app/template.json
kmsKeyId : String
(optional)
outputTemplateFile : String
(optional)
template-#jobId.yaml
by default.
parameters
(optional)
key : String
value : String
roleArn : String
(optional)
s3Prefix : String
(optional)
tags
(optional)
key : String
value : String
crxDeploy
packageIdFilters : String
(optional)
**/*.zipThis pattern will only match packages located directly under the Packages folder whose filenames begin with 'acme-':
Packages/acme-*.zipMatching packages will be uploaded in the order in which the filters are specified. Only the highest matching version of a package identified by 'group:name' will be deployed, and it will only be deployed once per build step, regardless of the number of matching filters.
baseUrls : String
(optional)
username[:password]@
between the scheme and the hostname.
acHandling : String
(optional)
autosave : int
(optional)
behavior : String
(optional)
credentialsId : String
(optional)
/$username/keys/$fingerprint
.
disableForJobTesting : boolean
(optional)
localDirectory : String
(optional)
recursive : boolean
(optional)
replicate : boolean
(optional)
requestTimeout : long
(optional)
serviceTimeout : long
(optional)
waitDelay : long
(optional)
$class: 'DeployPromotionBuilder'
hosts
com.cloudbees.plugins.deployer.hosts.DeployHost<?, ?>
$class: 'DeployScriptBuilder'
out : String
Specify full path to target connection file.
File location must be specified as:
in : String
Specify path to file that contains SQL script.
File location must be specified as:
buildMasterDeployBuildToStage
Deploys (or re-deploys) a build to a particular stage.
Note: that when used in a pipeline step that the applicationId, releaseNumber, and buildNumber fields are required:
buildMasterDeployBuildToStage(applicationId: BUILDMASTER_APPLICATION_ID, releaseNumber: BUILDMASTER_RELEASE_NUMBER, buildNumber: BUILDMASTER_BUILD_NUMBER)
applicationId : String
The identifier of the BuildMaster application to trigger the build for.
Options are:
releaseNumber : String
The BuildMaster release number to trigger the build for. Options are:
The job will fail if there is no active BuildMaster release.
buildNumber : String
The BuildMaster build number to trigger the deployment for.
The must be set to an existing build number. Typically this would be obtained from the output of the createBuild step which populates the BUILDMASTER_BUILD_NUMBER environment variable.
force : boolean
(optional)
printLogOnFailure : boolean
(optional)
stage : String
(optional)
Optional. If not supplied, the next stage in the pipeline will be used.
variables : String
(optional)
Set deployment level variables.
waitUntilCompleted : boolean
(optional)
$class: 'Deployer'
stack : String
dryRun : boolean
branch : String
apiKey : String
addDeployToDashboard
env : String
buildNumber : String
$class: 'DeploymentBuilder'
url : String
userId : String
password : String
enableZipFile : boolean
enableAutoDeploy : boolean
enableTestCase
testcaseblock
projectname : String
testcasename : String
xpath : String
reportDeployOperation
targetService : String
(optional)
applicationName : String
(optional)
applicationVersion : String
(optional)
tags : String
(optional)
$class: 'DescribeWithParamsBuilder'
starter : boolean
separator : String
excludes : String
$class: 'DescriptionSetterBuilder'
This plugin automatically sets a description for the build as a step during building.
A description can be based on the log output (by searching it using a regular expression), or it can be hardcoded.
The description is exposed as DESCRIPTION_SETTER_DESCRIPTION environment variable
regexp : String
\[INFO\] Uploading project information for [^\s]* ([^\s]*)
description : String
$class: 'DestroyVM'
INSTANCE_NAME : String
GCP_PROJECT_ID : String
IMAGE_NAME : String
$class: 'DevOpsCreateArtifactPackageBuildStep'
name : String
(optional)
artifactsPayload : String
(optional)
$class: 'DevOpsFreestyleRegisterSecurityStep'
securityResultAttributes : String
(optional)
securityToolId : String
(optional)
$class: 'DevOpsRegisterArtifactBuildStep'
artifactsPayload : String
(optional)
svCreateAndDeployVirtualService
Create and deploy Virtual Service from VSI/VSM, RR Pairs, or the following specifications: Swagger, WSDL, or RAML.
useCustomRegistry : boolean
host : String
port : String
vseName : String
config : String
Example of using a configuration object that includes port and SSL information
{ "virtualService": { "version": "2", "name": "API_Test_1", "description": "Invoke API V2", "status": "" }, "transportProtocol": { "typeId": "HTTP", "basePath": "/", "useGateway": true, "duptxns": true, "hostHeaderPassThrough": false }, "dataProtocol": { "forRequest": true, "typeId": "RESTDPH" } }
deploy : String
undeploy : String
inputFile1 : String
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
inputFile2 : String
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
activeConfig : String
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
dataFiles : String
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
swaggerurl : String
ramlurl : String
wadlurl : String
tokenCredentialId : String
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
secured : boolean
svDeployTest
Deploys and starts CA DevTest test or test suite provided as a .mar file.
Throws exception if .mar file is incorrect, authorization to CA DevTest fails or connection to CA DevTest cannot be established.
useCustomRegistry : boolean
host : String
port : String
marFilePath : String
testType : String
tokenCredentialId : String
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
secured : boolean
svDeployVirtualService
Deploys and starts virtual service provided as a .mar file to target VSE. More services could be provided using comma or newline separator.
Throws exception if .mar file is incorrect, virtual service is already deployed, authorization to CA DevTest fails or connection to CA DevTest cannot be established.
useCustomRegistry : boolean
host : String
port : String
vseName : String
marFilesPaths : String
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
tokenCredentialId : String
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
secured : boolean
svStartVirtualService
Starts virtual service that is already deployed on target VSE. More services could be started using comma or newline separator.
Throws exception if virtual service does not exist on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established.
useCustomRegistry : boolean
host : String
port : String
vseName : String
vsNames : String
tokenCredentialId : String
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
secured : boolean
svStopVirtualService
Stops virtual service that is running on target VSE. More services could be stopped using comma or newline separator.
Throws exception if virtual service is not running on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established.
useCustomRegistry : boolean
host : String
port : String
vseName : String
vsNames : String
tokenCredentialId : String
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
secured : boolean
svUndeployVirtualService
Undeploys (removes) virtual service from specified VSE. More services could be provided using comma or newline separator.
Throws exception if virtual service does not exist on specified VSE, authorization to CA DevTest fails or connection to CA DevTest cannot be established
useCustomRegistry : boolean
host : String
port : String
vseName : String
vsNames : String
tokenCredentialId : String
The ID for the integration token from the Credentials plugin to be used to connect to Registry endpoint. The "Kind" of the credential must be "Username with password".
secured : boolean
importDeveloperProfile
importIntoExistingKeychain : boolean
(optional)
keychainId : String
(optional)
keychainName : String
(optional)
keychainPath : String
(optional)
keychainPwd
(optional)
class hudson.util.Secret
profileId : String
(optional)
$class: 'DiawiUploader'
token : String
fileName : String
proxyHost : String
proxyPort : int
proxyProtocol : String
$class: 'DisableVirtualService'
serviceName : String
$class: 'DistTestingBuilder'
The goal of this plugin is to enable a distributed testing of some compiled classes on multiple nodes. Tests are send one by one to nodes in the label specified for the project and run. Test results are saved in the "results" directory in the project workspace. f.e. "TEST-helloword.HelloTest.xml" for the test class "helloworld.HelloTest".
This plugin suppose that all slaves in the specified label have a shared workspace directory. (like NFS)
Only classes in the "Tests classes directory" directory with a file name containing a "test" substring (case insensitive) are automatically found by this plugin and run.
If you enable "Publish JUnit test result report" in the "Post-build Actions" section and type "results/*.xml" you will see test results in the Hudson's web UI.
Only nodes in a label which were specified for this project ("Tie this project to a node") will be used for distributed testing. This label must contain at least 2 nodes.
It's possible let this plugin to compile tests class sources which were checkout from a repository if "Compile tests" checkbox was checked. Remember to provide all necessary libraries needed for compilation.
It's possible to check a "Wait for nodes which are busy" checkbox to wait for other nodes which are busy to be freed.
distLocations
distDir : String
libLocations
libDir : String
testDir : String
This specifies a relative path in the project workspace where compiled tests resides. For example if tests are in build/test/classes then type "build/test/classes". In case you check "Compile tests" checkbox this relative path will be used for storing compiled tests classes which were before check-out from a repository.
waitForNodes : boolean
Wait for modes in the label which are now occupied by some other builds. This doesn't wait for nodes which are offline
compileTests : boolean
If checked then all source codes in the "Tests classes directory" will be compiled. It's necessary to provide all libraries for compilation. Compiled tests will be saved into the directory "tests".
$class: 'DockerBuilderControl'
option
$class: 'DockerBuilderControlOptionProvisionAndStart'
cloudName : String
templateId : String
$class: 'DockerBuilderControlOptionRun'
cloudName : String
image : String
pullCredentialsId : String
dnsString : String
network : String
dockerCommand : String
mountsString : String
volumesFrom : String
environmentsString : String
hostname : String
user : String
extraGroupsString : String
memoryLimit : int
memorySwap : int
cpus : String
cpuPeriod : long
cpuQuota : long
cpuShares : int
shmSize : int
bindPorts : String
bindAllPorts : boolean
privileged : boolean
tty : boolean
macAddress : String
$class: 'DockerBuilderControlOptionStart'
cloudName : String
containerId : String
$class: 'DockerBuilderControlOptionStop'
cloudName : String
containerId : String
remove : boolean
$class: 'DockerBuilderControlOptionStopAll'
remove : boolean
$class: 'DockerBuilderNewTemplate'
dockerTemplate
dockerTemplateBase
$class: 'DockerTemplateBase'
image : String
bindAllPorts : boolean
(optional)
bindPorts : String
(optional)
capabilitiesToAddString : String
(optional)
A list of new line separated capabilities.
Each line represents an option for the --cap-add
parameter sent to the docker server. Each one must be a known capability "Key" as per the docker documentation.
Please check https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities for further information.
capabilitiesToDropString : String
(optional)
A list of new line separated capabilities.
Each line represents an option for the --cap-drop
parameter sent to the docker server. Each one must be a known capability "Key" as per the docker documentation.
Please check https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities for further information.
cpuPeriod : long
(optional)
Set the period of CPUs to limit the container’s CPU usage.
The default CPU CFS (Completely Fair Scheduler) period is 100000us.
Consult Docker Run Documentation for further information.
cpuQuota : long
(optional)
Limits the container’s CPU usage.
The default 0 value allows the container to take 100% of a CPU resource.
Consult Docker Run Documentation for further information.
cpuShares : int
(optional)
cpus : String
(optional)
Specify how much of the available CPU resources a container can use as a floating point number.
The default is not set.
Consult Docker Run Documentation for further information.
devicesString : String
(optional)
dnsString : String
(optional)
dockerCommand : String
(optional)
environmentsString : String
(optional)
Zero or more environment variables that are set within the docker container. This is a multi-line text field. Each line must be of the form key=value and specify one variable name and its value.
Note that quotes are not interpreted.
e.g. foo="bar" will result in the quotes being part of foo's value.
Note also that whitespace is easily broken. Editing this field this without first expanding the box to its multi-line form will cause any whitespace within a line to be turned into end of line codes, breaking up the line and thus changing its meaning.
e.g. The single setting:
JENKINS_AGENT_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
can be (accidentally) turned into three separate settings:
JENKINS_AGENT_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
thus preventing the configuration from working as was intended.
extraDockerLabelsString : String
(optional)
A list of new line separated docker labels to be set on the container, Specified in the form "label_name=value"
.
This has no effect on Jenkins functionality, and is not related to the labels used by Jenkins to map jobs to agent nodes. These labels are metadata attached to the docker container itself (again, not the jenkins agent), and which can typically be read using the docker inspect
command.
This can be useful when using a docker cluster (like docker swarm) to pass information to the scheduler, in conjunction with constraints; or to let other services (portainer, prometheus...) know how they should categorize or otherwise deal with this specific container.
Notes:
extraGroupsString : String
(optional)
extraHostsString : String
(optional)
hostname : String
(optional)
macAddress : String
(optional)
memoryLimit : int
(optional)
The operator can constrain the memory available to a container. If the host supports swap memory, then the setting can be larger than physical RAM.
When the processes inside the container exceed the memory limit, effects vary depending on your setup, e.g. out of memory errors may occur or the operating system could start killing processes.
Consult Docker Run Documentation for further information.
Note that on most Docker installations, the memory limit will not stop Jenkins/Docker from spawning so many containers that the machines total available memory will be exceeded. However, some Docker installations might be able to constrain the number of containers automatically using the memory limit.
memorySwap : int
(optional)
mountsString : String
(optional)
network : String
(optional)
privileged : boolean
(optional)
pullCredentialsId : String
(optional)
securityOptsString : String
(optional)
A list of new line separated security options.
Each line represents an option for the --security-opt
parameter sent to the docker server. The options are in the format key=value
.
Please check https://docs.docker.com/engine/reference/run/#security-configuration for further information.
shmSize : int
(optional)
tty : boolean
(optional)
user : String
(optional)
volumesFromString : String
(optional)
connector
For all connection methods, Jenkins will start by triggering a docker run
. Then, after this step, there will optionally be more steps to establish the connection. There is currently three alternative ways to connect your Jenkins master to the dynamically provisioned Docker agents.
There are different pros and cons for each connection method. Depending on your environment, choose the one matching your needs. More detailed prerequisites are provided once you select a given method.
docker exec
, all by using the Docker API. The agent does not need to be able to reach the master through the network layers to communicate ; all will go through Docker API.
docker run
command with the right secret. And the remoting agent will establish the connection with the master through the network. Hence, the agent must be able to access the master through its address and port.
attach
entryPointCmdString : String
(optional)
javaExe : String
(optional)
jvmArgsString : String
(optional)
user : String
(optional)
root
") will be used if this is left blank.
jnlp
jnlpLauncher
inbound
tunnel : String
webSocket : boolean
(optional)
workDirSettings
(optional)
disabled : boolean
workDirPath : String
internalDir : String
failIfWorkDirIsMissing : boolean
entryPointArgumentsString : String
(optional)
jenkinsUrl : String
(optional)
user : String
(optional)
ssh
sshKeyStrategy
$class: 'InjectSSHKey'
user : String
$class: 'ManuallyConfiguredSSHKey'
credentialsId : String
sshHostKeyVerificationStrategy
$class: 'KnownHostsFileKeyVerificationStrategy'
Checks the known_hosts file (~/.ssh/known_hosts) for the user Jenkins is executing under, to see if an entry exists that matches the current connection.
This method does not make any updates to the Known Hosts file, instead using the file as a read-only source and expecting someone with suitable access to the appropriate user account on the Jenkins controller to update the file as required, potentially using the ssh hostname
command to initiate a connection and update the file appropriately.
$class: 'ManuallyProvidedKeyVerificationStrategy'
Checks the key provided by the remote host matches the key set by the user who configured this connection.
key : String
The SSH key expected for this connection. This key should be in the form `algorithm value` where algorithm is one of ssh-rsa or ssh-dss, and value is the Base 64 encoded content of the key.
$class: 'ManuallyTrustedKeyVerificationStrategy'
Checks the remote key matches the key currently marked as trusted for this host.
Depending on configuration, the key will be automatically trusted for the first connection, or an authorised user will be asked to approve the key. An authorised user will be required to approve any new key that gets presented by the remote host.
requireInitialManualTrust : boolean
Require a user with Computer.CONFIGURE permission to authorise the key presented during the first connection to this host before the connection will be allowed to be established.
If this option is not enabled then the key presented on first connection for this host will be automatically trusted and allowed for all subsequent connections without any manual intervention.
$class: 'NonVerifyingKeyVerificationStrategy'
Does not perform any verification of the SSH key presented by the remote host, allowing all connections regardless of the key they present.
javaPath : String
(optional)
jvmOptions : String
(optional)
launchTimeoutSeconds : int
(optional)
maxNumRetries : int
(optional)
Note: That this field applies first to checks that the SSH port is open for new TCP connections, and secondly to checks that the SSH service that owns the TCP port is accepting SSH connections.
e.g. a value of 3 would mean that (up to) 4 attempts (1 initial attempt plus 3 retries) would be made to check the availability of the TCP port, followed by (up to) 4 attempts (1 initial attempt plus 3 retries) to check the availability of the SSH service itself.
port : int
(optional)
prefixStartSlaveCmd : String
(optional)
retryWaitTime : int
(optional)
suffixStartSlaveCmd : String
(optional)
labelString : String
instanceCapStr : String
The maximum number of containers, based on this template, that this provider is allowed to run in total. A negative value, or zero, or 2147483647 all mean "no limit" is imposed on the this template, although the overall cloud instance limit (if any) will still apply.
Note that containers which have not been created by Jenkins are not included in this total.
As an alternative, some Docker setups can also determine the maximum number of containers automatically using memory/cpu constraints.
disabled
(optional)
disabledByChoice : boolean
(optional)
enabledByChoice : boolean
(optional)
Note: If problems are encountered then this functionality may be disabled automatically. If that happens then it will be shown here. In this situation, the disabled state is transient and will automatically clear after the stated period has elapsed.
mode
(optional)
NORMAL
, EXCLUSIVE
name : String
(optional)
If blank or just whitespace, a default of "docker" will be used.
nodeProperties
(optional)
? extends hudson.slaves.NodeProperty<?>
pullStrategy
(optional)
PULL_ALWAYS
, PULL_LATEST
, PULL_NEVER
pullTimeout : int
(optional)
Note: This overrides the read timeout specified for the cloud, but only for the docker pull operation (as this operation is expected to take longer than most docker operations).
remoteFs : String
(optional)
removeVolumes : boolean
(optional)
retentionStrategy
(optional)
Specify the strategy when docker containers shall be started and stopped:
idleMinutes : int
numberOfTasksInProgress : int
(optional)
terminateOnceDone : boolean
(optional)
stopTimeout : int
(optional)
$class: 'DockerBuilderPublisher'
dockerFileDirectory : String
fromRegistry
url : String
https://index.docker.io/v1/
).
credentialsId : String
cloud : String
tagsString : String
pushOnSuccess : boolean
pushCredentialsId : String
cleanImages : boolean
cleanupWithJenkinsJobDelete : boolean
buildArgs
(optional)
A map of build-time variables.
java.util.Map<java.lang.String, java.lang.String>
buildArgsString : String
(optional)
A list of new line separated build-time variables, specified in the form "name=value"
.
noCache : boolean
(optional)
--no-cache
which disables caching of layers. See the docker build command for more information.
pull : boolean
(optional)
--pull
to pull the latest version of the base image, instead of using the local one. See the docker build command for more information.
$class: 'DockerComposeBuilder'
useCustomDockerComposeFile : boolean
dockerComposeFile : String
option
$class: 'ExecuteCommandInsideContainer'
privilegedMode : boolean
service : String
command : String
index : int
workDir : String
$class: 'StartAllServices'
$class: 'StartService'
service : String
scale : int
$class: 'StopAllServices'
$class: 'StopService'
service : String
$class: 'DockerPullImageBuilder'
registry
url : String
https://index.docker.io/v1/
).
credentialsId : String
image : String
dockerShell
connector
(optional)
$class: 'CloudNameDockerConnector'
cloudName : String
$class: 'DockerConnector'
serverUrl : String
apiVersion : String
(optional)
connectTimeout : int
(optional)
connectorType
(optional)
JERSEY
, NETTY
, OKHTTP
credentialsId : String
(optional)
readTimeout : int
(optional)
containerLifecycle
(optional)
createContainer
(optional)
bindAllPorts : boolean
(optional)
bindPorts : String
(optional)
command : String
(optional)
cpuShares : int
(optional)
cpusetCpus : String
(optional)
cpusetMems : String
(optional)
devicesString : String
(optional)
dnsString : String
(optional)
dockerLabelsString : String
(optional)
entrypoint : String
(optional)
environmentString : String
(optional)
extraHostsString : String
(optional)
hostname : String
(optional)
linksString : String
(optional)
macAddress : String
(optional)
memoryLimit : long
(optional)
networkMode : String
(optional)
privileged : boolean
(optional)
restartPolicy
(optional)
policyName
NO
, UNLESS_STOPPED
, ALWAYS
, ON_FAILURE
maximumRetryCount : int
shmSize : long
(optional)
tty : boolean
(optional)
user : String
(optional)
volumesFromString : String
(optional)
volumesString : String
(optional)
workdir : String
(optional)
image : String
(optional)
pullImage
(optional)
connector
(optional)
$class: 'CloudNameDockerConnector'
cloudName : String
$class: 'DockerConnector'
serverUrl : String
apiVersion : String
(optional)
connectTimeout : int
(optional)
connectorType
(optional)
JERSEY
, NETTY
, OKHTTP
credentialsId : String
(optional)
readTimeout : int
(optional)
credentialsId : String
(optional)
pullStrategy
(optional)
PULL_ALWAYS
, PULL_ONCE
, PULL_LATEST
, PULL_NEVER
registriesCreds
(optional)
registryAddr : String
credentialsId : String
removeContainer
(optional)
force : boolean
(optional)
removeVolumes : boolean
(optional)
stopContainer
(optional)
connector
(optional)
$class: 'CloudNameDockerConnector'
cloudName : String
$class: 'DockerConnector'
serverUrl : String
apiVersion : String
(optional)
connectTimeout : int
(optional)
connectorType
(optional)
JERSEY
, NETTY
, OKHTTP
credentialsId : String
(optional)
readTimeout : int
(optional)
timeout : int
(optional)
executorScript : String
(optional)
longConnector
(optional)
$class: 'CloudNameDockerConnector'
cloudName : String
$class: 'DockerConnector'
serverUrl : String
apiVersion : String
(optional)
connectTimeout : int
(optional)
connectorType
(optional)
JERSEY
, NETTY
, OKHTTP
credentialsId : String
(optional)
readTimeout : int
(optional)
shellScript : String
(optional)
$class: 'DoguApplicationBuilder'
projectId : String
applicationPath : String
credentialsId : String
$class: 'DoguRoutineBuilder'
projectId : String
routineId : String
credentialsId : String
$class: 'DoktorStep'
server : String
markdownIncludePatterns
value : String
markdownExcludePatterns
value : String
asciidocIncludePatterns
value : String
asciidocExcludePatterns
value : String
$class: 'DotNetCoreRunner'
targetCode : String
//Simple Example public class JenkinsPlugin { public static void ScriptMain() { Console.WriteLine("Hello World from c#!!!"); } }
// Complete example using DotNetTools.Jenkins; using System; public class JenkinsPlugin { public static void ScriptMain(JenkinsManager manager) { Console.WriteLine("Hello World from c#!!!"); manager.SetSessionEnv("PI", Math.PI.ToString()); } }
public void SetSessionEnv(string key, string value); public string GetSessionEnv(string key);
additionalPackages : String
downloadDS
dsn : String
getETag : boolean
(optional)
vol : String
(optional)
downloadProgetPackage
Download options are:
See Inedo documentation.
feedName : String
groupName : String
packageName : String
version : String
downloadFormat : String
downloadFolder : String
If a full pathname is not supplied then the downloaded package 'should' end up in the workspace, but this is not guaranteed. If you wish the package to be placed in the workspace the it is best to use the Jenkins variable ${WORKSPACE}
crxDownload
packageIds : String
(optional)
baseUrl : String
(optional)
username[:password]@
between the scheme and the hostname.
credentialsId : String
(optional)
/$username/keys/$fingerprint
.
ignoreErrors : boolean
(optional)
localDirectory : String
(optional)
rebuild : boolean
(optional)
requestTimeout : long
(optional)
serviceTimeout : long
(optional)
waitDelay : long
(optional)
googleStorageDownload
credentialsId : String
bucketUri : String
This specifies the cloud object to download from Cloud Storage. You can view these by visiting the "Cloud Storage" section of the Cloud Console for your project.
A single asterisk can be specified in the object path (not the bucket name), past the last "/". The asterisk behaves consistently with gsutil. For example, gs://my-bucket-name/pre/a_*.txt
would match the objects in cloud bucket my-bucket-name
that are named pre/a_2.txt
or pre/a_abc23-4.txt
, but not pre/a_2/log.txt
.
localDirectory : String
The local directory that will store the downloaded files. The path specified is considered relative to the build's workspace. Example value:
pathPrefix : String
(optional)
The specified prefix will be stripped from all downloaded filenames. Filenames that do not start with this prefix will not be modified. If this prefix does not have a trailing slash, it will be added automatically.
$class: 'DoxygenBuilder'
doxyfilePath : String
installationName : String
continueOnBuildFailure : boolean
unstableIfWarnings : boolean
$class: 'DrMemoryBuilder'
executable : String
arguments : String
logPath : String
treatFailed : boolean
$class: 'DropAllBuilder'
changeLogFile : String
(optional)
changeLogParameters : String
(optional)
contexts : String
(optional)
credentialsId : String
(optional)
installationName : String
(optional)
labels : String
(optional)
liquibasePropertiesPath : String
(optional)
password : String
(optional)
resourceDirectories : String
(optional)
url : String
(optional)
username : String
(optional)
$class: 'DrupalInstanceBuilder'
db : String
root : String
profile : String
refresh : boolean
If checked, every build will wipe out and recreate a fresh Drupal instance.
Note that creating a fresh Drupal instance sends an email to the site administrator (by default admin@example.net) which may be annoying.
updb : boolean
$class: 'DrupalReviewBuilder'
Review code using the Coder Review module.
If your code base does not include Coder, then Coder will be downloaded automatically.
style : boolean
comment : boolean
sql : boolean
security : boolean
i18n : boolean
root : String
logs : String
except : String
Specify modules/themes that should not be reviewed, relative to the Drupal root directory.
For instance if you want to review only custom code then you might want to exclude contributed and core projects:
sites/all/modules/contrib/**, sites/all/themes/contrib/**, modules/**, themes/**, profiles/**
This field supports FileSet includes.
ignoresPass : boolean
If checked, warnings flagged as ignored will pass.
Note that the ignore system was introduced in Coder 7.x-2.4. This option will be ignored if using an older version of Coder.
$class: 'DrupalTestsBuilder'
uri : String
root : String
logs : String
exceptGroups : String
Actions, Aggregator, AJAX, Batch API, Block, Blog, Book, Bootstrap, Cache, Color, Comment, Contact, Contextual, Dashboard, Database, DBLog, Entity API, Field API, Field types, Field UI, File, File API, File API (remote), Filter, Form API, Forum, Help, Image, Locale, Mail, Menu, Module, Node, OpenID, Pager, Path, Path API, PHP, Poll, Profile, RDF, Search, Session, Shortcut, SimpleTest, Statistics, Syslog, System, Taxonomy, Theme, Tracker, Translation, Trigger, Update, Update API, Upgrade path, User, XML-RPCMultiple groups can be separated by a comma.
exceptClasses : String
Specify Simpletest classes that should not be tested, for instance 'UserLoginTestCase'.
Multiple classes can be separated by a comma.
$class: 'ECXCDMBuilder'
name : String
password : String
url : String
job : String
production : boolean
maxWaitTime : int
$class: 'EclipseBuckminsterBuilder'
installationName : String
commands : String
logLevel : String
params : String
targetPlatformName : String
userTemp : String
userOutput : String
userCommand : String
userWorkspace : String
globalPropertiesFile : String
equinoxLauncherArgs : String
$class: 'EditVirtualService'
config : String
eggplantRunner
CACertPath : String
(optional)
backoffFactor : String
(optional)
clientId : String
(optional)
clientSecret
(optional)
class hudson.util.Secret
dryRun : boolean
(optional)
eggplantRunnerPath : String
(optional)
logLevel
(optional)
INFO
, DEBUG
, WARNING
, ERROR
modelName : String
(optional)
pollInterval : String
(optional)
requestRetries : String
(optional)
requestTimeout : String
(optional)
serverURL : String
(optional)
suiteName : String
(optional)
testConfig
(optional)
$class: 'ModelBased'
name : String
model : String
$class: 'ScriptBased'
name : String
suite : String
$class: 'TestConfigId'
id : String
testConfigId : String
(optional)
testConfigName : String
(optional)
testEnvironmentTimeout : String
(optional)
testResultPath : String
(optional)
$class: 'ElasticsearchQueryBuilder'
query : String
aboveOrBelow : String
threshold : long
since : long
units : String
$class: 'EnableVirtualService'
serviceName : String
$class: 'EndAnalysisBuildStep'
restoreBuildFile
shouldRestore : boolean
folders : String
parentPom : String
$class: 'EnvInjectBuilder'
propertiesFilePath : String
propertiesContent : String
$class: 'EnvPropagatorBuilder'
envVariableString : String
$class: 'EnvironmentManagerBuilder'
systemId : int
environmentId : int
instanceId : int
copyToServer : boolean
newEnvironmentName : String
serverType : String
serverId : int
serverHost : String
serverName : String
copyDataRepo : boolean
repoType : String
repoHost : String
repoPort : int
repoUsername : String
repoPassword : String
abortOnFailure : boolean
$class: 'EnvironmentTagBuilder'
credentials : String
region : String
$class: 'EstimateBuilder'
name : String
token : String
archiveFilePath : String
regWhichIncludedModules : String
reportConfigName : String
uri : String
saasuri : String
language : String
regexExclude : String
testOnly : boolean
maxNumberOfViolations : long
failBlockTotalVio : boolean
maxNumberOfBlockerViolations : long
failBlockBlockerVio : boolean
maxNumberOfImportantViolations : long
failBlockImportantVio : boolean
maxNumberOfOptimizationViolations : long
failBlockOptimizationVio : boolean
maxNumberOfWarningViolations : long
failBlockWarningVio : boolean
examTest_ExecutionFile
examName : String
pythonName : String
examReport : String
systemConfiguration : String
(optional)
clearWorkspace : boolean
(optional)
javaOpts : String
(optional)
logging : boolean
(optional)
loglevelLibCtrl : String
(optional)
loglevelTestCtrl : String
(optional)
loglevelTestLogic : String
(optional)
pathExecutionFile : String
(optional)
pathPCode : String
(optional)
pdfMeasureImages : boolean
(optional)
pdfReport : boolean
(optional)
pdfReportTemplate : String
(optional)
pdfSelectFilter : String
(optional)
reportPrefix : String
(optional)
testrunFilter
(optional)
name : String
value : String
adminCases : boolean
activateTestcases : boolean
timeout : int
(optional)
examTest_Model
examName : String
pythonName : String
examReport : String
executionFile : String
(optional)
systemConfiguration : String
(optional)
clearWorkspace : boolean
(optional)
examModel : String
(optional)
javaOpts : String
(optional)
logging : boolean
(optional)
loglevelLibCtrl : String
(optional)
loglevelTestCtrl : String
(optional)
loglevelTestLogic : String
(optional)
modelConfiguration : String
(optional)
pdfMeasureImages : boolean
(optional)
pdfReport : boolean
(optional)
pdfReportTemplate : String
(optional)
pdfSelectFilter : String
(optional)
reportPrefix : String
(optional)
testrunFilter
(optional)
name : String
value : String
adminCases : boolean
activateTestcases : boolean
timeout : int
(optional)
runexe
exeName : String
cmdLineArgs : String
(optional)
failBuild : boolean
(optional)
executeCerberusCampaign
campaignName : String
environment : String
browser : String
screenshot : String
verbose : String
pageSource : String
seleniumLog : String
timeOut : String
retries : String
priority : String
tag : String
ss_p : String
ssIp : String
robot : String
manualHost : String
manualContextRoot : String
country : String
cerberusUrl : String
timeOutForCampaignExecution : int
executor : String
$class: 'ExecuteCommandAction'
command : String
search : String
issueInText : String
comment : String
commentVisibility : String
jobDsl
additionalClasspath : String
(optional)
additionalParameters
(optional)
java.util.Map<java.lang.String, java.lang.Object>
failOnMissingPlugin : boolean
(optional)
failOnSeedCollision : boolean
(optional)
ignoreExisting : boolean
(optional)
ignoreMissingFiles : boolean
(optional)
lookupStrategy
(optional)
JENKINS_ROOT
, SEED_JOB
removedConfigFilesAction
(optional)
Note: when using multiple Job DSL build steps in a single job, set this to "Delete" only for the last Job DSL build step. Otherwise config files may be deleted and re-created. See JENKINS-44142 for details.
IGNORE
, DELETE
removedJobAction
(optional)
Note: when using multiple Job DSL build steps in a single job, set this to "Delete" or "Disable" only for the last Job DSL build step. Otherwise jobs will be deleted and re-created or disabled and re-enabled and you may lose the job history of generated jobs. See JENKINS-44142 for details.
IGNORE
, DISABLE
, DELETE
removedViewAction
(optional)
Note: when using multiple Job DSL build steps in a single job, set this to "Delete" only for the last Job DSL build step. Otherwise views may be deleted and re-created. See JENKINS-44142 for details.
IGNORE
, DELETE
sandbox : boolean
(optional)
scriptText : String
(optional)
targets : String
(optional)
Scripts are executed in the same order as specified. The execution order of expanded wildcards is unspecified.
unstableOnDeprecation : boolean
(optional)
useScriptText : boolean
(optional)
$class: 'ExecuteJobBuilder'
jobId : long
jobName : String
jobType : String
abortOnFailure : boolean
abortOnTimeout : boolean
timeoutMinutes : int
publish : boolean
projectId : long
buildId : String
sessionTag : String
appendEnv : boolean
executeKatalon
version : String
location : String
executeArgs : String
x11Display : String
xvfbConfiguration : String
executeKatalonTestOps
credentialsId : String
serverUrl : String
projectId : String
planId : String
execMan
requestType : String
(optional)
altEMConfig
(optional)
url : String
credentials : String
bookmark
(optional)
name : String
folder : String
(optional)
execParams
(optional)
list
(optional)
key : String
value : String
postExecute
(optional)
action : String
params : String
processList
(optional)
database : String
project : String
processes
processPath : String
folder : String
requestName : String
request
(optional)
name : String
waitConfig
(optional)
pollInterval : String
maxRunTime : String
$class: 'ExecuteStepBuilder'
server : String
authenticationType : String
userName : String
password
class hudson.util.Secret
database : String
filesToExecute : String
compareOptions : String
(optional)
fileEncoding : String
(optional)
filterFile : String
(optional)
ignoreError : boolean
(optional)
transactionIsoLvl : String
(optional)
zipPassword
(optional)
class hudson.util.Secret
executeTestsFromAlmOctane
Mode | Explanation |
Execute suite runs in ALM Octane | Execute suites according to specified suite IDs. New suite runs will be created and executed in ALM Octane. Jenkins job is finished after triggering the suite runs. The job does not wait until the suite runs are finished. This method is useful if you want to schedule suite execution in ALM Octane. By default, newly created suite runs will have name of suite and will be assigned to default release. In order to override this default behaviour, add following parameters (one or more) to job with your desired values:
|
Get tests from suites and trigger execution jobs | Get tests from suites and trigger execution jobs : Get tests from specified suite IDs. (This method assumes that tests are assigned to test runner jobs from the current Jenkins.) Tests are send to execution by their assigned test runner jobs. The main job is finished after the test runner jobs are finished. This method is useful if you intend to add your job to the ALM Octane Pipeline module. |
configurationId : String
workspaceId : String
executionMode : String
ids : String
executeCloudifyWorkflow
credentialsId : String
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
debugOutput : boolean
(optional)
deploymentId : String
(optional)
executionParameters : String
(optional)
Parameters to pass to the execution, in YAML/JSON format.
printLogs : boolean
(optional)
tenant : String
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
waitForCompletion : boolean
(optional)
workflowId : String
(optional)
The ID of the workflow to execute.
$class: 'ExecutorBuildStep'
frameworkType : String
runningType : String
app : String
testApplication : String
deviceQueries : String
Other field that can be used:
runTags : String
executorOptions
maxDevices : int
Accepted value: [1..1000]. Default is 10
Set the maximum number of devices to allocate for this step execution.
Only applicable for Fast feedback mode.
minDevices : int
Accepted value: [1..1000]. Default is 10
Set the minimum number of devices to allocate for this step execution.
Only applicable for Fast feedback mode.
ignoreTestsFile : String
overallExecTimeout : int
creationTimeout : int
exportIpa
appURL : String
(optional)
archiveDir : String
(optional)
Specify the location of the path (usually BUILD_DIR specified by xcodebuild) to read the Archive for exporting the IPA file.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/build
assetPackManifestURL : String
(optional)
compileBitcode : boolean
(optional)
copyProvisioningProfile : boolean
(optional)
developmentTeamID : String
(optional)
developmentTeamName : String
(optional)
displayImageURL : String
(optional)
fullSizeImag