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
azureCredentialsId
String
resourceGroupName
String
containerService
String
sshCredentialsId
The username and private key credential used to authenticate with the ACS clusters master node. This is the private key paired with the SSH RSA public key provided when you create the ACS cluster (see Deploy a Docker container hosting solution using the Azure portal ).
The username and key credentials can be updated from Azure Portal. Find the Virtual Machine for your ACS cluster master node from the portal, and you can update the credential from SUPPORT + TROUBLESHOOTING >>> Reset password page.
String
configFilePaths
The path patterns for the specific cluster (Kubernetes, DC/OS, Docker Swarm) configurations you want to deploy, in the form of Ant glob syntax.
String
containerRegistryCredentials
(optional)
url
https://index.docker.io/v1/
).
String
credentialsId
String
dcosDockerCredenditalsPathShared
(optional)
Determine if the Docker credentials archive upload path specified above is shared among all the agents.
To ease the shared files access, we may create share file storage for all the DC/OS agent nodes as this documentation (Create and mount a file share to a DC/OS cluster) suggests. With the help of the shared storage, we only need to upload the Docker credentials archive to the shared storage once, and all the agent nodes get the access to the resource immediately.
Check this option if the Docker credentials archive upload path is a shared storage path.
boolean
dcosDockerCredentialsPath
(optional)
The path on the DC/OS cluster agent nodes to store the docker credentials archive docker.tar.gz
. Only absolute path is allowed here. Environment variable substitution is enabled for the path input. Due to the limitation in the underlying Mesos fetcher used by Marathon, special characters that need URI escaping and the character set {single quote ('), back slash (\), nul (\0)}, are not allowed in the path, otherwise it will fail to load the resource before running the container.
If not specified, the plugin will generate a path specific for the build with the following pattern.
/home/<linuxAdminUser>/acs-plugin-dcos.docker/<unique-name-generated-for-the-build>
The plugin will generate the docker credentials archive with the credentials provided, and upload the archive to the given path for all the agents. You can use it to construct the URI used in your Marathon application definition.
"uris": [
"file://<filled-path>/docker.tar.gz"
]
The URI will be exposed with the environment variable $MARATHON_DOCKER_CFG_ARCHIVE_URI
. You can use this in your Marathon application definition when the "Enable Variable Substitution in Config" option is enabled. This helps when the upload path is not filled and generated by the build, or if the path changes frequently.
Note that if an archive exists in the target path already, the build will overwrite that file.
Reference: Marathon: Using a Private Docker Registry
String
enableConfigSubstitution
(optional)
$VARIABLE
or ${VARIABLE}
) in the configuration with values from Jenkins environment variables.
This allows you to use dynamic values produced during the build in your Kubernetes or DC/OS configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.
boolean
secretName
(optional)
imagePullSecrets
entry. Environment variable substitution are supported for the name input, so you can use available environment variables to construct the name dynamically, e.g., some-secret-$BUILD_NUMBER
. The name should be in the pattern [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*
, i.e., dot (.) concatenated sequences of hyphen (-) separated alphanumeric words. (See Kubernetes Names)
If left blank, the plugin will generate a name based on the build name.
The secret name will be exposed with the environment variable $KUBERNETES_SECRET_NAME
. You can use this in your Kubernetes configuration to reference the updated secret when the "Enable Variable Substitution in Config" option is enabled.
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: nginx
spec:
replicas: 1
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: some.private.registry.domain/nginx
ports:
- containerPort: 80
imagePullSecrets:
- name: $KUBERNETES_SECRET_NAME
Note that once the secret is created, it will only be updated by the plugin. You have to manually delete it when it is not used anymore. If this is a problem, you may use fixed name so every time the job runs, the secret gets updated and no new secret is created.
String
secretNamespace
(optional)
String
swarmRemoveContainersFirst
(optional)
boolean
ACXScanBuilder
ncScanType
String
ncWebsiteId
String
ncProfileId
String
ncDoNotFail
(optional)
boolean
acxServerURL
(optional)
String
credentialsId
(optional)
String
ncApiToken
(optional)
Object
ncConfirmed
(optional)
boolean
ncIgnoreFalsePositive
(optional)
boolean
ncIgnoreRiskAccepted
(optional)
boolean
ncSeverity
(optional)
String
ncStopScan
(optional)
boolean
cfyAzureArm
azureCredentialsId
(optional)
The ID of the credentials to use when accessing Azure. Parameters' expansion is supported when using freestyle jobs.
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deploymentId
(optional)
String
echoEnvData
(optional)
If checked, then the created environment's data will be printed to the job's log.
boolean
echoInputs
(optional)
boolean
envDataLocation
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
String
location
(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.
String
parameters
(optional)
YAML/JSON of parameters to pass to the template.
java.util.Map<java.lang.String, java.lang.Object>
parametersAsString
(optional)
String
parametersFile
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
String
resourceGroupName
(optional)
Name of resource group to create for the template.
String
templateFile
(optional)
Workspace-relative path of the ARM template file.
String
tenant
(optional)
String
$class: 'AWSEBBuilder'
extensions
awsRegion
GovCloud
, US_EAST_1
, US_EAST_2
, US_WEST_1
, US_WEST_2
, EU_WEST_1
, EU_WEST_2
, EU_CENTRAL_1
, AP_SOUTH_1
, AP_SOUTHEAST_1
, AP_SOUTHEAST_2
, AP_NORTHEAST_1
, AP_NORTHEAST_2
, SA_EAST_1
, CN_NORTH_1
, CN_NORTHWEST_1
, CA_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
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
String
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
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
String
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
(optional)
String
awsRegion
(optional)
String
bucketName
(optional)
S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
(Optional, will call createStorageLocation
if blank)
String
checkHealth
(optional)
boolean
credentialId
(optional)
String
environmentName
(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.
String
excludes
(optional)
String
includes
(optional)
String
keyPrefix
(optional)
String
maxAttempts
(optional)
int
rootObject
(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). String
skipEnvironmentUpdates
(optional)
boolean
sleepTime
(optional)
int
versionDescriptionFormat
(optional)
String
versionLabelFormat
(optional)
String
zeroDowntime
(optional)
boolean
awsebReleaser
credentialId
String
awsRegion
String
applicationName
String
environmentId
String
versionLabel
String
abapCi
abapPackagename
(optional)
String
atcVariant
(optional)
String
sapSystemLabel
(optional)
String
runAtcChecks
(optional)
boolean
runUnitTests
(optional)
boolean
treatWarningAtcChecksAsErrors
(optional)
boolean
useJenkinsProjectName
(optional)
boolean
withCoverage
(optional)
boolean
$class: 'ActionHubPlugin'
snActivatePlugin
credentialsId
(optional)
String
apiVersion
(optional)
String
pluginId
(optional)
String
url
(optional)
String
$class: 'AddComment'
prefix
String
note
String
logfile
String
$class: 'AddTestToSetStep'
domain
String
project
String
testPlanPath
String
testSetPath
String
$class: 'AmxEclipseAntBuilder'
targets
String
name
Jenkins supplies some environment variables that can be used from within the build script.
String
antOpts
String
buildFile
String
properties
# 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
String
amxEclipseAntTra
String
businessStudioWs
String
anchore
name
String
annotations
(optional)
key
String
value
String
autoSubscribeTagUpdates
(optional)
boolean
bailOnFail
(optional)
boolean
bailOnPluginFail
(optional)
boolean
engineCredentialsId
(optional)
String
engineRetries
(optional)
String
engineurl
(optional)
String
engineverify
(optional)
boolean
forceAnalyze
(optional)
boolean
policyBundleId
(optional)
String
$class: 'AnsibleAdHocCommandBuilder'
hostPattern
String
inventory
$class: 'InventoryContent'
content
String
dynamic
boolean
$class: 'InventoryDoNotSpecify'
$class: 'InventoryPath'
path
String
module
String
command
String
additionalParameters
(optional)
String
ansibleName
(optional)
String
becomeUser
(optional)
String
colorizedOutput
(optional)
boolean
credentialsId
(optional)
String
disableHostKeyChecking
(optional)
boolean
extraVars
(optional)
hidden
(optional)
boolean
key
(optional)
String
value
(optional)
String
forks
(optional)
int
hostKeyChecking
(optional)
boolean
sudo
(optional)
boolean
sudoUser
(optional)
String
unbufferedOutput
(optional)
boolean
vaultCredentialsId
(optional)
String
cfyAnsible
additionalArgs
(optional)
String
ansibleEnvVars
(optional)
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugLevel
(optional)
int
debugOutput
(optional)
boolean
deploymentId
(optional)
String
echoEnvData
(optional)
boolean
echoInputs
(optional)
boolean
envDataLocation
(optional)
String
optionsConfig
(optional)
String
playbookPath
(optional)
String
remergeSources
(optional)
boolean
runData
(optional)
String
savePlaybook
(optional)
boolean
scpExtraArgs
(optional)
String
sensitiveKeys
(optional)
String
sftpExtraArgs
(optional)
String
sourcePath
(optional)
String
sources
(optional)
String
sshCommonArgs
(optional)
String
sshExtraArgs
(optional)
String
startAtTask
(optional)
String
tenant
(optional)
String
timeout
(optional)
int
$class: 'AnsiblePlaybookBuilder'
playbook
String
inventory
$class: 'InventoryContent'
content
String
dynamic
boolean
$class: 'InventoryDoNotSpecify'
$class: 'InventoryPath'
path
String
additionalParameters
(optional)
String
ansibleName
(optional)
String
becomeUser
(optional)
String
colorizedOutput
(optional)
boolean
credentialsId
(optional)
String
disableHostKeyChecking
(optional)
boolean
extraVars
(optional)
hidden
(optional)
boolean
key
(optional)
String
value
(optional)
String
forks
(optional)
int
hostKeyChecking
(optional)
boolean
limit
(optional)
String
skippedTags
(optional)
String
startAtTask
(optional)
String
sudo
(optional)
boolean
sudoUser
(optional)
String
tags
(optional)
String
unbufferedOutput
(optional)
boolean
vaultCredentialsId
(optional)
String
$class: 'AnsibleTower'
towerServer
(optional)
String
jobTemplate
(optional)
String
towerCredentialsId
(optional)
String
jobType
(optional)
String
extraVars
(optional)
String
jobTags
(optional)
String
skipJobTags
(optional)
String
limit
(optional)
String
inventory
(optional)
String
credential
(optional)
String
scmBranch
(optional)
String
verbose
(optional)
boolean
importTowerLogs
(optional)
boolean
removeColor
(optional)
boolean
templateType
(optional)
String
importWorkflowChildLogs
(optional)
boolean
$class: 'AnsibleTowerProjectRevisionFreestyle'
towerServer
(optional)
String
towerCredentialsId
(optional)
String
project
(optional)
String
revision
(optional)
String
verbose
(optional)
boolean
throwExceptionWhenFail
(optional)
boolean
$class: 'AnsibleTowerProjectSyncFreestyle'
towerServer
(optional)
String
towerCredentialsId
(optional)
String
project
(optional)
String
verbose
(optional)
boolean
importTowerLogs
(optional)
boolean
removeColor
(optional)
boolean
$class: 'AnsibleVaultBuilder'
action
(optional)
String
ansibleName
(optional)
String
content
(optional)
String
input
(optional)
String
newVaultCredentialsId
(optional)
String
output
(optional)
String
vaultCredentialsId
(optional)
String
ant
Jenkins supplies some environment variables that can be used from within the build script.
targets
String
antName
String
antOpts
-Xmx512m
. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
String
buildFile
build.xml
in the root directory; this option can be used to use build files with a different name or in a subdirectory.
String
properties
# 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=
String
$class: 'AntExec'
scriptSource
String
extendedScriptSource
String
scriptName
String
properties
# 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=
String
antName
String
antOpts
String
keepBuildfile
boolean
verbose
boolean
emacs
boolean
noAntcontrib
Disabling usage of Ant-Contrib Tasks in this build step.
boolean
antws
Jenkins supplies some environment variables that can be used from within the build script.
targets
String
antName
String
antOpts
-Xmx512m
. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
String
buildFile
build.xml
in the root directory; this option can be used to use build files with a different name or in a subdirectory.
String
properties
# 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=
String
$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
(optional)
String
loginPassword
(optional)
String
loginUser
(optional)
String
optimization
(optional)
String
presenceId
(optional)
String
scanFile
(optional)
String
scanType
(optional)
String
testPolicy
(optional)
String
mobile_analyzer
target
String
hasOptions
boolean
extraField
(optional)
String
loginPassword
(optional)
String
loginUser
(optional)
String
presenceId
(optional)
String
static_analyzer
target
String
hasOptions
boolean
openSourceOnly
(optional)
boolean
name
String
type
String
application
String
credentials
String
email
(optional)
boolean
failBuild
(optional)
boolean
failBuildNonCompliance
(optional)
boolean
failureConditions
(optional)
failureType
String
threshold
int
target
(optional)
String
wait
(optional)
boolean
appscanenterprise
credentials
String
folder
String
testPolicy
String
template
String
jobName
String
accessId
(optional)
String
agent
(optional)
String
application
(optional)
String
email
(optional)
boolean
exploreData
(optional)
String
failBuild
(optional)
boolean
failureConditions
(optional)
failureType
String
threshold
int
loginType
(optional)
String
scanType
(optional)
String
secretKey
(optional)
String
target
(optional)
String
testOptimization
(optional)
String
trafficFile
(optional)
String
wait
(optional)
boolean
$class: 'AppScanSourceBuilder'
disableScan
boolean
applicationFile
String
acceptSSL
boolean
customScanWorkspace
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.
String
installation
(optional)
String
$class: 'AppScanStandardBuilder'
startingURL
Spiders will find the remaining URLs in the domain to be included for scanning.
String
installation
String
additionalCommands
(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
String
authScan
(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.
boolean
authScanPw
(optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
String
authScanRadio
(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.
boolean
authScanUser
(optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
String
generateReport
(optional)
The report is available in HTML and PDF.
The HTML report generated is ready to be integrated with the HTML Publisher Plugin.
boolean
htmlReport
(optional)
boolean
includeURLS
(optional)
Some URLs might not be found by AppScan Standard's spiders, include them to get the best possible coverage.
String
pathRecordedLoginSequence
(optional)
String
pdfReport
(optional)
boolean
policyFile
(optional)
A Test Policy File can be created following these steps:
"Scan" > "Scan Configuration" > "Test Policy" > "Export".
String
reportName
(optional)
To configure HTML Publisher Plugin properly, the names in the configuration must match.
String
verbose
(optional)
boolean
xooa
name
String
appId
String
$class: 'AppUploaderBuilder'
buildFilePath
String
applatix
axUrl
String
axUsername
String
axPassword
String
axServiceTemplateName
String
axServiceTemplateRepository
String
axServiceTemplateBranch
String
axServiceTemplateParameters
key
String
value
String
snApplyChanges
credentialsId
(optional)
String
apiVersion
(optional)
String
appScope
(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.
String
appSysId
(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.
String
branchName
(optional)
String
url
(optional)
String
$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
localToken
class hudson.util.Secret
customFlags
String
tarFilePath
(optional)
String
containerRuntime
(optional)
String
scannerPath
(optional)
String
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
$class: 'ArtifactDeployerBuilder'
includes
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.
String
basedir
By default, the basedir is the job workspace.
Give a value to override the default value.
Path relative to workspace is permitted.
String
excludes
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.
String
remote
Artifacts will be deployed in the specified output directory.
The remote location must be accessible through the build machine (master/slave node).
If you want to have the ability to download deployed artifacts through the Jenkins dashboard, the location must be accessible from the Jenkins master.
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 an Unix machine.
String
flatten
Ignore the directory structure of the source files, and deploy all the artifacts into the output directory.
boolean
deleteRemote
Delete the output directory before deploying artifacts.
boolean
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
'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.
boolean
artifactResolver
artifacts
groupId
String
artifactId
String
version
String
classifier
(optional)
String
deployToLocal
(optional)
boolean
deployToRemote
(optional)
boolean
extension
(optional)
String
failOnError
(optional)
boolean
pomFile
(optional)
String
targetFileName
(optional)
String
enableRepositoryLogging
(optional)
boolean
enableTransferLogging
(optional)
boolean
repositoryId
(optional)
String
targetDirectory
(optional)
String
artifactVersion
name
(optional)
String
description
(optional)
String
type
(optional)
String
groupId
(optional)
String
artifactId
(optional)
String
stage
(optional)
String
flow
(optional)
String
stageDescription
(optional)
String
version
(optional)
String
artifactVersion
variableName
String
name
(optional)
String
stage
(optional)
String
version
(optional)
String
assertthatBddFeatures
projectId
String
credentialsId
String
outputFolder
String
jql
String
tags
String
mode
String
proxyURI
String
proxyUsername
String
proxyPassword
String
jiraServerUrl
String
$class: 'AssetBuilder'
name
String
description
String
version
String
vendor
String
platform
String
architecture
String
bits
String
cpu
int
memory
int
storage
int
installationScriptFilePath
String
mediaFilePaths
path
String
licenseFilePath
String
documentationFilePath
String
$class: 'AssociateItemToRelease'
releasePrefix
String
itemPrefix
String
associateTag
nexusInstanceId
String
tagName
String
search
key
String
value
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
(optional)
String
minScore
(optional)
int
platformUrl
(optional)
String
branchName
(optional)
String
logLevel
(optional)
String
repositoryName
(optional)
String
shareEveryone
(optional)
String
$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
$class: 'AutoConfigBuilder'
name
String
discobitUrl
String
discobitUser
String
discobitPassword
class hudson.util.Secret
configurations
String
cuuid
String
$class: 'Autogen'
element
Specify the name of the element in your CA 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.
String
environment
Provide the environment for the CA Endevor® sandbox that you want to include in the autogeneration process, for example, DEV.
String
system
Provide the system name for the environment in your CA Endevor® sandbox that you want to include in the autogeneration process, for example, APCTTC0.
String
subsystem
Provide the subsystem name for the environment in your CA Endevor® sandbox that you want to include in the autogeneration process, for example, TESTCICD.
String
stage
Specify the environment stage in your CA Endevor® that you want to include in the autogeneration process, for example, 1.
String
instance
Specify the instance name of the environment that is associated with CA Endevor® Web services, for example, WEBSMFNE.
String
signout
Select this option to work with elements in CA 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.
boolean
$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
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).
String
upstreamBuildNumber
String
lastWithArtifacts
lastCompleted
$class: 'MultiJobBuildSelector'
buildParameter
parameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
String
permalink
id
String
$class: 'PromotedBuildSelector'
level
int
latestSavedBuild
specific
buildNumber
String
lastSuccessful
stable
(optional)
boolean
upstream
allowUpstreamDependencies
(optional)
boolean
fallbackToLastSuccessful
(optional)
boolean
upstreamFilterStrategy
(optional)
UseGlobalSetting
, UseOldest
, UseNewest
workspace
containerName
(optional)
String
deleteFromAzureAfterDownload
(optional)
boolean
downloadDirLoc
(optional)
String
excludeFilesPattern
(optional)
String
fileShare
(optional)
String
flattenDirectories
(optional)
boolean
includeArchiveZips
(optional)
boolean
includeFilesPattern
(optional)
String
projectName
(optional)
String
verbose
(optional)
Enabling this will provide more logging on downloading files.
boolean
$class: 'BDSBuilder'
projectFile
String
switches
String
installationName
String
$class: 'BapFtpBuilder'
publishers
configName
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.
String
verbose
boolean
transfers
sourceFiles
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.
String
excludes
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)
String
remoteDirectory
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.
String
removePrefix
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.
String
asciiMode
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.
boolean
remoteDirectorySDF
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 |
boolean
flatten
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.
boolean
cleanRemote
Select to delete all files and directories within the remote directory before transferring files.
boolean
noDefaultExcludes
boolean
makeEmptyDirs
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.
boolean
patternSeparator
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.
String
useWorkspaceInPromotion
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
boolean
usePromotionTimestamp
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.
boolean
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
Set the label for this Server instance - for use with Parameterized publishing.
Expand the help for Parameterized publishing for more details.
String
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
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
(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.
boolean
variables
(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.
String
unstableReturn
(optional)
int
snBatchInstall
credentialsId
(optional)
String
apiVersion
(optional)
String
batchName
(optional)
String
file
(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
.
String
notes
(optional)
Default: null
String
packages
(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:
|
String
url
(optional)
String
useFile
(optional)
Default: false
boolean
snBatchRollback
credentialsId
(optional)
String
apiVersion
(optional)
String
rollbackId
(optional)
sys_id
) of the rollback installed before.
String
url
(optional)
If ServiceNow Parameters are used, then the URL of installation instance will be used.
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
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) |
String
includeResources
boolean
benchmark
filepath
String
$class: 'BitbucketPublisher'
serverUrl
(optional)
String
credentialsId
(optional)
String
projectKey
(optional)
String
createProject
(optional)
projectName
String
projectUsers
String
projectGroups
String
createJenkinsJobs
(optional)
ciServer
String
projectName
(optional)
String
$class: 'BladeBuilder'
blades
$class: 'CodeScan'
source
String
exclude
String
noCache
boolean
noProxy
boolean
noBlame
boolean
ruleset
String
severityLevel
String
severityThreshold
int
autoUpdate
(optional)
boolean
credentialsId
(optional)
String
debug
(optional)
boolean
directory
(optional)
String
environment
(optional)
String
forceVersion
(optional)
String
ignoreFailure
(optional)
boolean
onFailureCmd
(optional)
String
timeout
(optional)
int
$class: 'ImageScan'
image
String
exclude
String
noCache
boolean
noProxy
boolean
noBlame
boolean
ruleset
String
severityLevel
String
severityThreshold
int
autoUpdate
(optional)
boolean
credentialsId
(optional)
String
debug
(optional)
boolean
directory
(optional)
String
environment
(optional)
String
forceVersion
(optional)
String
ignoreFailure
(optional)
boolean
onFailureCmd
(optional)
String
timeout
(optional)
int
$class: 'BlueprintLaunch'
projectName
Project selection is mandatory.
String
blueprintName
Blueprint selection is mandatory.
String
applicationName
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.
String
appProfileName
Application Profile selection is mandatory.
String
actionName
The field is mandatory
Select the required action need to run after the application launch from the list of actions, else please select none.
String
runtimeVariables
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.
String
waitForSuccessFulLaunch
boolean
blueprintDescription
Description is fetched from the selected Calm blueprint
String
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
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)
boolean
bmcDb2log
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.
boolean
db2log
String
db2bsds
String
limit
String
skip
String
maxlogs
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).
String
bmcDb2bsds
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:
boolean
bmcLimit
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:
boolean
bmcSkip
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.
boolean
bmcActiveOlds
boolean
bmcImsid
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.
boolean
bmcDlilog
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:
boolean
bmcMaxlogs
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:
boolean
bmcJobname
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:
boolean
cfaImsids
imsid
String
bmcRecon
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.
boolean
bmcTimezone
boolean
bmcStartInterval
You can use the START keyword on the INTERVAL control statement for the following purposes:
boolean
bmcStopInterval
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
boolean
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
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)
String
maxlogsAbend
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)
String
bmcJobInc
boolean
bmcJobExc
boolean
bmcPsbInc
boolean
bmcPsbExc
boolean
bmcChkfreq
boolean
bmcThresh
boolean
bmcPrilog
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:
boolean
bmcAppcheck
boolean
bmcAll
boolean
bmcLsec
boolean
chkfreqval
String
bmcPlanInc
boolean
planInclude
String
bmcPlanExc
boolean
planExclude
String
bmcSortby
boolean
bmcCsv
boolean
bmcFullreport
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:
configuration
(optional)
Debug
, but you can override the build configuration settings in your project.
String
force
(optional)
boolean
framework
(optional)
String
noDependencies
(optional)
boolean
noIncremental
(optional)
boolean
noRestore
(optional)
boolean
nologo
(optional)
boolean
option
(optional)
String
options
(optional)
String
optionsString
(optional)
String
outputDirectory
(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.
String
project
(optional)
String
properties
(optional)
java.util.Map<java.lang.String, java.lang.String>
propertiesString
(optional)
String
runtime
(optional)
String
sdk
(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.
String
showSdkInfo
(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.
boolean
shutDownBuildServers
(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).
boolean
specificSdkVersion
(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.
boolean
target
(optional)
String
targets
(optional)
String
targetsString
(optional)
String
unstableIfWarnings
(optional)
boolean
verbosity
(optional)
String
versionSuffix
(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.
String
workDirectory
(optional)
String
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
(optional)
String
baseUrl
(optional)
username[:password]@
between the scheme and the hostname.
String
credentialsId
(optional)
/$username/keys/$fingerprint
.
String
download
(optional)
boolean
localDirectory
(optional)
String
requestTimeout
(optional)
long
serviceTimeout
(optional)
long
waitDelay
(optional)
long
wspFilter
(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.
String
$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
(optional)
String
filterFile
(optional)
String
transactionIsoLvl
(optional)
String
$class: 'BuildStepWithTimeout'
buildStep
hudson.tasks.BuildStep
)strategy
$class: 'AbsoluteTimeOutStrategy'
Abort build based on a fixed time-out.
timeoutMinutes
String
$class: 'DeadlineTimeOutStrategy'
Abort build based on a deadline time specified in HH:MM:SS or HH:MM (24-hour time format).
deadlineTime
String
deadlineToleranceInMinutes
int
$class: 'ElasticTimeOutStrategy'
Define time to wait before killing the build as a percentage of the mean of the duration of the last n successful builds.
timeoutPercentage
String
timeoutMinutesElasticDefault
String
numberOfBuilds
String
failSafeTimeoutDuration
boolean
$class: 'LikelyStuckTimeOutStrategy'
Abort the build when the job has taken many times longer than previous runs.
$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
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
timeout
long
defaultTimeout
long
operationList
$class: 'AbortAndRestartOperation'
maxRestarts
String
$class: 'AbortOperation'
$class: 'BuildStepOperation'
buildstep
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
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
boolean
messageContent
(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}.
String
messageProperties
(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}.
String
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
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
activeMQSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
selector
(optional)
JMS selector to choose messages that will fire the trigger.
String
timeout
(optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
int
variable
(optional)
Environment variable to hold received message content.
String
fedmsgPublisher
failOnError
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
boolean
messageContent
(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}.
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
fedmsgSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
timeout
(optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
int
variable
(optional)
Environment variable to hold received message content.
String
rabbitMQPublisher
failOnError
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
boolean
fedoraMessaging
(optional)
boolean
messageContent
(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}.
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
schema
(optional)
Path to message schema.
String
severity
(optional)
Severity of the message.
int
rabbitMQSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
timeout
(optional)
Value (in minutes) to wait for a message.
int
variable
(optional)
Environment variable to hold received message content.
String
$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
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
boolean
messageContent
(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}.
String
messageProperties
(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}.
String
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
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
activeMQSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
selector
(optional)
JMS selector to choose messages that will fire the trigger.
String
timeout
(optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
int
variable
(optional)
Environment variable to hold received message content.
String
fedmsgPublisher
failOnError
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
boolean
messageContent
(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}.
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
fedmsgSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
timeout
(optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
int
variable
(optional)
Environment variable to hold received message content.
String
rabbitMQPublisher
failOnError
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
boolean
fedoraMessaging
(optional)
boolean
messageContent
(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}.
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
schema
(optional)
Path to message schema.
String
severity
(optional)
Severity of the message.
int
rabbitMQSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
timeout
(optional)
Value (in minutes) to wait for a message.
int
variable
(optional)
Environment variable to hold received message content.
String
$class: 'CRDABuilder'
file
(optional)
String
crdaKeyId
(optional)
String
cliVersion
(optional)
String
consentTelemetry
(optional)
CRDA CLI is constantly improving and we would like to know more about usage. Click here to find more details.
boolean
$class: 'CToolBuilder'
cmake -P <script file>
) or command mode (cmake -E <command>
).
installationName
String
arguments
(optional)
String
ignoredExitCodes
(optional)
String
toolId
(optional)
String
workingDir
(optional)
String
generateCache
caches
type
A2L
, ELF
, BUS
, MODEL
, SERVICE
filePath
String
dbChannel
String
clear
boolean
$class: 'CallFunction'
functionName
(optional)
String
argumentList
(optional)
String
argument
(optional)
String
$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
(optional)
String
engineTimeout
(optional)
int
failBuildOnPluginError
(optional)
boolean
failBuildOnPolicyEvaluationFailResult
(optional)
boolean
image
(optional)
String
policyBundleID
(optional)
String
registryURI
(optional)
String
carl
installationName
String
sourcePath
String
applicationName
String
archivePdf
(optional)
boolean
displayLog
(optional)
boolean
logPath
(optional)
String
outputPath
(optional)
String
qualityGate
(optional)
String
castecho
installationName
String
sourcePath
String
applicationName
String
displayLog
(optional)
boolean
logPath
(optional)
String
outputPath
(optional)
String
qualityGate
(optional)
String
venafiVcertRequestCertificate
connectorName
String
zoneConfigName
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
String
commonName
String
privKeyOutput
String
certOutput
String
certChainOutput
String
country
(optional)
String
dnsNames
(optional)
hostName
String
emailAddresses
(optional)
address
String
expirationWindow
(optional)
int
ipAddresses
(optional)
address
String
keyType
(optional)
RSA
, ECDSA
locality
(optional)
String
organization
(optional)
String
organizationalUnit
(optional)
String
province
(optional)
String
changeAsmVer
versionPattern
String
assemblyCompany
(optional)
String
assemblyCopyright
(optional)
String
assemblyCulture
(optional)
String
assemblyDescription
(optional)
String
assemblyFile
(optional)
String
assemblyProduct
(optional)
String
assemblyTitle
(optional)
String
assemblyTrademark
(optional)
String
regexPattern
(optional)
String
replacementPattern
(optional)
String
$class: 'ChangeEventBuilder'
integrationKey
String
summaryText
(optional)
String
chatterPost
postToChatter "Build Started - ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"
credentialsId
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.
String
body
String
buildUrlTitle
(optional)
String
recordId
(optional)
String
server
(optional)
String
$class: 'CheckGate'
pipelineId
String
stageName
String
versionId
String
fatal
String
$class: 'CheckGateBuilder'
project
String
gate
String
$class: 'ChefBuilderConfiguration'
url
String
sinatraurl
String
filter
String
username
String
port
int
command
String
privatekey
String
parallel
boolean
fail
boolean
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
xcodebuild -showsdks
String
config
String
clangInstallationName
String
xcodeProjectSubPath
String
workspace
String
scheme
String
scanbuildargs
String
xcodebuildargs
String
outputFolderName
String
googleStorageUpload
credentialsId
String
bucket
String
pattern
String
pathPrefix
(optional)
String
sharedPublicly
(optional)
boolean
showInline
(optional)
boolean
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.
configuration
(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.
String
framework
(optional)
String
nologo
(optional)
boolean
option
(optional)
String
options
(optional)
String
optionsString
(optional)
String
outputDirectory
(optional)
String
project
(optional)
String
properties
(optional)
java.util.Map<java.lang.String, java.lang.String>
propertiesString
(optional)
String
runtime
(optional)
String
sdk
(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.
String
showSdkInfo
(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.
boolean
shutDownBuildServers
(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).
boolean
specificSdkVersion
(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.
boolean
unstableIfWarnings
(optional)
boolean
verbosity
(optional)
String
workDirectory
(optional)
String
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
.tgz
or .tar.gz
) or zip file (.zip
), or .tgz
) and uploaded to a temporary Cloud Storage bucket. String
repo
branch
(optional)
String
commit
(optional)
String
projectId
(optional)
String
repoName
(optional)
String
tag
(optional)
String
storage
bucket
String
object
String
substitutionList
(optional)
items
key
_
) 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.
String
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
(optional)
String
appPath
(optional)
String
buildpack
(optional)
String
command
(optional)
String
domain
(optional)
String
envVars
(optional)
key
String
value
String
hostname
(optional)
String
instances
(optional)
String
manifestFile
(optional)
String
memory
(optional)
String
noRoute
(optional)
String
servicesNames
(optional)
name
String
stack
(optional)
String
timeout
(optional)
String
value
(optional)
String
pluginTimeout
(optional)
String
selfSigned
(optional)
String
servicesToCreate
(optional)
name
String
type
String
plan
String
resetService
(optional)
boolean
cloudhubDeployer
environmentId
String
orgId
String
appName
String
muleVersion
String
filePath
String
credentialsId
(optional)
String
requestMode
(optional)
CREATE
, UPDATE
, CREATE_OR_UPDATE
, UPDATE_FILE
, RESTART
, DELETE
region
(optional)
String
autoScalePolicy
(optional)
autoScalePolicyName
(optional)
String
enableAutoScalePolicy
(optional)
boolean
id
(optional)
String
maxScale
(optional)
int
minScale
(optional)
int
scaleBasedOn
(optional)
String
scaleDown
(optional)
class org.jenkinsci.plugins.cloudhubdeployer.data.Scale
scaleDownNextScaleWaitMins
(optional)
int
scaleDownPeriodCount
(optional)
int
scaleDownValue
(optional)
int
scaleType
(optional)
String
scaleUp
(optional)
class org.jenkinsci.plugins.cloudhubdeployer.data.Scale
scaleUpNextScaleWaitMins
(optional)
int
scaleUpPeriodCount
(optional)
int
scaleUpValue
(optional)
int
autoStart
(optional)
boolean
debugMode
(optional)
ENABLED
, DISABLED
enableAutoScalePolicy
(optional)
boolean
envVars
(optional)
key
(optional)
String
value
(optional)
String
ignoreGlobalSettings
(optional)
boolean
logLevels
(optional)
levelCategory
(optional)
DEBUG
, WARN
, ERROR
, INFO
packageName
(optional)
String
loggingNgEnabled
(optional)
boolean
monitoringAutoRestart
(optional)
boolean
monitoringEnabled
(optional)
boolean
objectStoreV1
(optional)
boolean
persistentQueues
(optional)
boolean
persistentQueuesEncrypted
(optional)
boolean
timeoutConnection
(optional)
int
timeoutResponse
(optional)
int
verifyDeployments
(optional)
boolean
verifyIntervalInSeconds
(optional)
int
workerAmount
(optional)
int
workerCpu
(optional)
String
workerMemory
(optional)
String
workerType
(optional)
String
workerWeight
(optional)
String
$class: 'CloudShellConfig'
buildStep
$class: 'StartSandbox'
blueprintName
String
sandboxDuration
String
maxWaitForSandboxAvailability
int
setupTimeout
int
params
(optional)
String
sandboxDomain
(optional)
String
sandboxName
(optional)
String
$class: 'CmakeBuilder'
cmake -G
with the given options.
CMAKE_BUILD_TOOL
build environment variable if the chosen generator supports that.
installationName
String
buildDir
(optional)
String
buildType
(optional)
String
cleanBuild
(optional)
boolean
cmakeArgs
(optional)
String
generator
(optional)
String
preloadScript
(optional)
String
sourceDir
(optional)
String
steps
(optional)
args
(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),
String
envVars
(optional)
DESTDIR=${WORKSPACE}/artifacts/dir
KEY=VALUE
String
withCmake
(optional)
$CMAKE_BUILD_TOOL
) or to have cmake
run the build tool (by invoking cmake --build <dir>
).
boolean
$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
$class: 'CodeCoverageBuilder'
connectionId
String
credentialsId
String
analysisPropertiesPath
String
analysisProperties
String
codescene
credentialsId
String
deltaAnalysisUrl
String
repository
String
analyzeBranchDiff
(optional)
boolean
analyzeLatestIndividually
(optional)
boolean
baseRevision
(optional)
String
couplingThresholdPercent
(optional)
int
failOnDecliningCodeHealth
(optional)
boolean
failOnFailedGoal
(optional)
boolean
letBuildPassOnFailedAnalysis
(optional)
boolean
markBuildAsUnstable
(optional)
boolean
originUrl
(optional)
String
riskThreshold
(optional)
int
$class: 'CodeStreamBuilder'
serverUrl
String
userName
String
password
String
tenant
String
pipelineName
String
waitExec
boolean
pipelineParams
value
String
name
String
$class: 'CodefreshPipelineBuilder'
selectPipeline
cfPipeline
String
cfBranch
String
setCFVars
vars
Variable
String
Value
String
$class: 'CommentsRemoverBuilder'
filename
String
language
String
outputDir
String
$class: 'CompareBuilder'
outputFolder
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:
String
srcInputType
String
tgtInputType
String
srcInputFileOrFolder
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:
String
tgtInputFileOrFolder
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:
String
configFile
Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
File location must be specified as:
String
$class: 'CompareWithBaselineBuilder'
outputFolder
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:
String
srcInputType
String
tgtInputType
String
srcInputFileOrFolder
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:
String
tgtInputFileOrFolder
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:
String
configFile
Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
File location must be specified as:
String
$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
azureCredentialsId
String
resourceGroupName
String
containerService
String
sshCredentialsId
The username and private key credential used to authenticate with the ACS clusters master node. This is the private key paired with the SSH RSA public key provided when you create the ACS cluster (see Deploy a Docker container hosting solution using the Azure portal ).
The username and key credentials can be updated from Azure Portal. Find the Virtual Machine for your ACS cluster master node from the portal, and you can update the credential from SUPPORT + TROUBLESHOOTING >>> Reset password page.
String
configFilePaths
The path patterns for the specific cluster (Kubernetes, DC/OS, Docker Swarm) configurations you want to deploy, in the form of Ant glob syntax.
String
containerRegistryCredentials
(optional)
url
https://index.docker.io/v1/
).
String
credentialsId
String
dcosDockerCredenditalsPathShared
(optional)
Determine if the Docker credentials archive upload path specified above is shared among all the agents.
To ease the shared files access, we may create share file storage for all the DC/OS agent nodes as this documentation (Create and mount a file share to a DC/OS cluster) suggests. With the help of the shared storage, we only need to upload the Docker credentials archive to the shared storage once, and all the agent nodes get the access to the resource immediately.
Check this option if the Docker credentials archive upload path is a shared storage path.
boolean
dcosDockerCredentialsPath
(optional)
The path on the DC/OS cluster agent nodes to store the docker credentials archive docker.tar.gz
. Only absolute path is allowed here. Environment variable substitution is enabled for the path input. Due to the limitation in the underlying Mesos fetcher used by Marathon, special characters that need URI escaping and the character set {single quote ('), back slash (\), nul (\0)}, are not allowed in the path, otherwise it will fail to load the resource before running the container.
If not specified, the plugin will generate a path specific for the build with the following pattern.
/home/<linuxAdminUser>/acs-plugin-dcos.docker/<unique-name-generated-for-the-build>
The plugin will generate the docker credentials archive with the credentials provided, and upload the archive to the given path for all the agents. You can use it to construct the URI used in your Marathon application definition.
"uris": [
"file://<filled-path>/docker.tar.gz"
]
The URI will be exposed with the environment variable $MARATHON_DOCKER_CFG_ARCHIVE_URI
. You can use this in your Marathon application definition when the "Enable Variable Substitution in Config" option is enabled. This helps when the upload path is not filled and generated by the build, or if the path changes frequently.
Note that if an archive exists in the target path already, the build will overwrite that file.
Reference: Marathon: Using a Private Docker Registry
String
enableConfigSubstitution
(optional)
$VARIABLE
or ${VARIABLE}
) in the configuration with values from Jenkins environment variables.
This allows you to use dynamic values produced during the build in your Kubernetes or DC/OS configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.
boolean
secretName
(optional)
imagePullSecrets
entry. Environment variable substitution are supported for the name input, so you can use available environment variables to construct the name dynamically, e.g., some-secret-$BUILD_NUMBER
. The name should be in the pattern [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*
, i.e., dot (.) concatenated sequences of hyphen (-) separated alphanumeric words. (See Kubernetes Names)
If left blank, the plugin will generate a name based on the build name.
The secret name will be exposed with the environment variable $KUBERNETES_SECRET_NAME
. You can use this in your Kubernetes configuration to reference the updated secret when the "Enable Variable Substitution in Config" option is enabled.
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: nginx
spec:
replicas: 1
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: some.private.registry.domain/nginx
ports:
- containerPort: 80
imagePullSecrets:
- name: $KUBERNETES_SECRET_NAME
Note that once the secret is created, it will only be updated by the plugin. You have to manually delete it when it is not used anymore. If this is a problem, you may use fixed name so every time the job runs, the secret gets updated and no new secret is created.
String
secretNamespace
(optional)
String
swarmRemoveContainersFirst
(optional)
boolean
ACXScanBuilder
ncScanType
String
ncWebsiteId
String
ncProfileId
String
ncDoNotFail
(optional)
boolean
acxServerURL
(optional)
String
credentialsId
(optional)
String
ncApiToken
(optional)
Object
ncConfirmed
(optional)
boolean
ncIgnoreFalsePositive
(optional)
boolean
ncIgnoreRiskAccepted
(optional)
boolean
ncSeverity
(optional)
String
ncStopScan
(optional)
boolean
cfyAzureArm
azureCredentialsId
(optional)
The ID of the credentials to use when accessing Azure. Parameters' expansion is supported when using freestyle jobs.
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deploymentId
(optional)
String
echoEnvData
(optional)
If checked, then the created environment's data will be printed to the job's log.
boolean
echoInputs
(optional)
boolean
envDataLocation
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
String
location
(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.
String
parameters
(optional)
YAML/JSON of parameters to pass to the template.
java.util.Map<java.lang.String, java.lang.Object>
parametersAsString
(optional)
String
parametersFile
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
String
resourceGroupName
(optional)
Name of resource group to create for the template.
String
templateFile
(optional)
Workspace-relative path of the ARM template file.
String
tenant
(optional)
String
$class: 'AWSEBBuilder'
extensions
awsRegion
GovCloud
, US_EAST_1
, US_EAST_2
, US_WEST_1
, US_WEST_2
, EU_WEST_1
, EU_WEST_2
, EU_CENTRAL_1
, AP_SOUTH_1
, AP_SOUTHEAST_1
, AP_SOUTHEAST_2
, AP_NORTHEAST_1
, AP_NORTHEAST_2
, SA_EAST_1
, CN_NORTH_1
, CN_NORTHWEST_1
, CA_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
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
String
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
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
String
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
(optional)
String
awsRegion
(optional)
String
bucketName
(optional)
S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
(Optional, will call createStorageLocation
if blank)
String
checkHealth
(optional)
boolean
credentialId
(optional)
String
environmentName
(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.
String
excludes
(optional)
String
includes
(optional)
String
keyPrefix
(optional)
String
maxAttempts
(optional)
int
rootObject
(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). String
skipEnvironmentUpdates
(optional)
boolean
sleepTime
(optional)
int
versionDescriptionFormat
(optional)
String
versionLabelFormat
(optional)
String
zeroDowntime
(optional)
boolean
awsebReleaser
credentialId
String
awsRegion
String
applicationName
String
environmentId
String
versionLabel
String
abapCi
abapPackagename
(optional)
String
atcVariant
(optional)
String
sapSystemLabel
(optional)
String
runAtcChecks
(optional)
boolean
runUnitTests
(optional)
boolean
treatWarningAtcChecksAsErrors
(optional)
boolean
useJenkinsProjectName
(optional)
boolean
withCoverage
(optional)
boolean
$class: 'ActionHubPlugin'
snActivatePlugin
credentialsId
(optional)
String
apiVersion
(optional)
String
pluginId
(optional)
String
url
(optional)
String
$class: 'AddComment'
prefix
String
note
String
logfile
String
$class: 'AddTestToSetStep'
domain
String
project
String
testPlanPath
String
testSetPath
String
$class: 'AmxEclipseAntBuilder'
targets
String
name
Jenkins supplies some environment variables that can be used from within the build script.
String
antOpts
String
buildFile
String
properties
# 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
String
amxEclipseAntTra
String
businessStudioWs
String
anchore
name
String
annotations
(optional)
key
String
value
String
autoSubscribeTagUpdates
(optional)
boolean
bailOnFail
(optional)
boolean
bailOnPluginFail
(optional)
boolean
engineCredentialsId
(optional)
String
engineRetries
(optional)
String
engineurl
(optional)
String
engineverify
(optional)
boolean
forceAnalyze
(optional)
boolean
policyBundleId
(optional)
String
$class: 'AnsibleAdHocCommandBuilder'
hostPattern
String
inventory
$class: 'InventoryContent'
content
String
dynamic
boolean
$class: 'InventoryDoNotSpecify'
$class: 'InventoryPath'
path
String
module
String
command
String
additionalParameters
(optional)
String
ansibleName
(optional)
String
becomeUser
(optional)
String
colorizedOutput
(optional)
boolean
credentialsId
(optional)
String
disableHostKeyChecking
(optional)
boolean
extraVars
(optional)
hidden
(optional)
boolean
key
(optional)
String
value
(optional)
String
forks
(optional)
int
hostKeyChecking
(optional)
boolean
sudo
(optional)
boolean
sudoUser
(optional)
String
unbufferedOutput
(optional)
boolean
vaultCredentialsId
(optional)
String
cfyAnsible
additionalArgs
(optional)
String
ansibleEnvVars
(optional)
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugLevel
(optional)
int
debugOutput
(optional)
boolean
deploymentId
(optional)
String
echoEnvData
(optional)
boolean
echoInputs
(optional)
boolean
envDataLocation
(optional)
String
optionsConfig
(optional)
String
playbookPath
(optional)
String
remergeSources
(optional)
boolean
runData
(optional)
String
savePlaybook
(optional)
boolean
scpExtraArgs
(optional)
String
sensitiveKeys
(optional)
String
sftpExtraArgs
(optional)
String
sourcePath
(optional)
String
sources
(optional)
String
sshCommonArgs
(optional)
String
sshExtraArgs
(optional)
String
startAtTask
(optional)
String
tenant
(optional)
String
timeout
(optional)
int
$class: 'AnsiblePlaybookBuilder'
playbook
String
inventory
$class: 'InventoryContent'
content
String
dynamic
boolean
$class: 'InventoryDoNotSpecify'
$class: 'InventoryPath'
path
String
additionalParameters
(optional)
String
ansibleName
(optional)
String
becomeUser
(optional)
String
colorizedOutput
(optional)
boolean
credentialsId
(optional)
String
disableHostKeyChecking
(optional)
boolean
extraVars
(optional)
hidden
(optional)
boolean
key
(optional)
String
value
(optional)
String
forks
(optional)
int
hostKeyChecking
(optional)
boolean
limit
(optional)
String
skippedTags
(optional)
String
startAtTask
(optional)
String
sudo
(optional)
boolean
sudoUser
(optional)
String
tags
(optional)
String
unbufferedOutput
(optional)
boolean
vaultCredentialsId
(optional)
String
$class: 'AnsibleTower'
towerServer
(optional)
String
jobTemplate
(optional)
String
towerCredentialsId
(optional)
String
jobType
(optional)
String
extraVars
(optional)
String
jobTags
(optional)
String
skipJobTags
(optional)
String
limit
(optional)
String
inventory
(optional)
String
credential
(optional)
String
scmBranch
(optional)
String
verbose
(optional)
boolean
importTowerLogs
(optional)
boolean
removeColor
(optional)
boolean
templateType
(optional)
String
importWorkflowChildLogs
(optional)
boolean
$class: 'AnsibleTowerProjectRevisionFreestyle'
towerServer
(optional)
String
towerCredentialsId
(optional)
String
project
(optional)
String
revision
(optional)
String
verbose
(optional)
boolean
throwExceptionWhenFail
(optional)
boolean
$class: 'AnsibleTowerProjectSyncFreestyle'
towerServer
(optional)
String
towerCredentialsId
(optional)
String
project
(optional)
String
verbose
(optional)
boolean
importTowerLogs
(optional)
boolean
removeColor
(optional)
boolean
$class: 'AnsibleVaultBuilder'
action
(optional)
String
ansibleName
(optional)
String
content
(optional)
String
input
(optional)
String
newVaultCredentialsId
(optional)
String
output
(optional)
String
vaultCredentialsId
(optional)
String
ant
Jenkins supplies some environment variables that can be used from within the build script.
targets
String
antName
String
antOpts
-Xmx512m
. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
String
buildFile
build.xml
in the root directory; this option can be used to use build files with a different name or in a subdirectory.
String
properties
# 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=
String
$class: 'AntExec'
scriptSource
String
extendedScriptSource
String
scriptName
String
properties
# 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=
String
antName
String
antOpts
String
keepBuildfile
boolean
verbose
boolean
emacs
boolean
noAntcontrib
Disabling usage of Ant-Contrib Tasks in this build step.
boolean
antws
Jenkins supplies some environment variables that can be used from within the build script.
targets
String
antName
String
antOpts
-Xmx512m
. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
String
buildFile
build.xml
in the root directory; this option can be used to use build files with a different name or in a subdirectory.
String
properties
# 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=
String
$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
(optional)
String
loginPassword
(optional)
String
loginUser
(optional)
String
optimization
(optional)
String
presenceId
(optional)
String
scanFile
(optional)
String
scanType
(optional)
String
testPolicy
(optional)
String
mobile_analyzer
target
String
hasOptions
boolean
extraField
(optional)
String
loginPassword
(optional)
String
loginUser
(optional)
String
presenceId
(optional)
String
static_analyzer
target
String
hasOptions
boolean
openSourceOnly
(optional)
boolean
name
String
type
String
application
String
credentials
String
email
(optional)
boolean
failBuild
(optional)
boolean
failBuildNonCompliance
(optional)
boolean
failureConditions
(optional)
failureType
String
threshold
int
target
(optional)
String
wait
(optional)
boolean
appscanenterprise
credentials
String
folder
String
testPolicy
String
template
String
jobName
String
accessId
(optional)
String
agent
(optional)
String
application
(optional)
String
email
(optional)
boolean
exploreData
(optional)
String
failBuild
(optional)
boolean
failureConditions
(optional)
failureType
String
threshold
int
loginType
(optional)
String
scanType
(optional)
String
secretKey
(optional)
String
target
(optional)
String
testOptimization
(optional)
String
trafficFile
(optional)
String
wait
(optional)
boolean
$class: 'AppScanSourceBuilder'
disableScan
boolean
applicationFile
String
acceptSSL
boolean
customScanWorkspace
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.
String
installation
(optional)
String
$class: 'AppScanStandardBuilder'
startingURL
Spiders will find the remaining URLs in the domain to be included for scanning.
String
installation
String
additionalCommands
(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
String
authScan
(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.
boolean
authScanPw
(optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
String
authScanRadio
(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.
boolean
authScanUser
(optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
String
generateReport
(optional)
The report is available in HTML and PDF.
The HTML report generated is ready to be integrated with the HTML Publisher Plugin.
boolean
htmlReport
(optional)
boolean
includeURLS
(optional)
Some URLs might not be found by AppScan Standard's spiders, include them to get the best possible coverage.
String
pathRecordedLoginSequence
(optional)
String
pdfReport
(optional)
boolean
policyFile
(optional)
A Test Policy File can be created following these steps:
"Scan" > "Scan Configuration" > "Test Policy" > "Export".
String
reportName
(optional)
To configure HTML Publisher Plugin properly, the names in the configuration must match.
String
verbose
(optional)
boolean
xooa
name
String
appId
String
$class: 'AppUploaderBuilder'
buildFilePath
String
applatix
axUrl
String
axUsername
String
axPassword
String
axServiceTemplateName
String
axServiceTemplateRepository
String
axServiceTemplateBranch
String
axServiceTemplateParameters
key
String
value
String
snApplyChanges
credentialsId
(optional)
String
apiVersion
(optional)
String
appScope
(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.
String
appSysId
(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.
String
branchName
(optional)
String
url
(optional)
String
$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
localToken
class hudson.util.Secret
customFlags
String
tarFilePath
(optional)
String
containerRuntime
(optional)
String
scannerPath
(optional)
String
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
$class: 'ArtifactDeployerBuilder'
includes
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.
String
basedir
By default, the basedir is the job workspace.
Give a value to override the default value.
Path relative to workspace is permitted.
String
excludes
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.
String
remote
Artifacts will be deployed in the specified output directory.
The remote location must be accessible through the build machine (master/slave node).
If you want to have the ability to download deployed artifacts through the Jenkins dashboard, the location must be accessible from the Jenkins master.
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 an Unix machine.
String
flatten
Ignore the directory structure of the source files, and deploy all the artifacts into the output directory.
boolean
deleteRemote
Delete the output directory before deploying artifacts.
boolean
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
'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.
boolean
artifactResolver
artifacts
groupId
String
artifactId
String
version
String
classifier
(optional)
String
deployToLocal
(optional)
boolean
deployToRemote
(optional)
boolean
extension
(optional)
String
failOnError
(optional)
boolean
pomFile
(optional)
String
targetFileName
(optional)
String
enableRepositoryLogging
(optional)
boolean
enableTransferLogging
(optional)
boolean
repositoryId
(optional)
String
targetDirectory
(optional)
String
artifactVersion
name
(optional)
String
description
(optional)
String
type
(optional)
String
groupId
(optional)
String
artifactId
(optional)
String
stage
(optional)
String
flow
(optional)
String
stageDescription
(optional)
String
version
(optional)
String
artifactVersion
variableName
String
name
(optional)
String
stage
(optional)
String
version
(optional)
String
assertthatBddFeatures
projectId
String
credentialsId
String
outputFolder
String
jql
String
tags
String
mode
String
proxyURI
String
proxyUsername
String
proxyPassword
String
jiraServerUrl
String
$class: 'AssetBuilder'
name
String
description
String
version
String
vendor
String
platform
String
architecture
String
bits
String
cpu
int
memory
int
storage
int
installationScriptFilePath
String
mediaFilePaths
path
String
licenseFilePath
String
documentationFilePath
String
$class: 'AssociateItemToRelease'
releasePrefix
String
itemPrefix
String
associateTag
nexusInstanceId
String
tagName
String
search
key
String
value
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
(optional)
String
minScore
(optional)
int
platformUrl
(optional)
String
branchName
(optional)
String
logLevel
(optional)
String
repositoryName
(optional)
String
shareEveryone
(optional)
String
$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
$class: 'AutoConfigBuilder'
name
String
discobitUrl
String
discobitUser
String
discobitPassword
class hudson.util.Secret
configurations
String
cuuid
String
$class: 'Autogen'
element
Specify the name of the element in your CA 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.
String
environment
Provide the environment for the CA Endevor® sandbox that you want to include in the autogeneration process, for example, DEV.
String
system
Provide the system name for the environment in your CA Endevor® sandbox that you want to include in the autogeneration process, for example, APCTTC0.
String
subsystem
Provide the subsystem name for the environment in your CA Endevor® sandbox that you want to include in the autogeneration process, for example, TESTCICD.
String
stage
Specify the environment stage in your CA Endevor® that you want to include in the autogeneration process, for example, 1.
String
instance
Specify the instance name of the environment that is associated with CA Endevor® Web services, for example, WEBSMFNE.
String
signout
Select this option to work with elements in CA 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.
boolean
$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
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).
String
upstreamBuildNumber
String
lastWithArtifacts
lastCompleted
$class: 'MultiJobBuildSelector'
buildParameter
parameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
String
permalink
id
String
$class: 'PromotedBuildSelector'
level
int
latestSavedBuild
specific
buildNumber
String
lastSuccessful
stable
(optional)
boolean
upstream
allowUpstreamDependencies
(optional)
boolean
fallbackToLastSuccessful
(optional)
boolean
upstreamFilterStrategy
(optional)
UseGlobalSetting
, UseOldest
, UseNewest
workspace
containerName
(optional)
String
deleteFromAzureAfterDownload
(optional)
boolean
downloadDirLoc
(optional)
String
excludeFilesPattern
(optional)
String
fileShare
(optional)
String
flattenDirectories
(optional)
boolean
includeArchiveZips
(optional)
boolean
includeFilesPattern
(optional)
String
projectName
(optional)
String
verbose
(optional)
Enabling this will provide more logging on downloading files.
boolean
$class: 'BDSBuilder'
projectFile
String
switches
String
installationName
String
$class: 'BapFtpBuilder'
publishers
configName
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.
String
verbose
boolean
transfers
sourceFiles
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.
String
excludes
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)
String
remoteDirectory
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.
String
removePrefix
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.
String
asciiMode
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.
boolean
remoteDirectorySDF
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 |
boolean
flatten
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.
boolean
cleanRemote
Select to delete all files and directories within the remote directory before transferring files.
boolean
noDefaultExcludes
boolean
makeEmptyDirs
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.
boolean
patternSeparator
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.
String
useWorkspaceInPromotion
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
boolean
usePromotionTimestamp
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.
boolean
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
Set the label for this Server instance - for use with Parameterized publishing.
Expand the help for Parameterized publishing for more details.
String
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
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
(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.
boolean
variables
(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.
String
unstableReturn
(optional)
int
snBatchInstall
credentialsId
(optional)
String
apiVersion
(optional)
String
batchName
(optional)
String
file
(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
.
String
notes
(optional)
Default: null
String
packages
(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:
|
String
url
(optional)
String
useFile
(optional)
Default: false
boolean
snBatchRollback
credentialsId
(optional)
String
apiVersion
(optional)
String
rollbackId
(optional)
sys_id
) of the rollback installed before.
String
url
(optional)
If ServiceNow Parameters are used, then the URL of installation instance will be used.
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
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) |
String
includeResources
boolean
benchmark
filepath
String
$class: 'BitbucketPublisher'
serverUrl
(optional)
String
credentialsId
(optional)
String
projectKey
(optional)
String
createProject
(optional)
projectName
String
projectUsers
String
projectGroups
String
createJenkinsJobs
(optional)
ciServer
String
projectName
(optional)
String
$class: 'BladeBuilder'
blades
$class: 'CodeScan'
source
String
exclude
String
noCache
boolean
noProxy
boolean
noBlame
boolean
ruleset
String
severityLevel
String
severityThreshold
int
autoUpdate
(optional)
boolean
credentialsId
(optional)
String
debug
(optional)
boolean
directory
(optional)
String
environment
(optional)
String
forceVersion
(optional)
String
ignoreFailure
(optional)
boolean
onFailureCmd
(optional)
String
timeout
(optional)
int
$class: 'ImageScan'
image
String
exclude
String
noCache
boolean
noProxy
boolean
noBlame
boolean
ruleset
String
severityLevel
String
severityThreshold
int
autoUpdate
(optional)
boolean
credentialsId
(optional)
String
debug
(optional)
boolean
directory
(optional)
String
environment
(optional)
String
forceVersion
(optional)
String
ignoreFailure
(optional)
boolean
onFailureCmd
(optional)
String
timeout
(optional)
int
$class: 'BlueprintLaunch'
projectName
Project selection is mandatory.
String
blueprintName
Blueprint selection is mandatory.
String
applicationName
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.
String
appProfileName
Application Profile selection is mandatory.
String
actionName
The field is mandatory
Select the required action need to run after the application launch from the list of actions, else please select none.
String
runtimeVariables
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.
String
waitForSuccessFulLaunch
boolean
blueprintDescription
Description is fetched from the selected Calm blueprint
String
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
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)
boolean
bmcDb2log
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.
boolean
db2log
String
db2bsds
String
limit
String
skip
String
maxlogs
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).
String
bmcDb2bsds
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:
boolean
bmcLimit
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:
boolean
bmcSkip
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.
boolean
bmcActiveOlds
boolean
bmcImsid
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.
boolean
bmcDlilog
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:
boolean
bmcMaxlogs
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:
boolean
bmcJobname
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:
boolean
cfaImsids
imsid
String
bmcRecon
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.
boolean
bmcTimezone
boolean
bmcStartInterval
You can use the START keyword on the INTERVAL control statement for the following purposes:
boolean
bmcStopInterval
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
boolean
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
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)
String
maxlogsAbend
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)
String
bmcJobInc
boolean
bmcJobExc
boolean
bmcPsbInc
boolean
bmcPsbExc
boolean
bmcChkfreq
boolean
bmcThresh
boolean
bmcPrilog
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:
boolean
bmcAppcheck
boolean
bmcAll
boolean
bmcLsec
boolean
chkfreqval
String
bmcPlanInc
boolean
planInclude
String
bmcPlanExc
boolean
planExclude
String
bmcSortby
boolean
bmcCsv
boolean
bmcFullreport
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:
configuration
(optional)
Debug
, but you can override the build configuration settings in your project.
String
force
(optional)
boolean
framework
(optional)
String
noDependencies
(optional)
boolean
noIncremental
(optional)
boolean
noRestore
(optional)
boolean
nologo
(optional)
boolean
option
(optional)
String
options
(optional)
String
optionsString
(optional)
String
outputDirectory
(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.
String
project
(optional)
String
properties
(optional)
java.util.Map<java.lang.String, java.lang.String>
propertiesString
(optional)
String
runtime
(optional)
String
sdk
(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.
String
showSdkInfo
(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.
boolean
shutDownBuildServers
(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).
boolean
specificSdkVersion
(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.
boolean
target
(optional)
String
targets
(optional)
String
targetsString
(optional)
String
unstableIfWarnings
(optional)
boolean
verbosity
(optional)
String
versionSuffix
(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.
String
workDirectory
(optional)
String
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
(optional)
String
baseUrl
(optional)
username[:password]@
between the scheme and the hostname.
String
credentialsId
(optional)
/$username/keys/$fingerprint
.
String
download
(optional)
boolean
localDirectory
(optional)
String
requestTimeout
(optional)
long
serviceTimeout
(optional)
long
waitDelay
(optional)
long
wspFilter
(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.
String
$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
(optional)
String
filterFile
(optional)
String
transactionIsoLvl
(optional)
String
$class: 'BuildStepWithTimeout'
buildStep
hudson.tasks.BuildStep
)strategy
$class: 'AbsoluteTimeOutStrategy'
Abort build based on a fixed time-out.
timeoutMinutes
String
$class: 'DeadlineTimeOutStrategy'
Abort build based on a deadline time specified in HH:MM:SS or HH:MM (24-hour time format).
deadlineTime
String
deadlineToleranceInMinutes
int
$class: 'ElasticTimeOutStrategy'
Define time to wait before killing the build as a percentage of the mean of the duration of the last n successful builds.
timeoutPercentage
String
timeoutMinutesElasticDefault
String
numberOfBuilds
String
failSafeTimeoutDuration
boolean
$class: 'LikelyStuckTimeOutStrategy'
Abort the build when the job has taken many times longer than previous runs.
$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
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
timeout
long
defaultTimeout
long
operationList
$class: 'AbortAndRestartOperation'
maxRestarts
String
$class: 'AbortOperation'
$class: 'BuildStepOperation'
buildstep
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
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
boolean
messageContent
(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}.
String
messageProperties
(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}.
String
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
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
activeMQSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
selector
(optional)
JMS selector to choose messages that will fire the trigger.
String
timeout
(optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
int
variable
(optional)
Environment variable to hold received message content.
String
fedmsgPublisher
failOnError
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
boolean
messageContent
(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}.
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
fedmsgSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
timeout
(optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
int
variable
(optional)
Environment variable to hold received message content.
String
rabbitMQPublisher
failOnError
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
boolean
fedoraMessaging
(optional)
boolean
messageContent
(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}.
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
schema
(optional)
Path to message schema.
String
severity
(optional)
Severity of the message.
int
rabbitMQSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
timeout
(optional)
Value (in minutes) to wait for a message.
int
variable
(optional)
Environment variable to hold received message content.
String
$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
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
boolean
messageContent
(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}.
String
messageProperties
(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}.
String
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
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
activeMQSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
selector
(optional)
JMS selector to choose messages that will fire the trigger.
String
timeout
(optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
int
variable
(optional)
Environment variable to hold received message content.
String
fedmsgPublisher
failOnError
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
boolean
messageContent
(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}.
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
fedmsgSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
timeout
(optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
int
variable
(optional)
Environment variable to hold received message content.
String
rabbitMQPublisher
failOnError
(optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
boolean
fedoraMessaging
(optional)
boolean
messageContent
(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}.
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
schema
(optional)
Path to message schema.
String
severity
(optional)
Severity of the message.
int
rabbitMQSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(optional)
String
queue
(optional)
String
timeout
(optional)
Value (in minutes) to wait for a message.
int
variable
(optional)
Environment variable to hold received message content.
String
$class: 'CRDABuilder'
file
(optional)
String
crdaKeyId
(optional)
String
cliVersion
(optional)
String
consentTelemetry
(optional)
CRDA CLI is constantly improving and we would like to know more about usage. Click here to find more details.
boolean
$class: 'CToolBuilder'
cmake -P <script file>
) or command mode (cmake -E <command>
).
installationName
String
arguments
(optional)
String
ignoredExitCodes
(optional)
String
toolId
(optional)
String
workingDir
(optional)
String
generateCache
caches
type
A2L
, ELF
, BUS
, MODEL
, SERVICE
filePath
String
dbChannel
String
clear
boolean
$class: 'CallFunction'
functionName
(optional)
String
argumentList
(optional)
String
argument
(optional)
String
$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
(optional)
String
engineTimeout
(optional)
int
failBuildOnPluginError
(optional)
boolean
failBuildOnPolicyEvaluationFailResult
(optional)
boolean
image
(optional)
String
policyBundleID
(optional)
String
registryURI
(optional)
String
carl
installationName
String
sourcePath
String
applicationName
String
archivePdf
(optional)
boolean
displayLog
(optional)
boolean
logPath
(optional)
String
outputPath
(optional)
String
qualityGate
(optional)
String
castecho
installationName
String
sourcePath
String
applicationName
String
displayLog
(optional)
boolean
logPath
(optional)
String
outputPath
(optional)
String
qualityGate
(optional)
String
venafiVcertRequestCertificate
connectorName
String
zoneConfigName
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
String
commonName
String
privKeyOutput
String
certOutput
String
certChainOutput
String
country
(optional)
String
dnsNames
(optional)
hostName
String
emailAddresses
(optional)
address
String
expirationWindow
(optional)
int
ipAddresses
(optional)
address
String
keyType
(optional)
RSA
, ECDSA
locality
(optional)
String
organization
(optional)
String
organizationalUnit
(optional)
String
province
(optional)
String
changeAsmVer
versionPattern
String
assemblyCompany
(optional)
String
assemblyCopyright
(optional)
String
assemblyCulture
(optional)
String
assemblyDescription
(optional)
String
assemblyFile
(optional)
String
assemblyProduct
(optional)
String
assemblyTitle
(optional)
String
assemblyTrademark
(optional)
String
regexPattern
(optional)
String
replacementPattern
(optional)
String
$class: 'ChangeEventBuilder'
integrationKey
String
summaryText
(optional)
String
chatterPost
postToChatter "Build Started - ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"
credentialsId
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.
String
body
String
buildUrlTitle
(optional)
String
recordId
(optional)
String
server
(optional)
String
$class: 'CheckGate'
pipelineId
String
stageName
String
versionId
String
fatal
String
$class: 'CheckGateBuilder'
project
String
gate
String
$class: 'ChefBuilderConfiguration'
url
String
sinatraurl
String
filter
String
username
String
port
int
command
String
privatekey
String
parallel
boolean
fail
boolean
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
xcodebuild -showsdks
String
config
String
clangInstallationName
String
xcodeProjectSubPath
String
workspace
String
scheme
String
scanbuildargs
String
xcodebuildargs
String
outputFolderName
String
googleStorageUpload
credentialsId
String
bucket
String
pattern
String
pathPrefix
(optional)
String
sharedPublicly
(optional)
boolean
showInline
(optional)
boolean
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.
configuration
(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.
String
framework
(optional)
String
nologo
(optional)
boolean
option
(optional)
String
options
(optional)
String
optionsString
(optional)
String
outputDirectory
(optional)
String
project
(optional)
String
properties
(optional)
java.util.Map<java.lang.String, java.lang.String>
propertiesString
(optional)
String
runtime
(optional)
String
sdk
(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.
String
showSdkInfo
(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.
boolean
shutDownBuildServers
(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).
boolean
specificSdkVersion
(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.
boolean
unstableIfWarnings
(optional)
boolean
verbosity
(optional)
String
workDirectory
(optional)
String
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
.tgz
or .tar.gz
) or zip file (.zip
), or .tgz
) and uploaded to a temporary Cloud Storage bucket. String
repo
branch
(optional)
String
commit
(optional)
String
projectId
(optional)
String
repoName
(optional)
String
tag
(optional)
String
storage
bucket
String
object
String
substitutionList
(optional)
items
key
_
) 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.
String
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
(optional)
String
appPath
(optional)
String
buildpack
(optional)
String
command
(optional)
String
domain
(optional)
String
envVars
(optional)
key
String
value
String
hostname
(optional)
String
instances
(optional)
String
manifestFile
(optional)
String
memory
(optional)
String
noRoute
(optional)
String
servicesNames
(optional)
name
String
stack
(optional)
String
timeout
(optional)
String
value
(optional)
String
pluginTimeout
(optional)
String
selfSigned
(optional)
String
servicesToCreate
(optional)
name
String
type
String
plan
String
resetService
(optional)
boolean
cloudhubDeployer
environmentId
String
orgId
String
appName
String
muleVersion
String
filePath
String
credentialsId
(optional)
String
requestMode
(optional)
CREATE
, UPDATE
, CREATE_OR_UPDATE
, UPDATE_FILE
, RESTART
, DELETE
region
(optional)
String
autoScalePolicy
(optional)
autoScalePolicyName
(optional)
String
enableAutoScalePolicy
(optional)
boolean
id
(optional)
String
maxScale
(optional)
int
minScale
(optional)
int
scaleBasedOn
(optional)
String
scaleDown
(optional)
class org.jenkinsci.plugins.cloudhubdeployer.data.Scale
scaleDownNextScaleWaitMins
(optional)
int
scaleDownPeriodCount
(optional)
int
scaleDownValue
(optional)
int
scaleType
(optional)
String
scaleUp
(optional)
class org.jenkinsci.plugins.cloudhubdeployer.data.Scale
scaleUpNextScaleWaitMins
(optional)
int
scaleUpPeriodCount
(optional)
int
scaleUpValue
(optional)
int
autoStart
(optional)
boolean
debugMode
(optional)
ENABLED
, DISABLED
enableAutoScalePolicy
(optional)
boolean
envVars
(optional)
key
(optional)
String
value
(optional)
String
ignoreGlobalSettings
(optional)
boolean
logLevels
(optional)
levelCategory
(optional)
DEBUG
, WARN
, ERROR
, INFO
packageName
(optional)
String
loggingNgEnabled
(optional)
boolean
monitoringAutoRestart
(optional)
boolean
monitoringEnabled
(optional)
boolean
objectStoreV1
(optional)
boolean
persistentQueues
(optional)
boolean
persistentQueuesEncrypted
(optional)
boolean
timeoutConnection
(optional)
int
timeoutResponse
(optional)
int
verifyDeployments
(optional)
boolean
verifyIntervalInSeconds
(optional)
int
workerAmount
(optional)
int
workerCpu
(optional)
String
workerMemory
(optional)
String
workerType
(optional)
String
workerWeight
(optional)
String
$class: 'CloudShellConfig'
buildStep
$class: 'StartSandbox'
blueprintName
String
sandboxDuration
String
maxWaitForSandboxAvailability
int
setupTimeout
int
params
(optional)
String
sandboxDomain
(optional)
String
sandboxName
(optional)
String
$class: 'CmakeBuilder'
cmake -G
with the given options.
CMAKE_BUILD_TOOL
build environment variable if the chosen generator supports that.
installationName
String
buildDir
(optional)
String
buildType
(optional)
String
cleanBuild
(optional)
boolean
cmakeArgs
(optional)
String
generator
(optional)
String
preloadScript
(optional)
String
sourceDir
(optional)
String
steps
(optional)
args
(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),
String
envVars
(optional)
DESTDIR=${WORKSPACE}/artifacts/dir
KEY=VALUE
String
withCmake
(optional)
$CMAKE_BUILD_TOOL
) or to have cmake
run the build tool (by invoking cmake --build <dir>
).
boolean
$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
$class: 'CodeCoverageBuilder'
connectionId
String
credentialsId
String
analysisPropertiesPath
String
analysisProperties
String
codescene
credentialsId
String
deltaAnalysisUrl
String
repository
String
analyzeBranchDiff
(optional)
boolean
analyzeLatestIndividually
(optional)
boolean
baseRevision
(optional)
String
couplingThresholdPercent
(optional)
int
failOnDecliningCodeHealth
(optional)
boolean
failOnFailedGoal
(optional)
boolean
letBuildPassOnFailedAnalysis
(optional)
boolean
markBuildAsUnstable
(optional)
boolean
originUrl
(optional)
String
riskThreshold
(optional)
int
$class: 'CodeStreamBuilder'
serverUrl
String
userName
String
password
String
tenant
String
pipelineName
String
waitExec
boolean
pipelineParams
value
String
name
String
$class: 'CodefreshPipelineBuilder'
selectPipeline
cfPipeline
String
cfBranch
String
setCFVars
vars
Variable
String
Value
String
$class: 'CommentsRemoverBuilder'
filename
String
language
String
outputDir
String
$class: 'CompareBuilder'
outputFolder
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:
String
srcInputType
String
tgtInputType
String
srcInputFileOrFolder
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:
String
tgtInputFileOrFolder
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:
String
configFile
Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
File location must be specified as:
String
$class: 'CompareWithBaselineBuilder'
outputFolder
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:
String
srcInputType
String
tgtInputType
String
srcInputFileOrFolder
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:
String
tgtInputFileOrFolder
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:
String
configFile
Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
File location must be specified as:
String
$class: 'CompoundBuilder'
$class: 'ConditionalBuilder'
runCondition
$class: 'AlwaysRun'
$class: 'And'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
hudson.tasks.BuildStep
)$class: 'ConfigFileBuildStep'
managedFiles
fileId
Name of the file.
String
replaceTokens
(optional)
Decides whether the token should be replaced using macro.
boolean
targetLocation
(optional)
Name of the file (with optional file relative to workspace directory) where the config file should be copied.
String
variable
(optional)
Name of the variable which can be used as the reference for further configuration.
String
$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
(optional)
String
apiUri
(optional)
String
debugMode
(optional)
ENABLED
, DISABLED
envVarKey
(optional)
String
ignoreGlobalSettings
(optional)
boolean
keyValue
(optional)
String
requestMode
(optional)
READ
, WRITE
, DELETE
timeoutConnection
(optional)
int
timeoutResponse
(optional)
int
assessContainerImage
failOnPluginError
(optional)
boolean
imageId
(optional)
String
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
(optional)
boolean
workspaceDir
(optional)
String
contentReplace
configs
(optional)
filePath
String
fileEncoding
String
configs
search
String
replace
String
matchCount
int
$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
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 the wiki page "How to reference another project by name" for more information.
String
excludes
(optional)
String
filter
(optional)
String
fingerprintArtifacts
(optional)
boolean
flatten
(optional)
boolean
optional
(optional)
boolean
parameters
(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.
String
resultVariableSuffix
(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_ |
String
selector
(optional)
downstream
upstreamProjectName
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).
String
upstreamBuildNumber
String
lastWithArtifacts
lastCompleted
$class: 'MultiJobBuildSelector'
buildParameter
parameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
String
permalink
id
String
$class: 'PromotedBuildSelector'
level
int
latestSavedBuild
specific
buildNumber
String
lastSuccessful
stable
(optional)
boolean
upstream
allowUpstreamDependencies
(optional)
boolean
fallbackToLastSuccessful
(optional)
boolean
upstreamFilterStrategy
(optional)
UseGlobalSetting
, UseOldest
, UseNewest
workspace
target
(optional)
String
copy
dstFile
(optional)
String
keepMeta
(optional)
boolean
recursive
(optional)
boolean
srcFile
(optional)
String
$class: 'CreateBaselineBuilder'
outputFile
Path to the file that should be used to store baseline.
File location must be specified as:
String
inputFileOrFolder
Specify input folder/file for creating baseline. It should depend on input type you have selected.
Folder/file location must be specified as:
String
$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
The identifier of the BuildMaster application to trigger the build for.
Options are:
String
releaseNumber
The BuildMaster release number to trigger the build for. Options are:
The job will fail if there is no active BuildMaster release.
String
deployToFirstStage
(optional)
waitUntilCompleted
boolean
printLogOnFailure
(optional)
boolean
variables
(optional)
Provide a list of variables to pass to the build.
String
$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
(optional)
Unique identifier for the created deployment.
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deploymentId
(optional)
Identifies the blueprint to create a deployment off.
String
echoInputs
(optional)
boolean
echoOutputs
(optional)
boolean
inputs
(optional)
A YAML/JSON containing inputs for the deployment. These inputs will be merged with inputs provided through the " inputs file
" parameter.
String
inputsFile
(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.
String
mapping
(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.
String
mappingFile
(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.
String
outputFile
(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> }
String
skipInstall
(optional)
install
workflow.
boolean
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
$class: 'CreateFingerprint'
Create Fingerprints of specified files during a build process
targets
String
tektonCreateRaw
input
String
inputType
String
clusterName
(optional)
String
enableCatalog
(optional)
boolean
namespace
(optional)
String
$class: 'CreateRelease'
prefix
String
itemPrefix
String
releaseName
String
description
String
stage
String
owner
String
period
String
$class: 'CreateSnapshotBuilder'
outputFile
Path to the file that should be used to store snapshots.
File location must be specified as:
String
inputFileOrFolder
Specify input folder/file for creating snapshot. It should depend on input type you have selected.
Folder/file location must be specified as:
String
createTag
nexusInstanceId
String
tagName
String
tagAttributesJson
(optional)
String
tagAttributesPath
(optional)
String
createTask
artifact
(optional)
String
autoUpgradable
(optional)
boolean
environment
(optional)
String
overrideWithDefaultParameters
(optional)
boolean
parameters
(optional)
String
runtime
(optional)
String
runtimeType
(optional)
String
workspace
(optional)
String
$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: '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.
$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
(optional)
boolean
serverUrl
(optional)
String
username
(optional)
String
password
(optional)
String
isProxy
(optional)
boolean
configAsCode
(optional)
boolean
projectName
(optional)
String
projectId
(optional)
long
groupId
(optional)
String
preset
(optional)
String
jobStatusOnError
(optional)
GLOBAL
, FAILURE
, UNSTABLE
presetSpecified
(optional)
boolean
excludeFolders
(optional)
Conversion is done as follows:
fold1, fold2 fold3
is converted to:
!**/fold1/**/*, !**/fold2/**/*, !**/fold3/**/*,
String
filterPattern
(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").
String
incremental
(optional)
boolean
fullScansScheduled
(optional)
boolean
fullScanCycle
(optional)
int
postScanActionId
(optional)
int
sourceEncoding
(optional)
String
comment
(optional)
String
skipSCMTriggers
(optional)
boolean
waitForResultsEnabled
(optional)
boolean
vulnerabilityThresholdEnabled
(optional)
boolean
highThreshold
(optional)
int
mediumThreshold
(optional)
int
lowThreshold
(optional)
int
osaHighThreshold
(optional)
int
osaMediumThreshold
(optional)
int
osaLowThreshold
(optional)
int
generatePdfReport
(optional)
boolean
enableProjectPolicyEnforcement
(optional)
boolean
thresholdSettings
(optional)
String
vulnerabilityThresholdResult
(optional)
String
avoidDuplicateProjectScans
(optional)
boolean
addGlobalCommenToBuildCommet
(optional)
boolean
generateXmlReport
(optional)
boolean
hideDebugLogs
(optional)
boolean
forceScan
(optional)
boolean
customFields
(optional)
String
dependencyScanConfig
(optional)
SASTUserName
(optional)
String
dependencyScanExcludeFolders
(optional)
String
dependencyScanPatterns
(optional)
String
dependencyScannerType
(optional)
OSA
, SCA
enableScaResolver
(optional)
SCA_RESOLVER
, MANIFEST
fsaVariables
(optional)
String
isExploitablePath
(optional)
boolean
isIncludeSources
(optional)
boolean
osaArchiveIncludePatterns
(optional)
String
osaInstallBeforeScan
(optional)
boolean
overrideGlobalConfig
(optional)
boolean
pathToScaResolver
(optional)
String
sastCredentialsId
(optional)
String
scaAccessControlUrl
(optional)
String
scaConfigFile
(optional)
String
scaCredentialsId
(optional)
String
scaEnvVariables
(optional)
String
scaResolverAddParameters
(optional)
String
scaSASTProjectFullPath
(optional)
String
scaSASTProjectID
(optional)
String
scaSastServerUrl
(optional)
String
scaServerUrl
(optional)
String
scaTeamPath
(optional)
String
scaTenant
(optional)
String
scaTimeout
(optional)
int
scaWebAppUrl
(optional)
String
useJobLevelSastDetails
(optional)
boolean
excludeOpenSourceFolders
(optional)
String
includeOpenSourceFolders
(optional)
String
osaArchiveIncludePatterns
(optional)
String
osaEnabled
(optional)
boolean
osaInstallBeforeScan
(optional)
boolean
thisBuildIncremental
(optional)
boolean
DASTScan
apikey
(optional)
Your API key can be found on the Breachlock Platform under
Organization settings > Integrations > Jenkins
class hudson.util.Secret
asset
(optional)
Select the asset that will be scanned on build.
If the asset you are looking for is missing:
String
email
(optional)
The email-address you registered on Breachlock Platform.
String
osfBuilderSuiteForSFCCDataImport
hostname
(optional)
String
tfCredentialsId
(optional)
String
ocCredentialsId
(optional)
String
ocVersion
(optional)
String
archiveName
(optional)
String
sourcePath
(optional)
String
includePatterns
(optional)
includePattern
String
excludePatterns
(optional)
excludePattern
String
importStrategy
(optional)
String
tempDirectory
(optional)
String
$class: 'DaticalDBBuilder'
daticalDBProjectDir
String
daticalDBServer
String
daticalDBAction
String
daticalDBCmdProject
String
daticalDBExportSQL
String
daticalDBExportRollbackSQL
String
daticalDBScriptDir
String
debianPbuilder
additionalBuildResults
(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.
String
architecture
(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.
String
buildAsTag
(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.
boolean
components
(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.
String
debianDirLocation
(optional)
The location of the debian/ directory, relative to workspace root
This may also be set globally
String
distribution
(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.
String
guessComponents
(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"
boolean
keyring
(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.
String
mirrorSite
(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
String
numberCores
(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.
int
pristineTarName
(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.
String
runAutomationHubBuild
testSuiteId
String
startOnly
(optional)
boolean
userKeyId
(optional)
String
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
(optional)
String
forceEnglishOutput
(optional)
boolean
noServiceEndpoint
(optional)
boolean
packageName
(optional)
String
packageVersion
(optional)
String
sdk
(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.
String
showSdkInfo
(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.
boolean
source
(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
).
String
specificSdkVersion
(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.
boolean
workDirectory
(optional)
String
$class: 'DeleteApplication'
serverName
String
appName
String
domain
String
deleteCloudifyBlueprint
blueprintId
(optional)
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
deleteComponents
nexusInstanceId
String
tagName
String
deleteCloudifyEnv
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deleteBlueprintIfLast
(optional)
If checked, and this is the last environment for the associated blueprint, then also delete the blueprint.
boolean
deploymentId
(optional)
String
ignoreFailure
(optional)
If checked, then failures during the removal of the environment will be ignored.
boolean
skipUninstall
(optional)
uninstall
workflow.
boolean
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
$class: 'DeleteEnvironmentBuilder'
systemId
int
environmentName
String
$class: 'DeleteRaw'
deleteAllStatus
resourceName
String
resourceType
(optional)
String
clusterName
(optional)
String
resourceName
(optional)
String
$class: 'DeleteVirtualizeBuilder'
serverType
String
serverHost
String
serverName
String
dependencyCheck
additionalArguments
(optional)
String
odcInstallation
(optional)
String
skipOnScmChange
(optional)
boolean
skipOnUpstreamChange
(optional)
boolean
$class: 'DeployApplication'
This plugin creates a container on the OpenShift PaaS and deploys the application into the container.
serverName
String
appName
String
cartridges
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:
String
domain
String
gearProfile
String
deploymentPackage
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.
String
environmentVariables
Specify a space delimited list of environment variables (key=value) to be assigned to the application. e.g. LOAD_DATA=true MVN_DEPLOY=true
String
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
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
String
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
template.yaml
app/template.json
String
kmsKeyId
(optional)
String
outputTemplateFile
(optional)
template-#jobId.yaml
by default.
String
parameters
(optional)
key
String
value
String
roleArn
(optional)
String
s3Prefix
(optional)
String
tags
(optional)
key
String
value
String
crxDeploy
packageIdFilters
(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.
String
baseUrls
(optional)
username[:password]@
between the scheme and the hostname.
String
acHandling
(optional)
String
autosave
(optional)
int
behavior
(optional)
String
credentialsId
(optional)
/$username/keys/$fingerprint
.
String
disableForJobTesting
(optional)
boolean
localDirectory
(optional)
String
recursive
(optional)
boolean
replicate
(optional)
boolean
requestTimeout
(optional)
long
serviceTimeout
(optional)
long
waitDelay
(optional)
long
$class: 'DeployPromotionBuilder'
hosts
com.cloudbees.plugins.deployer.hosts.DeployHost<?, ?>
$class: 'DeployScriptBuilder'
out
Specify full path to target connection file.
File location must be specified as:
String
in
Specify path to file that contains SQL script.
File location must be specified as:
String
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
The identifier of the BuildMaster application to trigger the build for.
Options are:
String
releaseNumber
The BuildMaster release number to trigger the build for. Options are:
The job will fail if there is no active BuildMaster release.
String
buildNumber
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.
String
force
(optional)
boolean
printLogOnFailure
(optional)
boolean
stage
(optional)
Optional. If not supplied, the next stage in the pipeline will be used.
String
variables
(optional)
Set deployment level variables.
String
waitUntilCompleted
(optional)
boolean
$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
$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
\[INFO\] Uploading project information for [^\s]* ([^\s]*)
String
description
String
snDevOpsPackage
name
(optional)
String
artifactsPayload
(optional)
String
snDevOpsArtifact
artifactsPayload
(optional)
String
devSpacesCreate
azureCredentialsId
String
aksName
(optional)
String
kubeconfigId
(optional)
String
resourceGroupName
(optional)
String
sharedSpaceName
(optional)
String
spaceName
(optional)
String
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
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" } }
String
deploy
String
undeploy
String
inputFile1
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
String
inputFile2
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
String
activeConfig
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
String
dataFiles
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
String
swaggerurl
String
ramlurl
String
wadlurl
String
tokenCredentialId
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".
String
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
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".
String
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
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
String
tokenCredentialId
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".
String
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
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".
String
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
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".
String
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
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".
String
secured
boolean
importDeveloperProfile
importIntoExistingKeychain
(optional)
boolean
keychainId
(optional)
String
keychainName
(optional)
String
keychainPath
(optional)
String
keychainPwd
(optional)
class hudson.util.Secret
profileId
(optional)
String
$class: 'DiawiUploader'
token
String
fileName
String
proxyHost
String
proxyPort
int
proxyProtocol
String
dingtalk
robot
String
at
(optional)
String
atAll
(optional)
boolean
btnLayout
(optional)
H
, V
btns
(optional)
title
String
actionUrl
String
hideAvatar
(optional)
boolean
messageUrl
(optional)
String
picUrl
(optional)
String
singleTitle
(optional)
String
singleUrl
(optional)
String
text
(optional)
String
title
(optional)
String
type
(optional)
TEXT
, LINK
, MARKDOWN
, ACTION_CARD
$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
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.
String
waitForNodes
Wait for modes in the label which are now occupied by some other builds. This doesn't wait for nodes which are offline
boolean
compileTests
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".
boolean
$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
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
(optional)
boolean
bindPorts
(optional)
String
capabilitiesToAddString
(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.
String
capabilitiesToDropString
(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.
String
cpuPeriod
(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.
long
cpuQuota
(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.
long
cpuShares
(optional)
int
devicesString
(optional)
String
dnsString
(optional)
String
dockerCommand
(optional)
String
environmentsString
(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_SLAVE_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
can be (accidentally) turned into three separate settings:
JENKINS_SLAVE_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
thus preventing the configuration from working as was intended.
String
extraDockerLabelsString
(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:
String
extraGroupsString
(optional)
String
extraHostsString
(optional)
String
hostname
(optional)
String
macAddress
(optional)
String
memoryLimit
(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.
int
memorySwap
(optional)
int
mountsString
(optional)
String
network
(optional)
String
privileged
(optional)
boolean
pullCredentialsId
(optional)
String
securityOptsString
(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.
String
shmSize
(optional)
int
tty
(optional)
boolean
user
(optional)
String
volumesFromString
(optional)
String
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
(optional)
String
javaExe
(optional)
String
jvmArgsString
(optional)
String
user
(optional)
root
") will be used if this is left blank.
String
jnlp
jnlpLauncher
jnlp
tunnel
String
vmargs
String
webSocket
(optional)
boolean
workDirSettings
(optional)
disabled
boolean
workDirPath
String
internalDir
String
failIfWorkDirIsMissing
boolean
entryPointArgumentsString
(optional)
String
jenkinsUrl
(optional)
String
user
(optional)
String
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
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.
String
$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
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.
boolean
$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
(optional)
String
jvmOptions
(optional)
String
launchTimeoutSeconds
(optional)
int
maxNumRetries
(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.
int
port
(optional)
int
prefixStartSlaveCmd
(optional)
String
retryWaitTime
(optional)
int
suffixStartSlaveCmd
(optional)
String
labelString
String
instanceCapStr
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.
String
disabled
(optional)
disabledByChoice
(optional)
boolean
enabledByChoice
(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.
boolean
mode
(optional)
NORMAL
, EXCLUSIVE
name
(optional)
If blank or just whitespace, a default of "docker" will be used.
String
nodeProperties
(optional)
? extends hudson.slaves.NodeProperty<?>
pullStrategy
(optional)
PULL_ALWAYS
, PULL_LATEST
, PULL_NEVER
pullTimeout
(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).
int
remoteFs
(optional)
String
removeVolumes
(optional)
boolean
retentionStrategy
(optional)
Specify the strategy when docker containers shall be started and stopped:
idleMinutes
int
stopTimeout
(optional)
int
$class: 'DockerBuilderPublisher'
dockerFileDirectory
String
fromRegistry
url
https://index.docker.io/v1/
).
String
credentialsId
String
cloud
String
tagsString
String
pushOnSuccess
boolean
pushCredentialsId
String
cleanImages
boolean
cleanupWithJenkinsJobDelete
boolean
noCache
(optional)
--no-cache
which disables caching of layers. See the docker build command for more information.
boolean
pull
(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.
boolean
$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
https://index.docker.io/v1/
).
String
credentialsId
String
image
String
dockerShell
connector
(optional)
$class: 'CloudNameDockerConnector'
cloudName
String
$class: 'DockerConnector'
serverUrl
String
apiVersion
(optional)
String
connectTimeout
(optional)
int
connectorType
(optional)
JERSEY
, NETTY
, OKHTTP
credentialsId
(optional)
String
readTimeout
(optional)
int
containerLifecycle
(optional)
createContainer
(optional)
bindAllPorts
(optional)
boolean
bindPorts
(optional)
String
command
(optional)
String
cpuShares
(optional)
int
cpusetCpus
(optional)
String
cpusetMems
(optional)
String
devicesString
(optional)
String
dnsString
(optional)
String
dockerLabelsString
(optional)
String
entrypoint
(optional)
String
environmentString
(optional)
String
extraHostsString
(optional)
String
hostname
(optional)
String
linksString
(optional)
String
macAddress
(optional)
String
memoryLimit
(optional)
long
networkMode
(optional)
String
privileged
(optional)
boolean
restartPolicy
(optional)
policyName
NO
, UNLESS_STOPPED
, ALWAYS
, ON_FAILURE
maximumRetryCount
int
shmSize
(optional)
long
tty
(optional)
boolean
user
(optional)
String
volumesFromString
(optional)
String
volumesString
(optional)
String
workdir
(optional)
String
image
(optional)
String
pullImage
(optional)
connector
(optional)
$class: 'CloudNameDockerConnector'
cloudName
String
$class: 'DockerConnector'
serverUrl
String
apiVersion
(optional)
String
connectTimeout
(optional)
int
connectorType
(optional)
JERSEY
, NETTY
, OKHTTP
credentialsId
(optional)
String
readTimeout
(optional)
int
credentialsId
(optional)
String
pullStrategy
(optional)
PULL_ALWAYS
, PULL_ONCE
, PULL_LATEST
, PULL_NEVER
registriesCreds
(optional)
registryAddr
String
credentialsId
String
removeContainer
(optional)
force
(optional)
boolean
removeVolumes
(optional)
boolean
stopContainer
(optional)
connector
(optional)
$class: 'CloudNameDockerConnector'
cloudName
String
$class: 'DockerConnector'
serverUrl
String
apiVersion
(optional)
String
connectTimeout
(optional)
int
connectorType
(optional)
JERSEY
, NETTY
, OKHTTP
credentialsId
(optional)
String
readTimeout
(optional)
int
timeout
(optional)
int
executorScript
(optional)
String
longConnector
(optional)
$class: 'CloudNameDockerConnector'
cloudName
String
$class: 'DockerConnector'
serverUrl
String
apiVersion
(optional)
String
connectTimeout
(optional)
int
connectorType
(optional)
JERSEY
, NETTY
, OKHTTP
credentialsId
(optional)
String
readTimeout
(optional)
int
shellScript
(optional)
String
$class: 'DoktorStep'
server
String
markdownIncludePatterns
value
String
markdownExcludePatterns
value
String
asciidocIncludePatterns
value
String
asciidocExcludePatterns
value
String
$class: 'DotNetCoreRunner'
targetCode
//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);
String
additionalPackages
String
downloadProgetPackage
Download options are:
See Inedo documentation.
feedName
String
groupName
String
packageName
String
version
String
downloadFormat
String
downloadFolder
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}
String
crxDownload
packageIds
(optional)
String
baseUrl
(optional)
username[:password]@
between the scheme and the hostname.
String
credentialsId
(optional)
/$username/keys/$fingerprint
.
String
ignoreErrors
(optional)
boolean
localDirectory
(optional)
String
rebuild
(optional)
boolean
requestTimeout
(optional)
long
serviceTimeout
(optional)
long
waitDelay
(optional)
long
googleStorageDownload
credentialsId
String
bucketUri
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
.
String
localDirectory
The local directory that will store the downloaded files. The path specified is considered relative to the build's workspace. Example value:
String
pathPrefix
(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.
String
$class: 'DoxygenBuilder'
doxyfilePath
String
installationName
String
continueOnBuildFailure
boolean
unstableIfWarnings
boolean
$class: 'DrMemoryBuilder'
executable
String
arguments
String
logPath
String
treatFailed
boolean
$class: 'DropAllBuilder'
changeLogFile
(optional)
String
changeLogParameters
(optional)
String
contexts
(optional)
String
credentialsId
(optional)
String
installationName
(optional)
String
labels
(optional)
String
liquibasePropertiesPath
(optional)
String
password
(optional)
String
resourceDirectories
(optional)
String
url
(optional)
String
username
(optional)
String
$class: 'DrupalInstanceBuilder'
db
String
root
String
profile
String
refresh
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.
boolean
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
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.
String
ignoresPass
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.
boolean
$class: 'DrupalTestsBuilder'
uri
String
root
String
logs
String
exceptGroups
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.
String
exceptClasses
Specify Simpletest classes that should not be tested, for instance 'UserLoginTestCase'.
Multiple classes can be separated by a comma.
String
$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: 'ElasticsearchQueryBuilder'
query
String
aboveOrBelow
String
threshold
long
since
long
units
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
(optional)
String
clearWorkspace
(optional)
boolean
javaOpts
(optional)
String
logging
(optional)
boolean
loglevelLibCtrl
(optional)
String
loglevelTestCtrl
(optional)
String
loglevelTestLogic
(optional)
String
pathExecutionFile
(optional)
String
pathPCode
(optional)
String
pdfMeasureImages
(optional)
boolean
pdfReport
(optional)
boolean
pdfReportTemplate
(optional)
String
pdfSelectFilter
(optional)
String
reportPrefix
(optional)
String
testrunFilter
(optional)
name
String
value
String
adminCases
boolean
activateTestcases
boolean
timeout
(optional)
int
examTest_Model
examName
String
pythonName
String
examReport
String
executionFile
(optional)
String
systemConfiguration
(optional)
String
clearWorkspace
(optional)
boolean
examModel
(optional)
String
javaOpts
(optional)
String
logging
(optional)
boolean
loglevelLibCtrl
(optional)
String
loglevelTestCtrl
(optional)
String
loglevelTestLogic
(optional)
String
modelConfiguration
(optional)
String
pdfMeasureImages
(optional)
boolean
pdfReport
(optional)
boolean
pdfReportTemplate
(optional)
String
pdfSelectFilter
(optional)
String
reportPrefix
(optional)
String
testrunFilter
(optional)
name
String
value
String
adminCases
boolean
activateTestcases
boolean
timeout
(optional)
int
$class: 'ExeBuilder'
exeName
String
cmdLineArgs
String
failBuild
boolean
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
(optional)
String
additionalParameters
(optional)
java.util.Map<java.lang.String, java.lang.Object>
failOnMissingPlugin
(optional)
boolean
failOnSeedCollision
(optional)
boolean
ignoreExisting
(optional)
boolean
ignoreMissingFiles
(optional)
boolean
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
(optional)
boolean
scriptText
(optional)
String
targets
(optional)
Scripts are executed in the same order as specified. The execution order of expanded wildcards is unspecified.
String
unstableOnDeprecation
(optional)
boolean
useScriptText
(optional)
boolean
$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
apiKey
String
serverUrl
String
projectId
String
planId
String
execMan
requestType
(optional)
String
altEMConfig
(optional)
url
String
credentials
String
bookmark
(optional)
name
String
folder
(optional)
String
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
(optional)
String
fileEncoding
(optional)
String
filterFile
(optional)
String
ignoreError
(optional)
boolean
transactionIsoLvl
(optional)
String
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
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deploymentId
(optional)
String
executionParameters
(optional)
Parameters to pass to the execution, in YAML/JSON format.
String
printLogs
(optional)
boolean
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
waitForCompletion
(optional)
boolean
workflowId
(optional)
The ID of the workflow to execute.
String
$class: 'ExecutorBuildStep'
frameworkType
String
runningType
String
app
String
testApplication
String
deviceQueries
Other field that can be used:
String
runTags
String
executorOptions
maxDevices
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.
int
minDevices
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.
int
ignoreTestsFile
String
overallExecTimeout
int
creationTimeout
int
exportIpa
appURL
(optional)
String
archiveDir
(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
String
assetPackManifestURL
(optional)
String
compileBitcode
(optional)
boolean
copyProvisioningProfile
(optional)
boolean
developmentTeamID
(optional)
String
developmentTeamName
(optional)
String
displayImageURL
(optional)
String
fullSizeImageURL
(optional)
String
ipaExportMethod
(optional)
String
ipaName
(optional)
String
ipaOutputDirectory
(optional)
String
keychainId
(optional)
String
keychainName
(optional)
String
keychainPath
(optional)
String
keychainPwd
(optional)
class hudson.util.Secret
manualSigning
(optional)
boolean
packResourcesAsset
(optional)
boolean
provisioningProfiles
(optional)
provisioningProfileAppId
String
provisioningProfileUUID
String
resourcesAssetURL
(optional)
String
signingMethod
(optional)
String
stripSwiftSymbols
(optional)
boolean
symRoot
(optional)
String
thinning
(optional)
String
unlockKeychain
(optional)
boolean
uploadBitcode
(optional)
boolean
uploadSymbols
(optional)
boolean
xcodeName
(optional)
String
xcodeProjectPath
(optional)
String
xcodeSchema
(optional)
String
xcodeWorkspaceFile
(optional)
String
exportPackages
exportConfigs
(optional)
$class: 'ExportPackageAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ExportPackageConfig'
filePath
String
exportPath
String
createNewPath
boolean
credentialsId
String
timeout
String
$class: 'ExportProjectAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ExportProjectConfig'
filePath
String
exportPath
String
createNewPath
boolean
credentialsId
String
timeout
String
$class: 'ImportPackageAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ImportPackageConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ImportPackageDirConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ImportProjectArchiveConfig'
tmsPath
String
importPath
String
importConfigPath
String
replaceFiles
boolean
$class: 'ImportProjectAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ImportProjectConfig'
tmsPath
String
importPath
String
importMissingPackages
boolean
credentialsId
String
timeout
String
$class: 'ImportProjectDirConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ExportParametersBuilder'
filePath
String
fileFormat
String
keyPattern
String
useRegexp
boolean
exportProjects
exportConfigs
(optional)
$class: 'ExportPackageAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ExportPackageConfig'
filePath
String
exportPath
String
createNewPath
boolean
credentialsId
String
timeout
String
$class: 'ExportProjectAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ExportProjectConfig'
filePath
String
exportPath
String
createNewPath
boolean
credentialsId
String
timeout
String
$class: 'ImportPackageAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ImportPackageConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ImportPackageDirConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ImportProjectArchiveConfig'
tmsPath
String
importPath
String
importConfigPath
String
replaceFiles
boolean
$class: 'ImportProjectAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ImportProjectConfig'
tmsPath
String
importPath
String
importMissingPackages
boolean
credentialsId
String
timeout
String
$class: 'ImportProjectDirConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ExporterBuilder'
$class: 'ExtensiveTestingBuilder'
testPath
String
login
String
password
String
serverUrl
String
projectName
String
debug
boolean
downloadFeatureFiles
serverAddress
String
projectKey
String
targetPath
String
featureManagementConfig
credentialsId
String
applicationIdAndName
String
environmentIdAndName
String
$class: 'FeedStatus'
prefix
String
status
String
$class: 'FigletBuilder'
message
String
fileOperations
fileOperations
fileCopyOperation
includes
String
excludes
String
targetLocation
String
flattenFiles
boolean
renameFiles
boolean
sourceCaptureExpression
String
targetNameExpression
String
fileCreateOperation
fileName
String
fileContent
String
fileDeleteOperation
includes
String
excludes
String
fileDownloadOperation
url
String
userName
String
password
String
targetLocation
String
targetFileName
String
proxyHost
String
proxyPort
String
fileJoinOperation
sourceFile
String
targetFile
String
filePropertiesToJsonOperation
sourceFile
String
targetFile
String
fileRenameOperation
source
String
destination
String
fileTransformOperation
includes
String
excludes
String
fileUnTarOperation
filePath
String
targetLocation
String
isGZIP
boolean
fileUnZipOperation
filePath
String
targetLocation
String
fileZipOperation
folderPath
String
outputFolderPath
String
folderCopyOperation
sourceFolderPath
String
destinationFolderPath
String
folderCreateOperation
folderPath
String
folderDeleteOperation
folderPath
String
folderRenameOperation
source
String
destination
String
$class: 'FireLineBuilder'
fireLineTarget
csp
If you select "Yes", this plugin will set the following content of CSP to allow access to HTML with JS or CSS.
sandbox allow-scripts; default-src *; style-src * http://* 'unsafe-inline' 'unsafe-eval'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'
Warning:
There is a security risk if you select "Yes".
boolean
blockBuild
If there are some questions of block level detected from your project,FireLine plugin will make build fail when you select "Yes".
boolean
configuration
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<fireline>
<args>
<!-- 序号对应的规则种类,用加号+相连
1:代码规范类
2:内存类
3:日志类
4:安全类
5:空指针
6:多线程
-->
<scanTypes>1+2+4+5+6</scanTypes>
<!--以上写法过滤了日志类的所有规则-->
<!--以下为过滤掉指定的单条规则,请加QQ群298228528获取规则名称-->
<filterRules>
<!--<filterRule ruleName="LogOnOffRule" />
<filterRule ruleName="LogBlockRule" />
<filterRule ruleName="LogAssignmentRule" />-->
</filterRules>
<!--过滤掉你不想检查的文件(注意:重复代码检查不支持过滤)-->
<filterFiles>
<!--过滤单个文件-->
<!--<filterFile Name="R.java"/>-->
<!--过滤整个文件夹-->
<!--<filterFile Name="/facebook/"/>-->
</filterFiles>
</args>
</fireline>
以上配置文件去掉了日志类的规则,所以火线扫描过程中就不会执行日志类规则的检查。
String
reportPath
String
reportFileName
String
buildWithParameter
可通过配置使用build with parameter插件,在项目构建时灵活使用火线扫描。
例如:在项目配置中设置参数化构建参数。配置boolean类型参数fireline。
则在此输入框中填写${fireline}即可
String
jdk
JDK to be used for this FireLine analysis.
Tips:
JDK1.7 or 1.8 is compatible with FireLine.
String
jvm
合理设置JVM参数可以有效提高扫描效率,建议JVM最低配置如下:
"-Xms1g -Xmx1g -XX:MaxPermSize=512m"
String
$class: 'FitnesseBuilder'
options
java.util.Map<java.lang.String, java.lang.String>
$class: 'FixResultBuilder'
defaultResultName
String
success
String
unstable
String
failure
String
aborted
String
flywayrunner
installationName
String
flywayCommand
String
url
String
locations
String
commandLineArgs
String
credentialsId
String
$class: 'FogbugzLinkBuilder'
frugalTesting
userId
String
testId
String
runTag
String
getJtl
boolean
serverUrl
(optional)
String
$class: 'FtpRenameBuilder'
ftpServer
String
ftpPort
if you don't specify the port, the default port is 21.
int
ftpUser
String
ftpPassword
class hudson.util.Secret
ftpPath
Specify the path to your artifact.
String
artifactName
(optional)
String
newArtifactName
(optional)
String
remoteDirectory
(optional)
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder won't be created if does not exist.
String
$class: 'FuzzBuildStep'
configurationFilePath
The file path where the test configuration file (*.set or *.testplan) for this job can be found, relative to the project's workspace.
A test configuration file defines what kind of testing is to be done, and can be created using Defensics. Configure a test suite in Defensics and save the settings file in File -> Save Settings.
String
configurationOverrides
(optional)
Additional test configuration settings that override the settings saved in the test configuration file. This can be useful if, for example, the test target address needs to be set dynamically.
The available settings are the same as the Defensics command line settings. Each setting should follow the format '--setting-name value'. Multiple settings are separated with spaces.
Example for HTTP Server Test Suite:
--uri https://example.com --http-status-filter "1xx 2xx 3xx"
String
defensicsInstance
(optional)
String
saveResultPackage
(optional)
boolean
$class: 'FxCopBuilder'
toolName
String
files
Assembly file(s) to analyze.
You can specify multiple analyze assemblies by separating them with new-line or space.
Command Line Argument: /file:[ file/directory ]
String
outputXML
FxCop project or XML report output file.
Command Line Argument: /out:[ output file path ]
String
ruleSet
Rule set to be used for the analysis.
Command Line Argument: /ruleset:=[ Rule set file path ]
String
ignoreGeneratedCode
Suppress analysis results against generated code.
Command Line Argument: /ignoregeneratedcode
boolean
forceOutput
Write output XML and project files even in the case where no violations occurred.
Command Line Argument: /forceoutput
boolean
cmdLineArgs
String
failBuild
boolean
$class: 'GCloudSDKBuilder'
command
String
$class: 'GCloudSDKWithAuthBuilder'
credentialsId
String
command
String
$class: 'GatekeeperCommit'
commitUsername
String
$class: 'GatekeeperMerge'
commitUsername
String
releaseFilePath
String
releaseFileContentTemplate
String
$class: 'GatekeeperPush'
gcrImageVulnerabilityScanner
imageName
(optional)
String
genexusb
gxInstallationId
String
kbPath
String
kbVersion
String
kbEnvironment
String
kbDbCredentialsId
String
forceRebuild
boolean
$class: 'GenerateChangeScriptBuilder'
in
Specify path to input folder for generating SQL change script. This folder should contain result of previously executed "Run Compare" build step.
Folder location must be specified as:
String
out
Path to the file that should be used to store SQL change script.
File location must be specified as:
String
$class: 'GenerateCreateScriptBuilder'
outputFile
Path to the file that should be used to store create SQL script.
File location must be specified as:
String
inputFileOrFolder
Specify input folder/file for generating create SQL script. It should depend on input type you have selected.
Folder/file location must be specified as:
String
$class: 'GenerateJenkinsReportBuilder'
Generate a HTML report based on a previous schema compare build step. This report is accessible via build detail within build history in Jenkins.
Warning: You can include only one Generate Jenkins HTML comparison report step per project.
inputFolder
Specify path to input folder containing output from "Run Compare" build step.
Folder location must be specified as:
String
$class: 'GenerateStandaloneReportBuilder'
inputFolder
Specify path to input folder containing output from "Run Compare" build step.
Folder location must be specified as:
String
outputFolder
Specify path to folder where standalone report will be exported.
Folder location must be specified as:
String
ghostInspector
apiKey
String
suiteId
String
startUrl
String
params
String
gitAutomerger
checkoutFromRemote
(optional)
boolean
detailConflictReport
(optional)
boolean
limitAuthorsInDetailReport
(optional)
int
limitCommitsInDetailReport
(optional)
int
logLevel
(optional)
TRACE
, DEBUG
, INFO
, WARN
, ERROR
mergeRules
(optional)
path
String
resolution
KEEP_OLDER
, KEEP_NEWER
, MERGE_OLDER_TOP
, MERGE_NEWER_TOP
releaseBranchPattern
(optional)
String
remoteName
(optional)
String
gitbisect
jobToRun
String
goodStartCommit
String
badEndCommit
String
searchIdentifier
String
revisionParameterName
String
retryCount
int
continuesBuild
boolean
minSuccessfulIterations
int
overrideGitCommand
boolean
gitCommand
String
gitHubPRStatus
statusMessage
content
String
$class: 'GitHubSetCommitStatusBuilder'
contextSource
(optional)
$class: 'DefaultCommitContextSource'
$class: 'ManuallyEnteredCommitContextSource'
context
String
statusMessage
(optional)
content
String
$class: 'GitStatusWrapperBuilder'
The gitStatusWrapper
builder wraps set of job builders and handles PENDING/SUCCESS/FAILURE git statuses automatically
Check documentation here
buildSteps
hudson.tasks.BuildStep
)account
(optional)
The GitHub account that owns the repos that contains the commit to notify
Default: If SCM used, plugin will attempt to get details from SCM execution
Check documentation here
String
credentialsId
(optional)
The GitHub credentials, username/password or username/accessToken
String
description
(optional)
String
failureDescription
(optional)
The notification description for a failure, it will be displayed by GitHub
Default: value set to description
This field can also be given a regular expression to evaluate on the entire build log. To have the expression evaluated, wrap it with "/". Example: "/^buildVersion=(.*)$/"
Check documentation here
String
gitApiUrl
(optional)
If you are a user of GitHub Enterprise use this field to set your custom API endpoint
Default: https://api.github.com
String
gitHubContext
(optional)
The git status context key. Keys are used by GitHub to differentiate between notifications
Default: gitStatusWrapper
Check documentation here
String
repo
(optional)
The GitHub repository that contains the commit to validate, must be owned by the user specified in the account field
Default: If SCM used, plugin will attempt to get details from SCM execution
Check documentation here
String
sha
(optional)
The SHA that identifies the commit to notify
Default: If SCM used, plugin will attempt to get details from SCM execution
Check documentation here
String
successDescription
(optional)
The notification description for a success, it will be displayed by GitHub
Default: value set to description
This field can also be given a regular expression to evaluate on the entire build log. To have the expression evaluated, wrap it with "/". Example: "/^buildVersion=(.*)$/"
Check documentation here
String
targetUrl
(optional)
Use this field to specify a custom target URL for the notification
Default: Jenkins build URL
Check documentation here
String
$class: 'GitToIspwPublish'
app
(optional)
String
branchMapping
(optional)
String
connectionId
(optional)
String
credentialsId
(optional)
String
ispwConfigPath
(optional)
String
runtimeConfig
(optional)
String
stream
(optional)
String
$class: 'GnatmakeBuilder'
gnatName
String
switches
String
fileNames
String
modeSwitches
String
gprbuild
installationName
(optional)
String
names
(optional)
String
proj
(optional)
-P
switch. If not specified, GPRbuild uses the project file default.gpr if there is one in the current working directory. Otherwise, if there is only one project file in the current working directory, GPRbuild uses this project file.
String
switches
(optional)
String
gradle
buildFile
(optional)
String
gradleName
(optional)
String
makeExecutable
(optional)
boolean
passAllAsProjectProperties
(optional)
boolean
passAllAsSystemProperties
(optional)
boolean
projectProperties
(optional)
String
rootBuildScriptDir
(optional)
String
switches
(optional)
String
systemProperties
(optional)
String
tasks
(optional)
String
useWorkspaceAsHome
(optional)
Gradle will write to $HOME/.gradle by default for GRADLE_USER_HOME. For a multi-executor agent in Jenkins, setting the environment variable localized files to the workspace avoid collisions accessing gradle cache.
boolean
useWrapper
(optional)
boolean
wrapperLocation
(optional)
String
gradleForesight
projectId
String
credentialId
String
thundraAgentVersion
(optional)
String
thundraGradlePluginVersion
(optional)
String
$class: 'Groovy'
Executes a groovy script.
scriptSource
$class: 'FileScriptSource'
scriptFile
String
$class: 'StringScriptSource'
command
String
groovyName
Groovy installation which will execute the script. Specify the name of the Groovy installation as specified in the Global Jenkins configuration.
String
parameters
Parameters for the Groovy executable.
String
scriptParameters
These parameters will be passed to the script.
String
properties
Instead of passing properties using the -D parameter you can define them here.
String
javaOpts
Direct access to JAVA_OPTS. Properties allows only -D properties, while sometimes also other properties like -XX need to be setup. It can be done here. This line is appended at the end of JAVA_OPTS string.
String
classPath
Specify script classpath here. Each line is one class path item.
String
$class: 'GroovyRemoteBuilder'
remoteName
String
script
String
examRun_Groovy
examName
String
script
(optional)
String
startElement
(optional)
String
examModel
(optional)
String
modelConfiguration
(optional)
String
javaOpts
(optional)
String
timeout
(optional)
int
useStartElement
(optional)
boolean
$class: 'GsshCommandBuilder'
disable
boolean
serverInfo
String
shell
String
$class: 'GsshFtpDownloadBuilder'
disable
boolean
serverInfo
String
remoteFile
String
localFolder
String
fileName
String
$class: 'GsshFtpUploadBuilder'
disable
boolean
serverInfo
String
localFilePath
String
remoteLocation
String
fileName
String
$class: 'GsshShellBuilder'
disable
boolean
serverInfo
String
shell
String
$class: 'HOTPlayer'
project
String
bundle
class com.arkea.jenkins.openstack.heat.orchestration.template.Bundle
habitat
task
(optional)
String
directory
(optional)
String
artifact
(optional)
String
channel
(optional)
String
origin
(optional)
String
bldrUrl
(optional)
String
authToken
(optional)
String
lastBuildFile
(optional)
String
format
(optional)
String
searchString
(optional)
String
command
(optional)
String
binary
(optional)
String
path
(optional)
String
docker
(optional)
boolean
healthAnalyzer
products
$class: 'HealthAnalyzerLrStep'
checkLrInstallation
boolean
checkOsVersion
boolean
checkFiles
filesList
field
String
nodePoolHold
duration
String
reason
String
$class: 'HttpRequest'
url
String
acceptType
(optional)
NOT_SET
, TEXT_HTML
, TEXT_PLAIN
, APPLICATION_FORM
, APPLICATION_JSON
, APPLICATION_JSON_UTF8
, APPLICATION_TAR
, APPLICATION_ZIP
, APPLICATION_OCTETSTREAM
authentication
(optional)
String
consoleLogResponseBody
(optional)
boolean
contentType
(optional)
NOT_SET
, TEXT_HTML
, TEXT_PLAIN
, APPLICATION_FORM
, APPLICATION_JSON
, APPLICATION_JSON_UTF8
, APPLICATION_TAR
, APPLICATION_ZIP
, APPLICATION_OCTETSTREAM
customHeaders
(optional)
name
String
value
String
maskValue
boolean
httpMode
(optional)
GET
, HEAD
, POST
, PUT
, DELETE
, OPTIONS
, PATCH
httpProxy
(optional)
String
ignoreSslErrors
(optional)
boolean
multipartName
(optional)
String
outputFile
(optional)
String
passBuildParameters
(optional)
boolean
proxyAuthentication
(optional)
String
quiet
(optional)
boolean
requestBody
(optional)
String
timeout
(optional)
int
uploadFile
(optional)
String
useSystemProperties
(optional)
boolean
validResponseCodes
(optional)
String
validResponseContent
(optional)
String
wrapAsMultipart
(optional)
boolean
hugo
baseUrl
(optional)
String
buildFuture
(optional)
boolean
destination
(optional)
String
environment
(optional)
String
hugoHome
(optional)
String
verbose
(optional)
boolean
$class: 'HyperBuilder'
image
String
commands
String
ipythonBuilder
code
Eg: print(" Hello Jenkins, from Machine Learning Plugin ...... ! ")
String
filePath
Eg: /home/alice/iris/ml.py
String
parserType
String
task
Eg: Training
String
kernelName
String
$class: 'ITest'
workspace
Required.
(1) Provide the full path to the iTest workspace containing projects, or
(2) Leave blank to indicate that the current job's workspace is also an iTest workspace (must contain an .iTestWorkspace file as created by iTest)
String
projects
Required. Specify the name of the iTest project to export in an ITAR file (required to use iTestRT). Separate names of multiple projects with comma.
Note: The project must exist within the specified iTest workspace.
String
testcases
Required. Specify path to test case or test suite to run: must include extension (path/name.fftc or path/name.ffts). Separate multiple with a comma.
Accepted Formats:
project://projectname/path/to/testcase
/full/path/to/testcase
Examples:
project://system_test/regression_test.fftc
${WORKSPACE}/system_test/regression_test.fftc
String
testbed
Specify the URI of the testbed or topology to use for execution. Must include file extension. Overrides the testbed specified in the test case file.
Accepted Formats:
/path/to/topology.tbml
Examples:
${WORKSPACE}/system_test/topologies/demo.tbml
String
params
Specify a parameter value in the format parameter=value. Separate multiple parameter/value pairs with a comma.
Note: If you specify both --param and --paramfile in an iTestRT command, then the --param argument takes precedence over the values in the parameter file.
String
paramFile
Specify URI of a parameter file in an iTest readable format.
Note: If you specify both --param and --paramfile in an iTestRT command, then the --param argument take precedence over the values in the parameter file.
String
testReportRequired
Check this to generate test report in HTML format.
A link to the report will be provided on the project page, and the report will be available in the iTest workspace specified in the project configuration page.
boolean
dbCustomTag
This option enables you to define and assign a value to a custom tag.
Example: Create a tag that holds the build number so that you compare test execution results between builds.
For tests run against build 54322, use: --tag buildNumber=54322
Tip: Use a custom tag to identify executions or groups of executions on the iTest Team Server Test Execution page.
String
$class: 'ImportFiles'
url
String
cloudTestServerID
String
files
String
excludes
String
mode
String
additionalOptions
String
importPackages
importConfigs
(optional)
$class: 'ExportPackageAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ExportPackageConfig'
filePath
String
exportPath
String
createNewPath
boolean
credentialsId
String
timeout
String
$class: 'ExportProjectAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ExportProjectConfig'
filePath
String
exportPath
String
createNewPath
boolean
credentialsId
String
timeout
String
$class: 'ImportPackageAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ImportPackageConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ImportPackageDirConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ImportProjectArchiveConfig'
tmsPath
String
importPath
String
importConfigPath
String
replaceFiles
boolean
$class: 'ImportProjectAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ImportProjectConfig'
tmsPath
String
importPath
String
importMissingPackages
boolean
credentialsId
String
timeout
String
$class: 'ImportProjectDirConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
importProjects
importConfigs
(optional)
$class: 'ExportPackageAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ExportPackageConfig'
filePath
String
exportPath
String
createNewPath
boolean
credentialsId
String
timeout
String
$class: 'ExportProjectAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ExportProjectConfig'
filePath
String
exportPath
String
createNewPath
boolean
credentialsId
String
timeout
String
$class: 'ImportPackageAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ImportPackageConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ImportPackageDirConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ImportProjectArchiveConfig'
tmsPath
String
importPath
String
importConfigPath
String
replaceFiles
boolean
$class: 'ImportProjectAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ImportProjectConfig'
tmsPath
String
importPath
String
importMissingPackages
boolean
credentialsId
String
timeout
String
$class: 'ImportProjectDirConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'InfluxDBPublisher'
userCredentialsID
String
dbUrl
String
dbName
String
content
String
influxDbQuery
checkName
String
influxQuery
String
expectedThreshold
double
markUnstable
(optional)
boolean
retryCount
(optional)
int
retryInterval
(optional)
int
showResults
(optional)
boolean
insightAppSec
region
String
insightCredentialsId
String
appId
String
scanConfigId
String
buildAdvanceIndicator
String
vulnerabilityQuery
vulnerability.severity='HIGH'
String
maxScanPendingDuration
0d 5h 30m
String
maxScanExecutionDuration
0d 5h 30m
String
enableScanResults
boolean
snInstallApp
credentialsId
(optional)
String
apiVersion
(optional)
String
appScope
(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.
String
appSysId
(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.
String
appVersion
(optional)
String
baseAppAutoUpgrade
(optional)
boolean
baseAppVersion
(optional)
String
url
(optional)
String
$class: 'InstallBuilder'
apkFile
String
uninstallFirst
boolean
failOnInstallFailure
boolean
snInstanceScan
credentialsId
(optional)
String
apiVersion
(optional)
String
comboSysId
(optional)
String
requestBody
(optional)
String
scanType
(optional)
String
suiteSysId
(optional)
String
targetRecordSysId
(optional)
String
targetTable
(optional)
String
url
(optional)
String
$class: 'IqPolicyEvaluatorBuildStep'
iqStage
String
iqApplication
manualApplication
applicationId
String
selectedApplication
applicationId
String
iqScanPatterns
**/target/*.war
or **/target/*.ear
. If unspecified, the scan will default to the patterns **/*.jar, **/*.war, **/*.ear, **/*.zip, **/*.tar.gz
.
scanPattern
String
iqModuleExcludes
**/nexus-iq/module.xml
) to be ignored, e.g. **/my-module/target/**, **/another-module/target/**
. If unspecified all modules will contribute dependency information (if any) to the scan.
moduleExclude
String
failBuildOnNetworkError
boolean
jobCredentialsId
- none -
, otherwise select different credentials.
String
enableDebugLogging
boolean
advancedProperties
key1=value1
key2=value2
String
iqInstanceId
(optional)
String
$class: 'IspwRestApiRequest'
connectionId
(optional)
String
consoleLogResponseBody
(optional)
boolean
credentialsId
(optional)
String
ispwAction
(optional)
String
ispwRequestBody
(optional)
String
skipWaitingForSet
(optional)
boolean
$class: 'IssueFieldUpdateStep'
issueSelector
(optional)
$class: 'DefaultIssueSelector'
$class: 'ExplicitIssueSelector'
issueKeys
String
$class: 'JqlIssueSelector'
jql
String
$class: 'P4JobIssueSelector'
fieldId
(optional)
String
fieldValue
(optional)
String
$class: 'IssueUpdatesBuilder'
restAPIUrl
String
userName
String
password
String
jql
String
workflowActionName
String
comment
String
customFieldId
String
customFieldValue
String
resettingFixedVersions
boolean
createNonExistingFixedVersions
boolean
fixedVersions
String
failIfJqlFails
boolean
failIfNoIssuesReturned
boolean
failIfNoJiraConnection
boolean
$class: 'JBossBuilder'
operation
value
START_AND_WAIT
, START
, SHUTDOWN
, CHECK_DEPLOY
properties
String
stopOnFailure
boolean
serverName
String
$class: 'JIRATicketEditor'
jiraCredentialsID
String
newTicketsTemplates
performDuplicateCheck
boolean
parentJQL
String
title
String
type
String
priority
String
description
String
envVarName
String
fieldValues
fieldHumanReadableName
String
valueToSet
String
modifyTicketsTemplates
jqlFilter
String
commitRegEx
String
ticketSource
String
modifications
$class: 'AddCommentModification'
commentBody
String
$class: 'ModifyArrayFieldModification'
fieldHumanReadableName
String
modificationType
String
modificationValue
String
$class: 'PerformTransitionModification'
transitionName
String
comment
String
$class: 'SetFieldModification'
fieldHumanReadableName
String
valueToSet
String
$class: 'JIRAVersionEditor'
jiraCredentialsID
String
versionModifiactions
versionName
String
replaceDescription
boolean
descriptionText
String
releaseState
String
failOnJQL
boolean
failQuery
String
$class: 'JSLintBuilder'
includePattern
The files to include in an Ant-style filter. See javadoc
Example: lib/**/*.js
This would grab files including lib/foo.js and lib/foo/bar/baz.js
Example: lib/*.js
This would include lib/foo.js but not lib/foo/bar.js
String
excludePattern
The files to exclude in an Ant-style filter. See javadoc
Example: lib/**/ModuleImportProgressDialog.js
This would omit any file named ModuleImportProgressDialog.js
String
logfile
The file to output to in a Checkstyle XML format
Example: target/jslint.xml
String
arguments
The arguments to pass to JSLint. You can use any arguments that JSLint supports! Be sure, though, to prefix each argument with -D
Example: -Dadsafe=true, -Dcontinue=true
This would activate adsafe and continue
Example: -Dpredef=foo,bar,baz
This would be like having /*global foo,bar,baz*/ at the top of every JavaScript file JSLint runs on.
Example: -Dpredef=foo,bar,baz, -Dmaxlen=80
This would be like having /*global foo,bar,baz*/ at the top of every JavaScript file JSLint runs on. It also sets the maximum length of a line to 80 chars.
The default options we use are:
var defaultOptions = { bitwise: true, eqeqeq: false, immed: false, newcap: false, nomen: false, onevar: false, plusplus: false, regexp: false, rhino: true, undef: true, white: false, forin: true, sub: true, browser: true, laxbreak: true, predef: [ 'Ext', 'jQuery', 'window', '$', 'ActiveXObject', 'SWFObject' ] };
String
$class: 'JabberBuilder'
builderName
String
venafiCodeSignWithJarSigner
tppName
String
certLabel
String
extraArgs
(optional)
This plugin invokes Jarsigner under the hood. Here you can specify extra custom CLI arguments to pass to Jarsigner.
These arguments will be appended to the Jarsigner CLI invocation, and take precedence over any arguments implicitly passed by this plugin.
argument
String
file
(optional)
The path to the file to be signed.
Either a path or a glob must be given.
String
glob
(optional)
A glob that specifies the files to be signed.
Either a path or a glob must be given.
String
timestampingServers
(optional)
Specifies one or more timestamping authority servers to use during signing. Specifying this is strongly recommended, because it allows signed files to be usable even after the original signing certificate has expired.
If you specify more than one server, then a random one will be used.
Tip: here are some public timestamping authorities that you can use:
address
String
venafiClientToolsDir
(optional)
Specify the path to the directory in which Venafi CodeSign Protect client tools are installed. If not specified, it's autodetected as follows:
String
venafiVerifyWithJarSigner
tppName
String
certLabel
String
file
(optional)
The path to the file to be verified.
Either a path or a glob must be given.
String
glob
(optional)
A glob that specifies the files to be verified.
Either a path or a glob must be given.
String
venafiClientToolsDir
(optional)
Specify the path to the directory in which Venafi CodeSign Protect client tools are installed. If not specified, it's autodetected as follows:
String
$class: 'JbpmUrlResourceBuilder'
url
String
processId
String
SoapUIPro
pathToTestrunner
String
pathToProjectFile
String
environment
(optional)
String
projectPassword
(optional)
String
testCase
(optional)
String
testCaseTags
(optional)
String
testSuite
(optional)
String
testSuiteTags
(optional)
String
$class: 'JigomergeBuilder'
source
String
username
String
password
String
oneByOne
boolean
eager
boolean
validationScript
String
dryRun
boolean
verbose
boolean
ignoreMergePatterns
String
commitCommentPrefix
String
$class: 'JiraEnvironmentVariableBuilder'
Typical usage:
issue in (${JIRA_ISSUES})
issueSelector
$class: 'DefaultIssueSelector'
$class: 'ExplicitIssueSelector'
issueKeys
String
$class: 'JqlIssueSelector'
jql
String
$class: 'P4JobIssueSelector'
$class: 'JiraExtBuildStep'
issueStrategy
$class: 'FirstWordOfCommitStrategy'
$class: 'FirstWordOfUpstreamCommitStrategy'
$class: 'MentionedInCommitStrategy'
$class: 'SingleTicketStrategy'
issueKey
String
extensions
$class: 'AddComment'
postCommentForEveryCommit
boolean
commentText
String
$class: 'AddFixVersion'
fixVersion
The Fix Version to append. Must exist.
String
$class: 'AddLabel'
labelName
String
$class: 'AddLabelToField'
fieldName
String
fieldValue
String
$class: 'Transition'
transitionName
String
$class: 'UpdateField'
fieldName
String
fieldValue
String
$class: 'JiraIssueUpdateBuilder'
jqlSearch
Example:
or (e.g., combined with a Jira Issue Parameter, selecting one issue from a JQL result set):project = JENKINS and fixVersion = "$RELEASE_VERSION" and status not in (Resolved, Closed)
issue = $ISSUE_ID
String
workflowActionName
String
comment
String
$class: 'JiraReleaseVersionUpdaterBuilder'
jiraProjectKey
Specify the project key. A project key is the all capitals part before the issue number in Jira.
(EXAMPLE-100)
String
jiraRelease
String
jiraDescription
String
$class: 'JiraVersionCreatorBuilder'
jiraVersion
String
jiraProjectKey
Specify the project key. A project key is the all capitals part before the issue number in Jira.
(EXAMPLE-100)
String
$class: 'JobConfigRebrander'
$class: 'JobDeleteBuilder'
target
String
$class: 'JobStrongAuthSimpleBuilder'
jobUsers
String
useGlobalUsers
boolean
jobMinAuthUserNum
int
useJobExpireTime
boolean
jobExpireTimeInHours
int
$class: 'JobcopyBuilder'
fromJobName
String
toJobName
String
overwrite
boolean
jobcopyOperationList
$class: 'DisableOperation'
$class: 'EnableOperation'
$class: 'ReplaceOperation'
fromStr
String
expandFromStr
boolean
toStr
String
expandToStr
boolean
additionalFilesetList
includeFile
String
excludeFile
String
overwrite
boolean
jobcopyOperationList
$class: 'DisableOperation'
$class: 'EnableOperation'
$class: 'ReplaceOperation'
fromStr
String
expandFromStr
boolean
toStr
String
expandToStr
boolean
$class: 'KanboardTaskFetcher'
projectIdentifier
String
taskReference
String
taskAttachments
(optional)
String
taskLinks
(optional)
String
$class: 'KarafBuildStepBuilder'
useCustomKaraf
boolean
karafHome
String
flags
specify the port to connect to
-h [host]specify the host to connect to
-u [user]specify the user name
-p [password]specify the password (optional, if not provided, the password is prompted)
-vraise verbosity
-lset client logging level. Set to 0 for ERROR logging and up to 4 for TRACE
-r [attempts]retry connection establishment (up to attempts times)
-d [delay]intra-retry delay (defaults to 2 seconds)
-f [file]read commands from the specified file
-k [keyFile]specify the private keyFile location when using key login, need have BouncyCastle registered as security provider using this flag
-t [timeout]define the client idle timeout
String
option
$class: 'KarafCommandFileOption'
file
String
$class: 'KarafCommandScriptOption'
script
(optional)
String
unlockMacOSKeychain
keychainId
(optional)
String
keychainName
(optional)
String
keychainPath
(optional)
String
keychainPwd
(optional)
class hudson.util.Secret
$class: 'KlocworkBuildSpecBuilder'
buildSpecConfig
buildCommand
String
tool
String
output
String
additionalOpts
String
ignoreErrors
boolean
$class: 'KlocworkCiBuilder'
ciConfig
buildSpec
String
projectDir
String
cleanupProject
boolean
reportFile
String
additionalOpts
String
incrementalAnalysis
This feature allows for quick, incremental analyses of changed source files to enable pre/post-checkin/commit-like behavior . The goal is that only changed files are analyzed by the Klocwork kwciagent tool to replicate the local analysis developers would perform by using our supported IDE plugins or the command line utility. To enable this behavior, the plugin takes a list of the changed files from the SCM; this enables the system to analyze only the changed files when the workspace isn’t kept. Leave this cleared to analyze the whole project, or, if the workspace is kept, to perform a standard incremental analysis.
The diff file list is the file that contains the changed source files for Klocwork to analyze. All analyzed files must exist in the build specification generated by kwinject.
Note: All files to be analyzed must exist in the build specification.
If using Git, provide the previous commit that Git should perform a "diff" against. The change list between the current commit and the specified previous commit will be added to the diff file list for Klocwork to process by automatically calling "git diff <previous_commit>" during the build. Note: If you are using Git jenkins plugin to obtain source files for you pipeline job be sure to use 'Pipeline script from SCM' and specify the previous commit with the environment variable, 'GIT_PREVIOUS_COMMIT'. Also be aware that the first build in the job won't be able to access GIT_PREVIOUS_COMMIT and the first build will run full CI analysis.
If you are not using Git, or want to manually generate the change list by using Git, select this option. You will need to generate the diff file list by using a custom build-step (or similar). List one changed source file on each line of the file.
boolean
differentialAnalysisConfig
diffType
String
gitPreviousCommit
String
diffFileList
String
$class: 'KlocworkServerAnalysisBuilder'
serverConfig
buildSpec
String
tablesDir
String
incrementalAnalysis
boolean
ignoreCompileErrors
boolean
importConfig
String
additionalOpts
String
disableKwdeploy
boolean
duplicateFrom
(optional)
String
enabledCreateProject
(optional)
boolean
$class: 'KlocworkServerLoadBuilder'
serverConfig
(optional)
tablesDir
(optional)
String
buildName
(optional)
String
additionalOpts
(optional)
String
reportConfig
(optional)
displayChart
(optional)
boolean
chartHeight
(optional)
String
chartWidth
(optional)
String
query
(optional)
String
$class: 'KlocworkXSyncBuilder'
syncConfig
dryRun
boolean
lastSync
String
projectRegexp
String
statusAnalyze
boolean
statusIgnore
boolean
statusNotAProblem
boolean
statusFix
boolean
statusFixInNextRelease
boolean
statusFixInLaterRelease
boolean
statusDefer
boolean
statusFilter
boolean
additionalOpts
String
$class: 'KmapJenkinsBuilder'
username
String
password
String
kmapClient
String
categories
String
teams
String
users
String
sendNotifications
boolean
publishOptional
teams
String
users
String
sendNotifications
boolean
filePath
String
appName
String
bundle
String
version
String
description
String
iconPath
String
$class: 'KojiBuilder'
kojiBuild
String
kojiTarget
String
kojiPackage
String
kojiOptions
String
kojiTask
String
kojiScratchBuild
boolean
kojiScmUrl
String
cfyKubernetes
allowNodeRedefinition
(optional)
boolean
apiKeyCredentialsId
(optional)
The ID of the credentials entry that contains the API key.
This parameter is optional; the API key may also be provided through "API options", however this method is preferred.
If provided, then this credentials entry must either be of type "text" or "file". In the latter case, the file is read as-is and the resultant string is used as the API credentials.
String
apiKeyFile
(optional)
Path to file, relative to the Jenkins workspace, containing the API key.
This parameter is optional, as the API key may be provided by other means.
String
caCert
(optional)
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
definition
(optional)
java.util.Map<java.lang.String, java.lang.Object>
definitionAsString
(optional)
String
definitionFile
(optional)
String
deploymentId
(optional)
ID to assign to the created Cloudify deployment. If not provided, one will be randomly generated. You can obtain the deployment ID from the "environment data" output file.
String
echoEnvData
(optional)
If checked, then the created environment's data will be printed to the job's log.
boolean
echoInputs
(optional)
boolean
envDataLocation
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
String
gcpCredentialsFile
(optional)
A YAML/JSON file containing GCP service account details, to use for authentication against GCP.
This parameter is optional, and is only relevant for authenticating against GCP.
If provided, it should follow the same layout as described in the "GCP Credentials ID" parameter.
String
gcpCredentialsId
(optional)
The ID of the credentials to be used for authentication against GCP.
This parameter is optional, and is only relevant for authenticating against GCP.
If provided, it should be the ID of either a string-type or file-type credentials entry, with the standard GCP service account YAML/JSON syntax:
{ "type": "...", "project_id": "...", "private_key_id": "...", "private_key": "...", "client_email": "...", "client_id": "...", "auth_uri": "...", "token_uri": "...", "auth_provider_x509_cert_url": "...", "client_x509_cert_url": "..." }
String
k8sDebug
(optional)
boolean
k8sMaster
(optional)
String
namespace
(optional)
namespace
value in the options
field, if exists.
String
options
(optional)
java.util.Map<java.lang.String, java.lang.Object>
optionsAsString
(optional)
String
optionsFile
(optional)
String
skipSslVerification
(optional)
boolean
sslCertFile
(optional)
String
sslKeyFile
(optional)
String
tenant
(optional)
String
validateStatus
(optional)
boolean
$class: 'KubernetesDeploy'
context
configs
(optional)
The path patterns for the Kubernetes configurations you want to deploy, in the form of Ant glob syntax.
String
credentialsType
(optional)
Choose how to get the kubeconfig file to authenticate with the Kubernetes cluster management endpoint.
3 options are supported:
~/.kube/config
file through an SSH connection to the master node.See also: Configure kubectl
String
deleteResource
(optional)
Whether to delete the resource, if it is true, delete all resources in the config file.
boolean
dockerCredentials
(optional)
url
https://index.docker.io/v1/
).
String
credentialsId
String
enableConfigSubstitution
(optional)
Substitute variables (in the form $VARIABLE
or ${VARIABLE}
) in the configuration with values from Jenkins environment variables.
This allows you to use dynamic values produced during the build in your Kubernetes configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.
boolean
kubeConfig
(optional)
path
(optional)
kubeconfig
file path relative to the current Jenkins workspace.
String
kubeconfigId
(optional)
String
secretName
(optional)
imagePullSecrets
entry. Environment variable substitution are supported for the name input, so you can use available environment variables to construct the name dynamically, e.g., some-secret-$BUILD_NUMBER
. The name should be in the pattern [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*
, i.e., dot (.) concatenated sequences of hyphen (-) separated alphanumeric words. (See Kubernetes Names)
If left blank, the plugin will generate a name based on the build name.
The secret name will be exposed with the environment variable $KUBERNETES_SECRET_NAME
. You can use this in your Kubernetes configuration to reference the updated secret when the "Enable Variable Substitution in Config" option is enabled.
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: nginx
spec:
replicas: 1
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: some.private.registry.domain/nginx
ports:
- containerPort: 80
imagePullSecrets:
- name: $KUBERNETES_SECRET_NAME
Note that once the secret is created, it will only be updated by the plugin. You have to manually delete it when it is not used anymore. If this is a problem, you may use fixed name so every time the job runs, the secret gets updated and no new secret is created.
String
secretNamespace
(optional)
String
ssh
(optional)
sshCredentialsId
(optional)
String
sshServer
(optional)
<host>[:<port>]
) of the Kubernetes master node. If port is omitted, the default SSH port 22 will be used.
String
textCredentials
(optional)
certificateAuthorityData
(optional)
clusters.cluster.certificate-authority-data
value in the kubeconfig
file.
String
clientCertificateData
(optional)
users.user.client-certificate-data
value in the kubeconfig
file.
String
clientKeyData
(optional)
users.user.client-key-data
value in the kubeconfig
file.
String
serverUrl
(optional)
clusters.cluster.server
address in the kubeconfig
. Generally, it should start with https://
.
String
kubernetesEngineDeploy
cluster
(optional)
String
clusterName
(optional)
String
credentialsId
(optional)
String
location
(optional)
String
manifestPattern
(optional)
String
namespace
(optional)
String
projectId
(optional)
String
verboseLogging
(optional)
boolean
verifyDeployments
(optional)
boolean
verifyServices
(optional)
boolean
verifyTimeoutInMinutes
(optional)
int
zone
(optional)
String
loadcompletetest
project
(optional)
String
test
(optional)
String
actionOnErrors
(optional)
String
actionOnWarnings
(optional)
String
executorVersion
(optional)
String
generateMHT
(optional)
boolean
generatePDF
(optional)
boolean
timeout
(optional)
String
useTimeout
(optional)
boolean
leanIXMicroserviceIntelligence
apitoken
(optional)
class hudson.util.Secret
dependencymanager
(optional)
String
deploymentstage
(optional)
String
deploymentversion
(optional)
String
hostname
(optional)
String
jobresultchoice
(optional)
String
lxmanifestpath
(optional)
String
useleanixconnector
(optional)
boolean
eventSourceLambda
lambdaEventSourceBuildStepVariables
awsRegion
String
functionName
String
eventSourceArn
String
awsAccessKeyId
(optional)
String
awsSecretKey
(optional)
String
functionAlias
(optional)
String
useInstanceCredentials
(optional)
boolean
invokeLambda
lambdaInvokeBuildStepVariables
awsRegion
String
functionName
String
synchronous
boolean
awsAccessKeyId
(optional)
String
awsSecretKey
(optional)
String
jsonParameters
(optional)
envVarName
String
jsonPath
(optional)
String
payload
(optional)
String
useInstanceCredentials
(optional)
boolean
publishLambda
lambdaPublishBuildStepVariables
awsRegion
String
functionARN
String
functionAlias
String
versionDescription
String
awsAccessKeyId
(optional)
String
awsSecretKey
(optional)
String
useInstanceCredentials
(optional)
boolean
deployLambda
lambdaUploadBuildStepVariables
awsRegion
String
functionName
String
updateMode
String
alias
(optional)
String
artifactLocation
(optional)
String
awsAccessKeyId
(optional)
String
awsSecretKey
(optional)
String
createAlias
(optional)
boolean
deadLetterQueueArn
(optional)
String
description
(optional)
String
enableDeadLetterQueue
(optional)
boolean
environmentConfiguration
(optional)
environment
key
String
value
String
configureEnvironment
(optional)
boolean
kmsArn
(optional)
String
handler
(optional)
String
memorySize
(optional)
String
publish
(optional)
boolean
role
(optional)
String
runtime
(optional)
String
securityGroups
(optional)
String
subnets
(optional)
String
timeout
(optional)
String
useInstanceCredentials
(optional)
boolean
$class: 'LeapworkJenkinsBridgeBuilder'
leapworkHostname
String
leapworkPort
String
leapworkAccessKey
String
leapworkSchNames
String
leapworkSchIds
String
leapworkDelay
(optional)
String
leapworkDoneStatusAs
(optional)
String
leapworkReport
(optional)
String
leapworkScheduleVariables
(optional)
String
leapworkWritePassedFlowKeyFrames
(optional)
boolean
$class: 'LeiningenBuilder'
task
String
subdirPath
String
checkETLicense
Check ECU-TEST license.
Pipelines usage:checkETLicense(String toolName) : void
checkETLicense('ECU-TEST')
toolName
String
installation
(optional)
name
String
home
String
properties
? extends hudson.tools.ToolProperty<?>
timeout
(optional)
String
lighthouseReport
file
String
name
(optional)
String
dotnetListPackage
dotnet list package
command provides a convenient option to list all NuGet package references for a specific project or a solution. You first need to build the project in order to have the assets needed for this command to process.
config
(optional)
String
deprecated
(optional)
boolean
framework
(optional)
String
frameworks
(optional)
String
frameworksString
(optional)
String
highestMinor
(optional)
boolean
highestPatch
(optional)
boolean
includePrerelease
(optional)
boolean
includeTransitive
(optional)
boolean
outdated
(optional)
boolean
project
(optional)
String
sdk
(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.
String
showSdkInfo
(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.
boolean
source
(optional)
String
sources
(optional)
String
sourcesString
(optional)
String
specificSdkVersion
(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.
boolean
verbosity
(optional)
String
workDirectory
(optional)
String
$class: 'LoadImpactTestRunTask'
apiTokenId
String
loadTestId
int
criteriaDelayValue
int
criteriaDelayUnit
String
criteriaDelayQueueSize
int
abortAtFailure
boolean
thresholds
metric
String
operator
String
value
int
result
String
pollInterval
int
logHttp
boolean
logJson
boolean
$class: 'LoadNinjaBuilder'
apiKey
String
scenarioId
String
oeb
errorPassCriteria
String
odb
durationPassCriteria
String
$class: 'LoadPluginBuilder'
url
String
username
String
password
String
file
String
greet
testId
String
credentialsId
String
$class: 'LoadtestBuilder'
loadtestBuilderModel
environmentShortName
String
authToken
String
presetName
String
loadtestScenario
String
loadtestThresholdParameters
metricType
String
evaluationDirection
String
numericValue
double
dotnetNuGetLocals
dotnet nuget locals
command clears or lists local NuGet resources in the http-request cache, temporary cache, or machine-wide global packages folder.
cacheLocation
(optional)
all
: Indicates that the specified operation is applied to all cache types: http-request cache, global packages cache, and the temporary cache. global-packages
: Indicates that the specified operation is applied only to the global packages cache. The other cache locations aren't affected. http-cache
: Indicates that the specified operation is applied only to the http-request cache. The other cache locations aren't affected. temp
: Indicates that the specified operation is applied only to the temporary cache. The other cache locations aren't affected. String
forceEnglishOutput
(optional)
boolean
operation
(optional)
clear
: The contents of the cache directories are deleted recursively. The executing user/group must have permission to the files in the cache directories. If not, an error is displayed indicating the files/folders that weren't cleared. list
: Displays the path to the specified cache location.String
sdk
(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.
String
showSdkInfo
(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.
boolean
specificSdkVersion
(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.
boolean
workDirectory
(optional)
String
$class: 'LoginBuilder'
credentialsId
String
hubUrl
String
mabl
restApiKeyId
String
environmentId
String
applicationId
String
apiBaseUrl
(optional)
String
appBaseUrl
(optional)
String
continueOnMablError
(optional)
boolean
continueOnPlanFailure
(optional)
boolean
disableSslVerification
(optional)
boolean
labels
(optional)
String
mablBranch
(optional)
String
$class: 'MailCommandBuilder'
POP3 mail server address | Set POP3 mail server's hostname or ip address. |
POP3 mail server port | Set POP3 mail server's port. Default value is 110. |
POP3 User Name | Set POP3 mail server's user account. |
POP3 Password | Set POP3 mail server's password. |
address
String
port
String
username
String
password
String
$class: 'MakeAppTouchTestable'
url
String
cloudTestServerID
String
inputType
String
projectFile
String
target
String
launchURL
String
backupModifiedFiles
boolean
additionalOptions
String
javaOptions
String
$class: 'ManageInstance'
cloud
String
workspace
String
operations
? extends com.elasticbox.jenkins.builders.Operation
$class: 'MatlabBuilder'
matlabRoot
(optional)
Note: If the job runs on a remote agent, you must specify the full path to MATLAB root folder on the remote agent.
String
testRunTypeList
(optional)
$class: 'RunTestsAutomaticallyOption'
taCoberturaChkBx
(optional)
boolean
taJunitChkBx
(optional)
boolean
taModelCoverageChkBx
(optional)
boolean
taPDFReportChkBx
(optional)
boolean
taSTMResultsChkBx
(optional)
boolean
tatapChkBx
(optional)
boolean
$class: 'RunTestsWithCustomCommandOption'
customMatlabCommand
(optional)
String
maven
targets
String
name
String
pom
String
properties
# comment name1=value1 name2=value2These are passed to Maven like
"-Dname1=value1 -Dname2=value2"
String
jvmOptions
String
usePrivateRepository
boolean
settings
settings.xml
file contains elements used to define values which configure Maven execution in various ways, like the pom.xml
, but should not be bundled to any specific project, or distributed to an audience. These include values such as the local repository location, alternate remote repository servers, and authentication information.
settings.xml
file per default may live:
$M2_HOME/conf/settings.xml
${user.home}/.m2/settings.xml
see also: settings.xml
reference
standard
$HOME/.m2/settings.xml
) as set on build node.
filePath
settings.xml
file. Such a file is checked out from SCM as part of the job or a well known location.
path
String
$class: 'MvnSettingsProvider'
settingsConfigId
String
globalSettings
standard
$HOME/.m2/settings.xml
) as set on build node.
$class: 'FilePathGlobalSettingsProvider'
settings.xml
file from job workspace. Such a file is checked out from SCM as part of the job or a well known location.
path
String
$class: 'MvnGlobalSettingsProvider'
settingsConfigId
String
injectBuildVariables
MY_VAR=${MY_VAR}
).
boolean
$class: 'Maven3Builder'
mavenName
String
rootPom
String
goals
String
mavenOpts
String
useWrapper
boolean
$class: 'MavenDeploymentDownloader'
projectName
String
filePattern
.*
)
String
permaLink
String
targetDir
String
stripVersion
boolean
stripVersionPattern
String
failIfNoArtifact
boolean
cleanTargetDir
boolean
$class: 'MavenSealightsBuildStep'
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
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) |
String
includeResources
boolean
buildStepMode
$class: 'DisableSealightsView'
targets
String
$class: 'InvokeMavenCommandView'
targets
String
$class: 'OffView'
$class: 'PrepareSealightsView'
additionalMavenArguments
String
name
String
pom
String
properties
# comment name1=value1 name2=value2These are passed to Maven like "-Dname1=value1 -Dname2=value2"
String
jvmOptions
String
usePrivateRepository
boolean
settings
settings.xml
file contains elements used to define values which configure Maven execution in various ways, like the pom.xml
, but should not be bundled to any specific project, or distributed to an audience. These include values such as the local repository location, alternate remote repository servers, and authentication information.
settings.xml
file per default may live:
$M2_HOME/conf/settings.xml
${user.home}/.m2/settings.xml
see also: settings.xml
reference
standard
$HOME/.m2/settings.xml
) as set on build node.
filePath
settings.xml
file. Such a file is checked out from SCM as part of the job or a well known location.
path
String
$class: 'MvnSettingsProvider'
settingsConfigId
String
globalSettings
standard
$HOME/.m2/settings.xml
) as set on build node.
$class: 'FilePathGlobalSettingsProvider'
settings.xml
file from job workspace. Such a file is checked out from SCM as part of the job or a well known location.
path
String
$class: 'MvnGlobalSettingsProvider'
settingsConfigId
String
mavenSnapshotCheck
check
(optional)
boolean
$class: 'MdtoolSolutionBuilder'
installationName
String
solutionPath
String
target
value
String
configuration
value
String
project
value
String
runtime
value
String
measure
VMs
(optional)
int
clazzFolders
(optional)
String
createDefaultConstructor
(optional)
boolean
displayLogs
(optional)
boolean
displayRCALogs
(optional)
boolean
displayRTSLogs
(optional)
boolean
excludeLog4j
(optional)
boolean
excludes
(optional)
String
executeBeforeClassInMeasurement
(optional)
boolean
executeParallel
(optional)
boolean
executeRCA
(optional)
boolean
generateCoverageSelection
(optional)
boolean
includes
(optional)
String
iterations
(optional)
int
kiekerWaitTime
(optional)
int
measureJMH
(optional)
boolean
measurementMode
(optional)
LEVELWISE
, COMPLETE
, UNTIL_STRUCTURE_CHANGE
, UNTIL_SOURCE_CHANGE
nightlyBuild
(optional)
boolean
onlyMeasureWorkload
(optional)
boolean
pl
(optional)
String
properties
(optional)
String
redirectSubprocessOutputToFile
(optional)
boolean
redirectToNull
(optional)
boolean
removeSnapshots
(optional)
boolean
repetitions
(optional)
int
showStart
(optional)
boolean
significanceLevel
(optional)
double
testClazzFolders
(optional)
String
testExecutor
(optional)
String
testGoal
(optional)
String
testTransformer
(optional)
String
timeout
(optional)
int
updateSnapshotDependencies
(optional)
boolean
useAggregation
(optional)
boolean
useAlternativeBuildfile
(optional)
boolean
useGC
(optional)
boolean
useSourceInstrumentation
(optional)
boolean
versionDiff
(optional)
int
warmup
(optional)
int
redmineMetricsReport
settings
(optional)
url
String
apiKey
Specify Redmine API Key which can be found in Redmine's [My Account] -> API access key
If can't find "API access key", Redmine admin needs to enable a setting. "Administration > Settings > Authentication > Enable REST web service".
String
projectName
Specify Redmine Project's Identifier which you want to generate report for, use Identifier not Name in the Redmine project setting page.
String
customQueryId
int
sprintSize
Specify the time span(day). e.g.: if you want to generate report on a weekly basis you should specify 7.
int
$class: 'MicroDocsChecker'
microDocsReportFile
String
microDocsProjectName
String
microDocsGroupName
String
microDocsEnvironments
String
microDocsSourceFolder
String
microDocsFailBuild
boolean
microDocsPublish
boolean
microDocsNotifyPullRequest
boolean
minio
bucket
String
includes
String
credentialsId
(optional)
String
excludes
(optional)
String
host
(optional)
String
targetFolder
(optional)
String
minioDelete
bucket
String
files
String
credentialsId
(optional)
String
failOnNonExisting
(optional)
boolean
host
(optional)
String
minioDownload
bucket
String
file
String
credentialsId
(optional)
String
excludes
(optional)
String
failOnNonExisting
(optional)
boolean
host
(optional)
String
targetFolder
(optional)
String
$class: 'MobileStudioTestBuilder'
mobileStudioRunnerPath
String
testPath
String
msgServer
(optional)
String
deviceId
(optional)
String
projectRoot
(optional)
String
testAsUnit
(optional)
boolean
$class: 'MockLoadBuilder'
mock-artifact-*.txt
. There will be a JUnit test report with the file name mock-junit.xml
. Approximately 5% of the time, the build will "fail" its tests and thus no artifacts will be generated.
averageDuration
long
$class: 'ModelBuilder'
pushGuardSettings
minBufferSize
String
hubUrls
String
$class: 'MonitorRemoteJobBuilder'
hostName
String
jobName
String
timeBefore
String
userName
String
password
String
useSSL
boolean
$class: 'MonkeyBuilder'
filename
String
packageId
String
eventCount
int
throttleMs
int
seed
String
categories
String
extraParameters
String
moveComponents
nexusInstanceId
String
destination
String
search
(optional)
java.util.Map<java.lang.String, java.lang.String>
tagName
(optional)
String
msbuild
msBuildName
String
msBuildFile
Give the .proj or .sln file from the module root (SCM root directory or workspace directory) that MSBuild will use to build.
You can use build variables through the syntax ${var}.
String
cmdLineArgs
This is a whitespace separated-list of command-line arguments you can specify. These can be the same as if you were to run MSBuild from the command line.
String
buildVariablesAsProperties
If set to true, Jenkins build variables will be passed to MSBuild as /p:name=value pairs.
Beware : Sensitive build variables such as passwords will not be added.
boolean
continueOnBuildFailure
If set to true, Job will continue despite MSBuild build failure.
boolean
unstableIfWarnings
If set to true and warnings on compilation, the build will be unstable.
boolean
doNotUseChcpCommand
boolean
$class: 'MsBuildSQRunnerBegin'
additionalArguments
(optional)
String
msBuildScannerInstallationName
(optional)
String
projectKey
(optional)
String
projectName
(optional)
String
projectVersion
(optional)
String
sonarInstallationName
(optional)
String
$class: 'MsBuildSQRunnerEnd'
$class: 'MsTestBuilder'
msTestName
String
testFiles
Specify the path to your MSTest compiled assemblies.
You can specify multiple test assemblies by separating them with new-line.
You can use either relative path to the workspace or full path. Spaces in the path are allowed.
You can use Ant-style filters. i.e - foo/*, foo/**/bar.dll, foo/*.dll
Command Line Argument: /testcontainer
String
categories
Optional field, if you do not enter all test will run. If entered specify the test categories to run. You can use logical operators like:
Cateogry Filter | Result |
Priority1 | Any test with category Priority1 |
Priority1&SpeedTest | Test that have both Priority1 and SpeedTest categories |
Priority1|SpeedTest | Tests that have either Priority1 or SpeedTest categories |
Priority1&!SpeedTest | Test that have Priority1 category and also do not have SpeedTest category. |
Command Line Argument: /category
String
resultFile
Specify name of the result file to create. The result file will be delete before each run and will be created relative to the workspace directory.
Command Line Argument: /resultsfile
String
cmdLineArgs
String
continueOnFail
Specify if the build should fail if a test fail (unchecked) or continue even if a test failed (checked).
boolean
$class: 'MultiJobBuilder'
phaseName
String
phaseJobs
jobName
String
jobAlias
String
jobProperties
String
currParams
boolean
configs
$class: 'BooleanParameters'
configs
name
String
value
boolean
$class: 'CurrentBuildParameters'
$class: 'FileBuildParameters'
propertiesFile
String
encoding
String
failTriggerOnMissing
boolean
useMatrixChild
boolean
combinationFilter
String
onlyExactRuns
boolean
textParamValueOnNewLine
boolean
$class: 'GeneratorCurrentParameters'
$class: 'GitRevisionBuildParameters'
combineQueuedCommits
boolean
$class: 'MatrixSubsetBuildParameters'
filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggered job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String
$class: 'NodeLabelBuildParameter'
name
String
nodeLabel
String
$class: 'NodeParameters'
$class: 'PredefinedBuildParameters'
properties
String
textParamValueOnNewLine
boolean
$class: 'PredefinedGeneratorParameters'
properties
String
$class: 'SubversionRevisionBuildParameters'
includeUpstreamParameters
boolean
killPhaseOnJobResultCondition
FAILURE
, NEVER
, UNSTABLE
disableJob
boolean
enableRetryStrategy
boolean
parsingRulesPath
String
maxRetries
int
enableCondition
boolean
abortAllJob
boolean
condition
String
buildOnlyIfSCMChanges
boolean
applyConditionOnlyIfNoSCMChanges
boolean
aggregatedTestResults
boolean
continuationCondition
ALWAYS
, SUCCESSFUL
, COMPLETED
, UNSTABLE
, FAILURE
executionType
PARALLEL
, SEQUENTIALLY
quietPeriodGroovy
String
mavenForesight
projectId
String
credentialId
String
thundraAgentVersion
(optional)
String
$class: 'MystBuilder'
mystAction
String
config
String
mystWorkspace
String
properties
String
mystInstallationName
String
NCScanBuilder
ncScanType
String
ncWebsiteId
String
ncProfileId
String
ncDoNotFail
(optional)
boolean
credentialsId
(optional)
String
ncApiToken
(optional)
Object
ncConfirmed
(optional)
boolean
ncIgnoreFalsePositive
(optional)
boolean
ncIgnoreRiskAccepted
(optional)
boolean
ncServerURL
(optional)
String
ncSeverity
(optional)
String
ncStopScan
(optional)
boolean
$class: 'NISConnection'
viewUrl
String
address
String
port
int
prozent
int
npm
command
String
workspaceSubdirectory
(optional)
String
apiKey
validateDnsUrlConnection
boolean
apiUrl
(optional)
String
group
(optional)
String
binaryName
(optional)
String
description
(optional)
String
waitForResults
(optional)
boolean
waitMinutes
(optional)
int
breakBuildOnScore
(optional)
boolean
scoreThreshold
(optional)
int
apiKey
(optional)
String
useBuildEndpoint
(optional)
boolean
artifactsDir
(optional)
String
debug
(optional)
boolean
password
(optional)
String
proxyEnabled
(optional)
boolean
showStatusMessages
(optional)
boolean
stopTestsForStatusMessage
(optional)
String
username
(optional)
String
validateDnsUrlConnectionEnabled
(optional)
boolean
$class: 'NSiqBuilder'
srcDir
String
fileFilter
String
$class: 'NantBuilder'
nantBuildFile
String
nantName
String
targets
String
properties
String
$class: 'NeoBuildAction'
executable
/opt/NeoLoad 6.5/bin/NeoLoadCmd
, C:\Program Files\NeoLoad 6.5\bin\NeoLoadCmd.exe
or /Applications/NeoLoad 6.5/bin/NeoLoadCmd
.
String
projectType
String
reportType
String
localProjectFile
/home/ajohnson/neoload_projects/JenkinsExample/JenkinsExample.nlp
, C:\neoload_projects\JenkinsExample\JenkinsExample.nlp
or /Users/ajohnson/neoload_projects/JenkinsExample/JenkinsExample.nlp
or C:\neoload_projects\JenkinsExample\JenkinsExample.yaml
.
String
sharedProjectName
MyProjectName
.
String
scenarioName
String
htmlReport
${WORKSPACE}/neoload-report/report.html
.
String
xmlReport
${WORKSPACE}/neoload-report/report.xml
.
String
pdfReport
${WORKSPACE}/neoload-report/report.pdf
.
String
junitReport
${WORKSPACE}/neoload-report/junit-sla-results.xml
.
String
scanAllBuilds
boolean
displayTheGUI
boolean
testResultName
$Date{hh:mm - dd MMM yyyy}
is replaced by the current date by NeoLoad and the value ${BUILD_NUMBER}
is replaced by the current build number by Jenkins.
$Date{hh:mm - dd MMM yyyy} (build $${BUILD_NUMBER})
.
String
testDescription
String
licenseType
String
licenseVUCount
String
licenseVUSAPCount
String
licenseDuration
String
customCommandLineOptions
String
publishTestResults
boolean
sharedProjectServer
uniqueID
String
url
String
loginUser
String
loginPassword
class hudson.util.Secret
label
String
licenseServer
uniqueID
String
url
String
loginUser
String
loginPassword
class hudson.util.Secret
label
String
collabPath
String
licenseID
String
showTrendAverageResponse
boolean
showTrendErrorRate
boolean
graphOptionsInfo
name
String
curve
path
String
statistic
String
maxTrends
int
$class: 'NerrvanaPlugin'
settingsXmlString
String
loglevel
String
$class: 'NetStormBuilder'
URLConnectionString
String
username
String
password
String
project
String
subProject
String
scenario
String
testMode
String
baselineType
String
pollInterval
String
protocol
String
repoIp
String
repoPort
String
repoPath
String
repoUsername
String
repoPassword
String
profile
String
script
String
page
String
advanceSett
String
urlHeader
String
hiddenBox
String
gitPull
String
generateReport
boolean
doNotWaitForTestCompletion
boolean
totalusers
String
rampUpSec
String
rampupmin
String
rampuphour
String
duration
String
serverhost
String
sla
String
testName
String
scriptPath
String
rampupDuration
String
emailid
String
emailidCC
String
emailidBcc
String
testsuite
String
dataDir
String
checkRuleFileUpload
String
neuvector
repository
String
registrySelection
String
nameOfVulnerabilityToExemptFour
(optional)
String
nameOfVulnerabilityToExemptOne
(optional)
String
nameOfVulnerabilityToExemptThree
(optional)
String
nameOfVulnerabilityToExemptTwo
(optional)
String
nameOfVulnerabilityToFailFour
(optional)
String
nameOfVulnerabilityToFailOne
(optional)
String
nameOfVulnerabilityToFailThree
(optional)
String
nameOfVulnerabilityToFailTwo
(optional)
String
numberOfHighSeverityToFail
(optional)
String
numberOfMediumSeverityToFail
(optional)
String
scanLayers
(optional)
boolean
standaloneScanner
(optional)
boolean
tag
(optional)
String
$class: 'NexusArtifactUploader'
nexusVersion
String
protocol
String
nexusUrl
String
groupId
String
version
String
repository
String
credentialsId
String
artifacts
artifactId
String
type
String
classifier
String
file
String
$class: 'NexusPublisherBuildStep'
nexusInstanceId
String
nexusRepositoryId
String
packages
$class: 'MavenPackage'
mavenCoordinate
groupId
String
artifactId
String
version
String
packaging
String
mavenAssetList
filePath
String
classifier
String
extension
String
tagName
(optional)
String
nirmata
builder
Delete App in Environment
Deletes the specified application from the specified environment.
Deploy App in Environment
Deploys the specified application from catalog to specified application.
Update App in Catalog
Updates the specified application in specified catalog.
Update App in Environment
Updates the specified application in specified environment.
deleteAppInEnvironment
endpoint
String
apikey
String
environment
String
application
String
timeout
int
deployAppInEnvironment
endpoint
String
apikey
String
environment
String
application
String
timeout
int
catalog
String
directories
String
includescheck
boolean
includes
String
excludescheck
boolean
excludes
String
deployType
String
updateAppInCatalog
endpoint
String
apikey
String
catalog
String
timeout
int
directories
String
includescheck
boolean
includes
String
excludescheck
boolean
excludes
String
updateAppInEnvironment
endpoint
String
apikey
String
environment
String
application
String
timeout
int
directories
String
includescheck
boolean
includes
String
excludescheck
boolean
excludes
String
nodejsci
command
String
nodeJSInstallationName
String
cacheLocationStrategy
(optional)
default
executor
workspace
configId
(optional)
String
$class: 'NopmdCheckPublisher'
filesetList
pattern
String
excludePattern
String
$class: 'NotifyEventsBuilder'
token
String
title
String
message
String
priority
String
level
String
attachBuildLog
boolean
attachment
String
$class: 'NouvolaBuilder'
planID
String
apiKey
String
credsPass
String
waitTime
String
returnURL
String
listenTimeOut
String
$class: 'NucleiBuilder'
targetUrl
String
additionalFlags
(optional)
nuclei --help
or visit:String
nucleiVersion
(optional)
String
reportingConfiguration
(optional)
String
$class: 'NvEmulationBuilder'
serverName
String
includeClientIPs
String
excludeServerIPs
String
reportFiles
String
thresholdsFile
String
useProxyCheckbox
envVariable
String
steps
hudson.tasks.BuildStep
)profileNames
(optional)
profileName
String
$class: 'OOBuildStep'
ooServer
String
basepath
Default path: /Library
E.g.: Library/Tutorials/subflows/ Library/Templates
String
selectedFlow
String
args
name
String
value
String
retVariableToCheck
String
comparisonOrdinal
int
valueToCompareWith
String
desiredResultType
String
stepExecutionTimeout
xxx ms
. The plugin will wait for this amount of time, then it will finish the Jenkins job and it will automatically put the build in the fail/unstable state.
String
runName
String
ostorlabScan
waitForResults
boolean
riskThreshold
HIGH
, MEDIUM
, LOW
, POTENTIALLY
, HARDENING
filePath
(optional)
String
title
(optional)
String
plan
(optional)
String
platform
(optional)
String
waitMinutes
(optional)
int
breakBuildOnScore
(optional)
boolean
scoreThreshold
(optional)
HIGH
, MEDIUM
, LOW
, POTENTIALLY
, HARDENING
waitingForResults
(optional)
boolean
$class: 'Oak9Builder'
orgId
(optional)
String
projectId
(optional)
String
credentialsId
(optional)
String
maxSeverity
(optional)
int
baseUrl
(optional)
String
$class: 'OctoperfBuilder'
credentialsId
(optional)
String
workspaceId
(optional)
String
projectId
(optional)
String
scenarioId
(optional)
String
stopConditions
(optional)
? extends org.jenkinsci.plugins.octoperf.conditions.TestStopCondition
octopusPack
toolId
String
packageId
String
packageFormat
String
sourcePath
String
additionalArgs
(optional)
String
includePaths
(optional)
String
outputPath
(optional)
String
overwriteExisting
(optional)
boolean
packageVersion
(optional)
String
verboseLogging
(optional)
boolean
octopusPushBuildInformation
serverId
String
spaceId
String
toolId
String
packageId
String
packageVersion
String
commentParser
String
overwriteMode
FailIfExists
, OverwriteExisting
, IgnoreIfExists
additionalArgs
(optional)
String
gitBranch
(optional)
String
gitCommit
(optional)
String
gitUrl
(optional)
String
verboseLogging
(optional)
boolean
octopusPushPackage
serverId
String
toolId
String
packagePaths
String
overwriteMode
FailIfExists
, OverwriteExisting
, IgnoreIfExists
additionalArgs
(optional)
String
spaceId
(optional)
String
verboseLogging
(optional)
boolean
OneSky
projectId
(optional)
String
resourcesPath
(optional)
String
$class: 'OntrackDSLStep'
ontrackScriptLocation
value
String
scriptPath
String
scriptText
String
sandbox
boolean
injectEnvironment
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
ignoreFailure
boolean
$class: 'OpenShiftBuildVerifier'
apiURL
String
bldCfg
String
namespace
String
authToken
String
verbose
String
checkForTriggeredDeployments
String
waitTime
String
waitUnit
String
$class: 'OpenShiftBuilder'
apiURL
String
bldCfg
String
namespace
String
env
name
String
value
String
authToken
String
verbose
String
commitID
String
buildName
String
showBuildLogs
String
checkForTriggeredDeployments
String
waitTime
String
waitUnit
String
$class: 'OpenShiftCreator'
apiURL
String
namespace
String
authToken
String
verbose
String
jsonyaml
String
$class: 'OpenShiftDeleterJsonYaml'
apiURL
String
namespace
String
authToken
String
verbose
String
jsonyaml
String
$class: 'OpenShiftDeleterLabels'
apiURL
String
namespace
String
authToken
String
verbose
String
types
String
keys
String
values
String
$class: 'OpenShiftDeleterList'
apiURL
String
namespace
String
authToken
String
verbose
String
types
String
keys
String
$class: 'OpenShiftDeployer'
apiURL
String
depCfg
String
namespace
String
authToken
String
verbose
String
waitTime
String
waitUnit
String
$class: 'OpenShiftDeploymentVerifier'
apiURL
String
depCfg
String
namespace
String
replicaCount
String
authToken
String
verbose
String
verifyReplicaCount
String
waitTime
String
waitUnit
String
$class: 'OpenShiftExec'
apiURL
String
namespace
String
authToken
String
verbose
String
pod
String
container
String
command
String
arguments
value
String
waitTime
String
waitUnit
String
$class: 'OpenShiftImageTagger'
apiURL
String
testTag
String
prodTag
String
namespace
String
authToken
String
verbose
String
testStream
String
prodStream
String
destinationNamespace
String
destinationAuthToken
String
alias
String
$class: 'OpenShiftScaler'
apiURL
String
depCfg
String
namespace
String
replicaCount
String
authToken
String
verbose
String
verifyReplicaCount
String
waitTime
String
waitUnit
String
$class: 'OpenShiftServiceVerifier'
apiURL
String
svcName
String
namespace
String
authToken
String
verbose
String
$class: 'OrchestratorBuilder'
serverUrl
String
userName
String
password
String
tenant
String
workflowName
String
waitExec
boolean
inputParams
name
String
type
String
value
String
cfyOutputsToInputs
This step maps outputs and capabilities, of an environment created by Cloudify, into inputs of another deployment.
This step takes two inputs:
The format of the mapping JSON is as follows:
{ "outputs": { "<output_name>": "<input_name>", "<output_name>": "<input_name>", ... }, "capabilities": { "<capability_name>": "<input_name>", "<capability_name>": "<input_name>", ... } }
At the end, a file will be generated, containing a JSON compatible with Cloudify's standard "Deployment Inputs" structure, namely:
{ "<input_name>": "<intput_value>", "<input_name>": "<intput_value>", ...
For example, if the "outputs file" is as follows:
{ "outputs": { "endpoint": "10.0.0.130", "username": "centos" }, "capabilities": { "public_key": "/tmp/public_key" } }
And the mapping is as follows:
{ "outputs": { "username": "app_username" }, "capabilities": { "public_key": "app_data" } }
Then the resultant inputs file will be as follows:
{ "app_username": "centos", "app_data": "/tmp/public_key" }
credentialsId
(optional)
String
inputsLocation
(optional)
Path to the inputs file to be created.
String
mapping
(optional)
A JSON containing mapping between outputs/capabilities and inputs. For information about the structure, refer to the tooltip of this build step.
String
mappingLocation
(optional)
A JSON containing mapping between outputs/capabilities and inputs. For information about the structure, refer to the tooltip of this build step.
String
outputsLocation
(optional)
Location of the outputs JSON file, containing outputs and capabilities of another deployment. The file must be in the following format:
{ "outputs": { "<output_name>": "<output_value>", "<output_name>": "<output_value>", ... }, "capabilities": { "<capability_name>": "<capability_value>", "<capability_name>": "<capability_value>", ... } }
String
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
oversecuredUpload
apkPath
String
integrationId
String
dotnetPack
dotnet pack
command builds the project and creates NuGet packages. The result of this command is a NuGet package (that is, a .nupkg file).
configuration
(optional)
Debug
, but you can override the build configuration settings in your project.
String
force
(optional)
boolean
includeSource
(optional)
src
folder within the symbols package.
boolean
includeSymbols
(optional)
boolean
noBuild
(optional)
boolean
noDependencies
(optional)
boolean
noRestore
(optional)
boolean
nologo
(optional)
boolean
option
(optional)
String
options
(optional)
String
optionsString
(optional)
String
outputDirectory
(optional)
String
project
(optional)
String
properties
(optional)
java.util.Map<java.lang.String, java.lang.String>
propertiesString
(optional)
String
runtime
(optional)
String
sdk
(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.
String
showSdkInfo
(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.
boolean
shutDownBuildServers
(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).
boolean
specificSdkVersion
(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.
boolean
unstableIfWarnings
(optional)
boolean
verbosity
(optional)
String
versionSuffix
(optional)
$(VersionSuffix)
MSBuild property in the project.
String
workDirectory
(optional)
String
uTesterPageCountTask
initialUrl
String
urlsWhiteList
String
pageCount
int
rulesList
rule
String
complianceMinimum
float
allowSimultaneousLogins
boolean
loginFlowJson
String
useRunner
boolean
fetchResponseTimeout
int
$class: 'ParallelTestExecutor'
This builder can be used with any test job that (1) produce JUnit-compatible XML files, and (2) accept a test-exclusion list in a file. This builder looks at the test execution time from the last time, and divide tests into multiple units of roughly equal size. Each unit is then converted into the exclusion list (by excluding all but the tests that assigned to that unit), and the test job is triggered for each unit, with the exclusion file placed inside the workspace at your specified location.
Optionally, if your test job supports it, you may provide a test-inclusion file name. If defined, the plugin will generate inclusion lists for all parallel units but one which will still use exclusion list. This avoids new test cases from being included in all units on their first run. If you don't use an inclusion file, when a new test is added, the first build afterward will be executed in all the sub-builds, because it's not in the exclusion list on any of the units.
You are responsible for configuring the build script in the test job to honor the exclusion and inclusion file. A standard technique is to write the build script to always refer to a fixed exclusion list file, and check in an empty file by that name to your SCM. You can then specify that file as the "exclusion file name" in the configuration of this builder, and the builder will overwrite the empty file from SCM by the generated one.
Similarly, you are responsible for checking "Execute concurrent builds if necessary" on the test job to allow the concurrent execution.
At the end of the executions of the test job, the specified report directories are brought back into this job's workspace, then the standard JUnit test report collector will tally them.
parallelism
count
size
int
time
This value counts just the time spent on executing tests, and not including other time such as checking out the code, building the test, etc. For example, if your test job spends 50 minutes in tests and 60 minutes total from start to finish, then you have 10 minutes "fixed" overhead regardless of the number of tests it executes. If you use this mode and set the value to "10 minutes", then you'll have 5 parallel sub-tasks that all ends in roughly 20 minutes (20 mins = 10 mins tests time + 10 mins overhead.)
"N minutes per a sub-task" is a goal, not a hard constraint. So a sub-task can take longer (for example if you have a single test that takes more than N minutes.)
mins
int
testJob
String
patternFile
String
testReportFiles
The path is relative to the workspace of the test job. For Maven builds, this value is normally "**/target/surefire-reports/".
String
archiveTestResults
boolean
parameters
$class: 'BooleanParameters'
configs
name
String
value
boolean
$class: 'CurrentBuildParameters'
$class: 'FileBuildParameters'
propertiesFile
String
encoding
String
failTriggerOnMissing
boolean
useMatrixChild
boolean
combinationFilter
String
onlyExactRuns
boolean
textParamValueOnNewLine
boolean
$class: 'GeneratorCurrentParameters'
$class: 'GitRevisionBuildParameters'
combineQueuedCommits
boolean
$class: 'MatrixSubsetBuildParameters'
filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggered job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String
$class: 'NodeLabelBuildParameter'
name
String
nodeLabel
String
$class: 'NodeParameters'
$class: 'PredefinedBuildParameters'
properties
String
textParamValueOnNewLine
boolean
$class: 'PredefinedGeneratorParameters'
properties
String
$class: 'SubversionRevisionBuildParameters'
includeUpstreamParameters
boolean
estimateTestsFromFiles
boolean
includesPatternFile
(optional)
String
$class: 'ParameterPoolBuilder'
projects
String
name
String
values
String
preferError
boolean
$class: 'PartialReleaseMgrSuccessfulBuilder'
pcBuild
serverAndPort
String
pcServerName
String
credentialsId
String
almDomain
String
almProject
String
testId
String
testInstanceId
String
autoTestInstanceID
String
timeslotDurationHours
String
timeslotDurationMinutes
String
postRunAction
COLLATE
, COLLATE_AND_ANALYZE
, DO_NOTHING
vudsMode
boolean
statusBySLA
boolean
description
String
addRunToTrendReport
String
trendReportId
String
HTTPSProtocol
boolean
proxyOutURL
String
credentialsProxyId
String
retry
String
retryDelay
String
retryOccurrences
String
authenticateWithToken
boolean
pcGitBuild
description
String
pcServerName
String
httpsProtocol
boolean
credentialsId
String
almDomain
String
almProject
String
serverAndPort
String
proxyOutURL
String
credentialsProxyId
String
subjectTestPlan
String
uploadScriptMode
RUNTIME_FILES
, ALL_FILES
removeScriptFromPC
YES
, NO
importTests
Note:
Parameter | Description | Required |
---|---|---|
controller |
Defines the Controller to be used during the test run (it must be an available host in the LoadRunner Enterprise project). If not specified, a Controller will be chosen from the different controllers available in the LoadRunner Enterprise project.
From Performance Center 12.62 and plugin version 1.1.1, the option to provision a Controller as a Docker image is available by specifying the value "Elastic" and providing a value for the 'controller_elastic_configuration' parameter (see 'controller_elastic_configuration' table below).
|
No |
lg_amount | Number of load generators to allocate to the test (every group in the test will be run by the same load generators). | Not required if each group defined in the 'group' parameter defines the load generators it will be using via the 'lg_name' parameter (see 'group' table below). |
group | Lists all groups or scripts defined in the test. The parameter to be used in each group are specified in the 'group' table below. | Yes |
scheduler | Defines the duration of a test, and determines whether virtual users are started simultaneously or gradually. See the 'scheduler' table below. | No |
lg_elastic_configuration | Defines the image to be used in order to provision load generators. See the 'lg_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if a load generator is defined to be provisioned from a Docker image. |
controller_elastic_configuration | Defines the image to be used in order to provision the Controller. See the 'controller_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if the Controller is defined to be provisioned from a Docker image. |
Parameter | Description | Required |
---|---|---|
group_name | Name of the group (it must be a unique name if several groups are defined). | Yes |
vusers | Number of virtual users to allocate to the group for running the script. | Yes |
script_id | ID of the script in the LoadRunner Enterprise project. | Not required if the 'script_path' parameter is specified. |
script_path | Path and name of the script to be added to the group, separated by double backslashes (\\). For example "MyMainFolder\\MySubFolder\\MyScriptName'. Do not include the LoadRunner Enterprise root folder (named "Subject"). | Not required if 'script_id' parameter is specified |
lg_name | List of load generators to allocate to the group for running the script. The supported values are:
|
No |
command_line | The command line applied to the group. | No |
rts | Object defining the runtime settings of the script. See the 'rts' table below. | No |
Parameter | Description | Required |
---|---|---|
pacing | Can be used to define the number of iterations the script will run and the required delay between iterations (see the 'pacing' table below). | No |
thinktime | Can be used to define think time (see the 'thinktime' table below). | No |
java_vm | Can be used when defining Java environment runtime settings (see the 'java_vm' table below). | No |
jmeter | Can be used to define JMeter environment runtime settings (see the 'jmeter' table below). | No |
Parameter | Description | Required |
---|---|---|
number_of_iterations | Specifies the number of iterations to run; this must be a positive number. | Yes |
type | Possible values for type attribute are:
|
No |
delay | Non-negative number (less than 'delay_at_range_to_seconds' when specified). | Depends on the value provided for the 'type' parameter. |
delay_random_range | Non-negative number. It will be added to the value given to the 'delay' parameter (the value will be randomly chosen between the value given to 'delay' parameter and the same value to which is added the value of this parameter). | Depends on the value provided for the 'type' parameter. |
Parameter | Description | Required |
---|---|---|
type | The ThinkTime Type attribute is one of:
|
No |
min_percentage | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
max_percentage | This must be a positive number (it must be larger than the value provided for the 'min_percentage' parameter). | Depends on the value provided for the 'type' parameter. |
limit_seconds | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
multiply_factor | The recorded think time is multiplied by this factor at runtime. | Depends on the value provided for the 'type' parameter. |
Parameter | Description | Required |
---|---|---|
jdk_home | The JDK installation path. | No |
java_vm_parameters | List the Java command line parameters. These parameters can be any JVM argument. The common arguments are the debug flag (-verbose) or memory settings (-ms, -mx). In additional, you can also pass properties to Java applications in the form of a -D flag. | No |
use_xboot | Boolean: Instructs VuGen to add the Classpath before the Xbootclasspath (prepend the string). | No |
enable_classloader_per_vuser | Boolean: Loads each Virtual User using a dedicated class loader (runs Vusers as threads). | No |
java_env_class_paths | A list of classpath entries. Use a double backslash (\\) for folder separators. | No |
Parameter | Description | Required |
---|---|---|
start_measurements | Boolean value to enable JMX measurements during performance test execution. | No |
jmeter_home_path | Path to JMeter home. If not defined, the path from the %JMETER_HOME% environment variable is used. | No |
jmeter_min_port | This number must be lower than the value provided in the 'jmeter_max_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
jmeter_max_port | This number must be higher than the value provided in the 'jmeter_min_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
jmeter_additional_properties | JMeter additional properties file. Use double slash (\\) for folder separator. | No |
Parameter | Description | Required |
---|---|---|
rampup | Time, in seconds, to gradually start all virtual users. Additional virtual users are added every 15 seconds until the time specified in the parameter ends. If no value is specified, all virtual users are started simultaneously at the beginning of the test. | No |
duration | Time, in seconds, that it will take to run the test after all virtual users are started. After this time, the test run ends. If not specified, the test will run until completion. | No |
Parameter | Description | Required |
---|---|---|
image_id | This number can be retrieved from:
|
Yes if one of the load generator is defined to be provisioned from Docker image. |
memory_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
cpu_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
Parameter | Description | Required |
---|---|---|
image_id | This number can be retrieved from:
|
Yes if the Controller is defined to be provisioned from Docker image. |
memory_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
cpu_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
##################################################
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
Duration: '300'
##################################################
##################################################
controller: "mycontroller"
lg_amount: 3
group:
- group_name: "JavaVuser_LR_Information_pacing_immediately_thinktime_ignore"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "immediately"
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
use_xboot: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "ignore"
- group_name: "JavaHTTP_BigXML_pacing_fixed_delay_thinktime_replay"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed delay"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
thinktime:
type: "replay"
limit_seconds: 30
- group_name: "JavaVuser_LR_Information_immediately_pacing_random_delay_thinktime_modify"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "random delay"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "modify"
limit_seconds: 30
multiply_factor: 2
- group_name: "JavaHTTP_BigXML_pacing_fixed_interval_thinktime_random"
vusers: 50
#script_id: 392
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed interval"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "random"
limit_seconds: 30
min_percentage: 2
max_percentage: 3
- group_name: "JavaHTTP_BigXML_pacing_random_interval"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
- group_name: "Mtours_pacing_random_interval"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
jmeter_home_path: "c:\\jmeter"
jmeter_min_port: 2001
jmeter_max_port: 3001
jmeter_additional_properties: "jmeter_additional_properties"
- group_name: "Mtours_pacing_random_interval_Jmeter_default_port"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
scheduler:
rampup: 120
duration: 600
##################################################
YES
, NO
authenticateWithToken
boolean
pcRunBuild
serverAndPort
String
pcServerName
String
credentialsId
String
almDomain
String
almProject
String
testToRun
String
testId
String
testContentToCreate
The content of the field must either be:
Note:
Parameter | Description | Required |
---|---|---|
test_name | The test name. | Yes |
test_folder_path | The location of the test in the Test Management folder tree of the LoadRunner Enterprise project. The folders should be separated by double backslashes (\\). For example, "MyMainFolder\\MySubfolder\\MySubSubFolder". Do not include the LoadRunner Enterprise root folder (named "Subject") | Yes |
test_content | The content of the test that requires additional parameters specified in the 'test_content' table below. | Yes |
Parameter | Description | Required |
---|---|---|
controller |
Defines the Controller to be used during the test run (it must be an available host in the LoadRunner Enterprise project). If not specified, a Controller will be chosen from the different controllers available in the LoadRunner Enterprise project.
From Performance Center 12.62 and plugin version 1.1.1, the option to provision a Controller as a Docker image is available by specifying the value "Elastic" and providing a value for the 'controller_elastic_configuration' parameter (see 'controller_elastic_configuration' table below).
|
No |
lg_amount | Number of load generators to allocate to the test (every group in the test will be run by the same load generators). | Not required if each group defined in the 'group' parameter defines the load generators it will be using via the 'lg_name' parameter (see 'group' table below). |
group | Lists all groups or scripts defined in the test. The parameter to be used in each group are specified in the 'group' table below. | Yes |
scheduler | Defines the duration of a test, and determines whether virtual users are started simultaneously or gradually. See the 'scheduler' table below. | No |
lg_elastic_configuration | Defines the image to be used in order to provision load generators. See the 'lg_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if a load generator is defined to be provisioned from a Docker image. |
controller_elastic_configuration | Defines the image to be used in order to provision the Controller. See the 'controller_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if the Controller is defined to be provisioned from a Docker image. |
Parameter | Description | Required |
---|---|---|
group_name | Name of the group (it must be a unique name if several groups are defined). | Yes |
vusers | Number of virtual users to allocate to the group for running the script. | Yes |
script_id | ID of the script in the LoadRunner Enterprise project. | Not required if the 'script_path' parameter is specified. |
script_path | Path and name of the script to be added to the group, separated by double backslashes (\\). For example "MyMainFolder\\MySubFolder\\MyScriptName'. Do not include the LoadRunner Enterprise root folder (named "Subject"). | Not required if 'script_id' parameter is specified |
lg_name | List of load generators to allocate to the group for running the script. The supported values are:
|
No |
command_line | The command line applied to the group. | No |
rts | Object defining the runtime settings of the script. See the 'rts' table below. | No |
Parameter | Description | Required |
---|---|---|
pacing | Can be used to define the number of iterations the script will run and the required delay between iterations (see the 'pacing' table below). | No |
thinktime | Can be used to define think time (see the 'thinktime' table below). | No |
java_vm | Can be used when defining Java environment runtime settings (see the 'java_vm' table below). | No |
jmeter | Can be used to define JMeter environment runtime settings (see the 'jmeter' table below). | No |
Parameter | Description | Required |
---|---|---|
number_of_iterations | Specifies the number of iterations to run; this must be a positive number. | Yes |
type | Possible values for type attribute are:
|
No |
delay | Non-negative number (less than 'delay_at_range_to_seconds' when specified). | Depends on the value provided for the 'type' parameter. |
delay_random_range | Non-negative number. It will be added to the value given to the 'delay' parameter (the value will be randomly chosen between the value given to 'delay' parameter and the same value to which is added the value of this parameter). | Depends on the value provided for the 'type' parameter. |
Parameter | Description | Required |
---|---|---|
type | The ThinkTime Type attribute is one of:
|
No |
min_percentage | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
max_percentage | This must be a positive number (it must be larger than the value provided for the 'min_percentage' parameter). | Depends on the value provided for the 'type' parameter. |
limit_seconds | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
multiply_factor | The recorded think time is multiplied by this factor at runtime. | Depends on the value provided for the 'type' parameter. |
Parameter | Description | Required |
---|---|---|
jdk_home | The JDK installation path. | No |
java_vm_parameters | List the Java command line parameters. These parameters can be any JVM argument. The common arguments are the debug flag (-verbose) or memory settings (-ms, -mx). In additional, you can also pass properties to Java applications in the form of a -D flag. | No |
use_xboot | Boolean: Instructs VuGen to add the Classpath before the Xbootclasspath (prepend the string). | No |
enable_classloader_per_vuser | Boolean: Loads each Virtual User using a dedicated class loader (runs Vusers as threads). | No |
java_env_class_paths | A list of classpath entries. Use a double backslash (\\) for folder separators. | No |
Parameter | Description | Required |
---|---|---|
start_measurements | Boolean value to enable JMX measurements during performance test execution. | No |
jmeter_home_path | Path to JMeter home. If not defined, the path from the %JMETER_HOME% environment variable is used. | No |
jmeter_min_port | This number must be lower than the value provided in the 'jmeter_max_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
jmeter_max_port | This number must be higher than the value provided in the 'jmeter_min_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
jmeter_additional_properties | JMeter additional properties file. Use double slash (\\) for folder separator. | No |
Parameter | Description | Required |
---|---|---|
rampup | Time, in seconds, to gradually start all virtual users. Additional virtual users are added every 15 seconds until the time specified in the parameter ends. If no value is specified, all virtual users are started simultaneously at the beginning of the test. | No |
duration | Time, in seconds, that it will take to run the test after all virtual users are started. After this time, the test run ends. If not specified, the test will run until completion. | No |
Parameter | Description | Required |
---|---|---|
image_id | This number can be retrieved from:
|
Yes if one of the load generator is defined to be provisioned from Docker image. |
memory_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
cpu_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
Parameter | Description | Required |
---|---|---|
image_id | This number can be retrieved from:
|
Yes if the Controller is defined to be provisioned from Docker image. |
memory_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
cpu_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
##################################################
test_name: mytestname
test_folder_path: "Tests\\mytests"
test_content:
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
duration: '300'
##################################################
##################################################
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
duration: '300'
##################################################
##################################################
controller: "mycontroller"
lg_amount: 3
group:
- group_name: "JavaVuser_LR_Information_pacing_immediately_thinktime_ignore"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "immediately"
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
use_xboot: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "ignore"
- group_name: "JavaHTTP_BigXML_pacing_fixed_delay_thinktime_replay"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed delay"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
thinktime:
type: "replay"
limit_seconds: 30
- group_name: "JavaVuser_LR_Information_immediately_pacing_random_delay_thinktime_modify"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "random delay"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "modify"
limit_seconds: 30
multiply_factor: 2
- group_name: "JavaHTTP_BigXML_pacing_fixed_interval_thinktime_random"
vusers: 50
#script_id: 392
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed interval"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "random"
limit_seconds: 30
min_percentage: 2
max_percentage: 3
- group_name: "JavaHTTP_BigXML_pacing_random_interval"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
- group_name: "Mtours_pacing_random_interval"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
jmeter_home_path: "c:\\jmeter"
jmeter_min_port: 2001
jmeter_max_port: 3001
jmeter_additional_properties: "jmeter_additional_properties"
- group_name: "Mtours_pacing_random_interval_Jmeter_default_port"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
scheduler:
rampup: 120
duration: 600
##################################################
String
testInstanceId
String
autoTestInstanceID
String
timeslotDurationHours
String
timeslotDurationMinutes
String
postRunAction
COLLATE
, COLLATE_AND_ANALYZE
, DO_NOTHING
vudsMode
boolean
statusBySLA
boolean
description
String
addRunToTrendReport
String
trendReportId
String
HTTPSProtocol
boolean
proxyOutURL
String
credentialsProxyId
String
retry
String
retryDelay
String
retryOccurrences
String
authenticateWithToken
boolean
activateDTConfiguration
dynatraceProfile
String
configuration
String
createMemoryDump
dynatraceProfile
String
agent
String
host
String
autoPostProcess
(optional)
boolean
capturePrimitives
(optional)
boolean
captureStrings
(optional)
boolean
dogc
(optional)
boolean
lockSession
(optional)
boolean
type
(optional)
String
startSession
dynatraceProfile
String
testCase
String
lockSession
(optional)
boolean
recordingOption
(optional)
String
stopSession
dynatraceProfile
String
createThreadDump
dynatraceProfile
String
agent
String
host
String
lockSession
(optional)
boolean
$class: 'PerformanceAnalysisBuilder'
testjob
Specify the data set name that contains the mainframe job that you want to run the performance benchmarking for, for example, TEST.POC.JCLLIB(TESTJOB).
The maximum length is 44 characters.
Ensure that the job is included in the monitoring scope of the CA MAT Performance Benchmarking plugin by Broadcom.
String
blazeMeterTest
credentialsId
(optional)
String
workspaceId
(optional)
String
testId
(optional)
String
abortJob
(optional)
boolean
additionalTestFiles
(optional)
String
getJtl
(optional)
boolean
getJunit
(optional)
boolean
jobApiKey
(optional)
String
jtlPath
(optional)
String
junitPath
(optional)
String
mainTestFile
(optional)
String
notes
(optional)
String
reportLinkName
(optional)
String
serverUrl
(optional)
String
sessionProperties
(optional)
String
bzt
params
String
alwaysUseVirtualenv
(optional)
boolean
bztVersion
(optional)
String
generatePerformanceTrend
(optional)
boolean
printDebugOutput
(optional)
boolean
useBztExitCode
(optional)
boolean
useSystemSitePackages
(optional)
boolean
virtualEnvCommand
(optional)
String
workingDirectory
(optional)
String
workspace
(optional)
String
$class: 'PhingBuilder'
name
String
buildFile
If your build requires a custom -buildfile, specify it here. By default Phing will use the build.xml in the module directory, this option can be used to use build files with a different name or in somewhere outside the top directory.
And you can use environment variables such like ''$WORKSPACE''.
String
targets
String
properties
# comment name1=value1 name2=value2These are passed to Phing like "-Dname1=value1 -Dname2=value2"
String
useModuleRoot
boolean
options
String
$class: 'PipelineGenerationStep'
project
Name of the project. It is used as an identifier in the corresponding pipelines, folders and jobs being generated.
String
projectScmType
Type of the SCM. Currently only svn
and git
are supported.
String
projectScmUrl
URL to the project SCM. Without any branch indication.
For example:
svn
, URL to the root of the project, without trunk
or branches
. git
, URL of the remote.String
projectScmCredentials
ID or UUID of the Jenkins credentials to use when connecting to the project SCM.
String
branch
SCM branch.
String
seedProject
Project name useable for folders, job names, etc.
String
seedBranch
Branch name useable for folders, job names, etc.
String
disableDslScript
If checked, the pipeline generation disallows the direct execution of a DSL Groovy script. Only DSL libraries, configured through a seed.properties file are allowed. By default, both modes are allowed.
boolean
scriptDirectory
Path to the directory which contains the pipeline script. Defaults to seed
if not filled.
String
plot
group
String
style
String
csvFileName
String
csvSeries
(optional)
file
String
url
String
inclusionFlag
String
exclusionValues
String
displayTableFlag
boolean
description
(optional)
String
exclZero
(optional)
boolean
keepRecords
(optional)
boolean
logarithmic
(optional)
boolean
numBuilds
(optional)
String
propertiesSeries
(optional)
file
String
label
String
title
(optional)
String
useDescr
(optional)
boolean
xmlSeries
(optional)
file
String
xpath
String
nodeType
String
url
String
yaxis
(optional)
String
yaxisMaximum
(optional)
String
yaxisMinimum
(optional)
String
$class: 'PolarisBuildStep'
createChangeSetFile
(optional)
Creates a file at $CHANGE_SET_FILE_PATH (by default, the workspace directory) containing a list of files generated from the Jenkins-provided scm changeset.
Used for Incremental analysis (--incremental) as the file containing the list of changed files for analysis.
buildStatusOnSkip
(optional)
The action to take when static analysis is skipped because the changeset contained no files to analyze. Defaults to "Mark the build as Unstable".
SUCCESS
, FAILURE
, UNSTABLE
changeSetExclusionPatterns
(optional)
Specify a comma separated list of filename patterns that you would like to explicitly excluded from the Jenkins-provided SCM changeset.
The pattern is applied to determine which files will be populated in the changeset file, stored at $CHANGE_SET_FILE_PATH.
If blank, will exclude none.
Examples:
File Name | Pattern | Will be excluded |
---|---|---|
test.java | *.java | Yes |
test.java | *.jpg | No |
test.java | test.* | Yes |
test.java | test.???? | Yes |
test.java | test.????? | No |
String
changeSetInclusionPatterns
(optional)
Specify a comma separated list of filename patterns that you would like to explicitly included Jenkins-provided SCM changeset.
The pattern is applied to determine which files will be populated in the changeset file, stored at $CHANGE_SET_FILE_PATH.
If blank, will include all. Examples:
File Name | Pattern | Will be included |
---|---|---|
test.java | *.java | Yes |
test.java | *.jpg | No |
test.java | test.* | Yes |
test.java | test.???? | Yes |
test.java | test.????? | No |
String
polarisArguments
(optional)
The command line arguments to pass to the CLI
String
polarisCliName
(optional)
The CLI installation to execute
String
waitForIssues
(optional)
Check this box to wait for CLI jobs to complete and set the build status based on issues discovered
buildStatusForIssues
(optional)
The build status to set the project to if there are issues
SUCCESS
, FAILURE
, UNSTABLE
jobTimeoutInMinutes
(optional)
The maximum number of minutes to wait for jobs started by the Polaris CLI to complete when the Polaris CLI is executed without -w (nonblocking mode). Must be a positive integer, defaults to 30 minutes.
int
fortiCWPScanner
imageName
String
block
(optional)
boolean
portshift_vulnerability_scanner
accessKey
String
secretKey
String
imageName
String
imageTag
String
url
String
scannerIp
String
$class: 'PowerShell'
command
String
stopOnError
Stops script when some step fails. Similar to Shell set -e. Translates to $ErrorActionPreference Stop or Continue. See documentation.
boolean
useProfile
Runs script with default profile or no profile. See documentation.
boolean
unstableReturn
(optional)
int
$class: 'PowerShellBuildStep'
buildStepId
String
defineArgs
boolean
buildStepArgs
arg
String
$class: 'PreflightBuilder'
clientId
String
clientSecret
String
testId
String
groupId
String
environmentId
String
platforms
win-chrome
.win-chrome,win-firefox
win
chrome, ie, edge, firefox
String
sizes
1440x900
.1920x1080, 1440x900
1920x1080, 1440x900, 1024x768, 480x640
String
captureScreenshots
boolean
waitResults
boolean
$class: 'PrereqBuilder'
projects
String
warningOnly
boolean
probelyScan
targetId
ID of the target you want Probely to scan.
String
authToken
(optional)
Raw Probely API authentication key.
Please use the credentialsId field instead, unless you understand the security implications of using this mechanism. Passing the API authentication token directly is not advised, unless it is properly secured using a secret storage mechanism, such as HashiCorp Vault.
String
credentialsId
(optional)
Credential identifier for the Probely API authentication key.
String
failThreshold
(optional)
Mark the build as failed if a vulnerability with the following severity level is found.
String
stopIfFailed
(optional)
If the build fails because the target is vulnerable, stop scanning for more vulnerabilities.
boolean
waitForScan
(optional)
Wait for the scan to complete before proceeding to the next step in the pipeline.
Since a scan can take a long time, the plugin will return as soon as the scan starts. This is enabled by default to make the build faster.
Please note that disabling this option implies that the build step always finishes successfully, even if vulnerabilities are found later on.
Enabling this option allows the plugin to mark the build as failed if it finds any vulnerabilities.
boolean
$class: 'ProjectGenerationStep'
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
$class: 'ProjectPrerequisitesInstaller'
protecodesc
credentialsId
(optional)
String
protecodeScGroup
(optional)
Group ID can be found from the BDBA service by looking at the URL when browsing an individual group: https://protecode-sc.mydomain.com/group/1234/
or with Groups API https://protecode-sc.mydomain.com/api/groups/
.
String
convertToSummary
(optional)
protecodesc.xml
.
boolean
customHeader
(optional)
String
directoryToScan
(optional)
String
dontZipFiles
(optional)
boolean
endAfterSendingFiles
(optional)
boolean
failIfVulns
(optional)
boolean
includeSubdirectories
(optional)
boolean
pattern
(optional)
String
protecodeScanName
(optional)
String
scanOnlyArtifacts
(optional)
boolean
scanTimeout
(optional)
int
$class: 'ProxyBuilder'
projectName
String
dotnetPublish
dotnet publish
compiles the application, reads through its dependencies specified in the project file, and publishes the resulting set of files to a directory. The output includes the following assets:
dotnet publish
command's output is ready for deployment to a hosting system (for example, a server, PC, Mac, laptop) for execution. It's the only officially supported way to prepare the application for deployment. Depending on the type of deployment that the project specifies, the hosting system may or may not have the .NET Core shared runtime installed on it. For more information, see Publish .NET Core apps with the .NET Core CLI .
configuration
(optional)
Debug
, but you can override the build configuration settings in your project.
String
force
(optional)
boolean
framework
(optional)
String
manifest
(optional)
String
manifests
(optional)
String
manifestsString
(optional)
dotnet store command
.
String
noBuild
(optional)
boolean
noDependencies
(optional)
boolean
noRestore
(optional)
boolean
nologo
(optional)
boolean
option
(optional)
String
options
(optional)
String
optionsString
(optional)
String
outputDirectory
(optional)
dotnet publish
commands result in nested output folders. For example, if the project folder is myproject, and the publish output folder is myproject/publish, and you run dotnet publish
twice, the second run puts content files such as .config and .json files in myproject/publish/publish. To avoid nesting publish folders, specify a publish folder that is not directly under the project folder, or exclude the publish folder from the project.
PublishDir
property instead of this option. String
project
(optional)
String
properties
(optional)
java.util.Map<java.lang.String, java.lang.String>
propertiesString
(optional)
dotnet publish
:
PublishProfile=Properties\PublishProfiles\profile.pubxml
: Use a .pubxml to set publish-related properties. See Visual Studio publish profiles (.pubxml) for ASP.NET Core app deployment for more information. PublishReadyToRun=true
: Compiles application assemblies as ReadyToRun (R2R) format. R2R is a form of ahead-of-time (AOT) compilation. For more information, see ReadyToRun images.PublishSingleFile=true
: Packages the app into a platform-specific single-file executable. The executable is self-extracting and contains all dependencies (including native) that are required to run the app. When the app is first run, the application is extracted to a directory based on the app name and build identifier. Startup is faster when the application is run again. The application doesn't need to extract itself a second time unless a new version is used.PublishTrimmed=true
: Trims unused libraries to reduce the deployment size of an app when publishing a self-contained executable. For more information, see Trim self-contained deployments and executables .PublishProfile
, in a publish profile rather than here.
String
runtime
(optional)
String
sdk
(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.
String
selfContained
(optional)
boolean
showSdkInfo
(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.
boolean
shutDownBuildServers
(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).
boolean
specificSdkVersion
(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.
boolean
unstableIfWarnings
(optional)
boolean
verbosity
(optional)
String
versionSuffix
(optional)
*
) in the version field of the project file.
String
workDirectory
(optional)
String
snPublishApp
credentialsId
(optional)
String
apiVersion
(optional)
String
appScope
(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.
String
appSysId
(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.
String
appVersion
(optional)
String
devNotes
(optional)
String
incrementBy
(optional)
int
isAppCustomization
(optional)
boolean
obtainVersionAutomatically
(optional)
boolean
url
(optional)
String
artifactVersion
name
(optional)
String
description
(optional)
String
type
(optional)
String
groupId
(optional)
String
artifactId
(optional)
String
stage
(optional)
String
flow
(optional)
String
stageDescription
(optional)
String
version
(optional)
String
$class: 'PublishBuilder'
packageid
String
nugetFeedUrl
String
nugetFeedApiKey
class hudson.util.Secret
packageVersion
String
sqlChangeAutomationVersionOption
value
Latest
, Specific
specificVersion
String
$class: 'PublishStepBuilder'
packageId
String
nugetFeedUrl
String
nugetFeedUrlApi
class hudson.util.Secret
packageVersion
String
$class: 'PullRequestCommenter'
comment
String
dotnetNuGetPush
dotnet nuget push
command pushes a package to the server and publishes it. The push command uses server and credential details found in the system's NuGet config file or chain of config files. For more information on config files, see Configuring NuGet Behavior. NuGet's default configuration is obtained by loading %AppData%\NuGet\NuGet.config (Windows) or $HOME/.local/share (Linux/macOS), then loading any nuget.config or .nuget\nuget.config starting from the root of drive and ending in the current directory.
dotnet pack
.
apiKeyId
(optional)
String
disableBuffering
(optional)
boolean
forceEnglishOutput
(optional)
boolean
noServiceEndpoint
(optional)
boolean
noSymbols
(optional)
boolean
root
(optional)
String
sdk
(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.
String
showSdkInfo
(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.
boolean
skipDuplicate
(optional)
boolean
source
(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
).
DefaultPushSource
config value is set in the NuGet config file.
String
specificSdkVersion
(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.
boolean
symbolApiKeyId
(optional)
String
symbolSource
(optional)
String
timeout
(optional)
int
workDirectory
(optional)
String
artifactVersion
variableName
String
name
(optional)
String
stage
(optional)
String
version
(optional)
String
$class: 'PushBuilder'
remoteImageStrategy
DO_NOT_USE
, GENERATE_GIT
, FIXED
hubUrls
String
organization
String
overwriteOrganization
boolean
remoteImageName
String
dateFormat
y|Y | Year |
M | Month |
w | Week in year |
W | Week in month |
D | Day in year |
d | Day in month |
F | Day of week in month |
E | Day name in week |
u | Day number of week (1 = Monday, ..., 7 = Sunday) |
H | Hour in day (0-23) |
k | Hour in day (1-24) |
K | Hour in am/pm (0-11) |
h | Hour in am/pm (1-12) |
String
appendDate
boolean
incrementVersion
boolean
$class: 'Python'
Runs a Python script (defaults to python interpreter) for building the project. The script will be run with the workspace as the current directory.
command
String
$class: 'PythonBuilder'
pythonName
String
nature
String
command
String
ignoreExitCode
boolean
qualityCloudsScan
credentialsId
String
instanceUrl
String
issuesCountThreshold
int
techDebtThreshold
int
qcThreshold
int
highSeverityThreshold
int
$class: 'QFTestConfigBuilder'
The QF-Test build step. Invokes QF-Test binary during your Jenkins job. If not listed in your PATH variable, the location of the QF-Test binary can be specified explicitly.
The actual test configuration is set via pairs of arguments and suite file fields. The Advanced Test result control button allows to adjust the mapping between the QF-Test result and the Jenkins build result.
All report files that are produced will be stored in an output directory relative to your workspace, whose structure is as follows:
<LOGDIR> ├── html (HTML report directory) ├── junit (junit report directory) └── qrz (QF-Test runlogs)The resulting runlogs are automatically declared as Jenkins build artificats and should appear as such on the Jenkins build page. The junit and html reports can be processed further by the junit respectively the publishHTML plugin.
suitefield
suitename
String
customParam
String
customPath
(optional)
String
onTestError
(optional)
String
onTestException
(optional)
String
onTestFailure
(optional)
String
onTestWarning
(optional)
String
reportDirectory
(optional)
String
reportGenArgs
(optional)
String
$class: 'QualityCenter'
qcClientInstallationName
String
qcQTPAddinInstallationName
String
qcServerURL
qcbin
folder of the Quality Center Web application.
String
qcLogin
String
qcPass
String
qcDomain
String
qcProject
String
qcTSFolder
String
qcTSName
String
qcTSLogFile
Name of the report that will be generated.
If several test sets are run in one build step, one report will be generated per test set. As such, you must ensure that the name will be unique by including the test set name in it (through the ${TS_NAME}
variable). If it's not the case, then the name will be automatically post fixed with an underscore followed by the test set name.
You can use all standard environment variables plus:
${QC_DOMAIN}
for the current Quality Center domain;${QC_PROJECT}
for the current Quality Center project;${TS_FOLDER}
for the current TestSet folder;${TS_NAME}
for the TestSet name.String
qcTimeOut
int
runMode
String
runHost
String
acrQuickTask
azureCredentialsId
String
resourceGroupName
String
registryName
String
architecture
(optional)
String
buildArgs
(optional)
docker build --build-arg
.
key
String
value
String
secrecy
boolean
dockerfile
(optional)
String
gitPath
(optional)
String
gitRefspec
(optional)
String
gitRepo
(optional)
https://PAT@github.com/user/repo.git
for private repo.
String
imageNames
(optional)
image
String
local
(optional)
String
noCache
(optional)
no-cache
flag when build as docker build --no-cache
boolean
os
(optional)
String
sourceType
(optional)
String
tarball
(optional)
http://remoteserver/myapp.tar.gz
String
timeout
(optional)
int
variant
(optional)
String
$class: 'R'
Runs an R script (defaults to RScript interpreter) for building the project. The script will be run with the workspace as the current directory.
command
String
$class: 'RAD'
activateProjectWorkspaceVar
WORKSPACE
environment variable through the PROJECT_WORKSPACE
one.
WORKSPACE
variable during this build step as it doesn't refer to the workspace of the project: It is internally used by RAD.
boolean
buildFile
build.xml
one in the project's workspace. The base directory is the workspace.
String
deleteRadWorkspaceContent
.metadata
folder.
boolean
deleteRadWorkspaceMetadata
.metadata
folder of RAD's workspace has to be removed before RAD is actually run.
boolean
properties
# comment name1=value1 name2=value2These are passed to RAD like "-Dname1=value1 -Dname2=value2"
String
radInstallationName
String
radWorkspace
String
targets
String
$class: 'RPDCreateInstance'
pack
String
instanceName
String
customProfile
String
$class: 'RPDDeployInstance'
instanceName
String
pack
String
environment
String
route
String
customProfile
String
useCustomProfile
boolean
$class: 'RTCGitBuilder'
serverURI
The Jazz Repository connection URI for the Rational Team Concert (RTC) server
String
credentialsId
Credentials to use for the build user. A user name and password credential for the Jazz Repository should be configured.
String
annotateChangeLog
Optionally hyperlink bug numbers that appear in git commit descriptions as links to Rational Team Concert Work Items.
boolean
buildDefinition
(optional)
The ID of the Hudson/Jenkins build definition within the Rational Team Concert (RTC) server. The build definition should not have any Source Control option.
String
jenkinsRootURI
(optional)
String
jenkinsRootURIOverride
(optional)
Optionally specify the HTTP address of the Jenkins installation, such as http://yourhost.yourdomain/jenkins/. This is necessary because the Rational Team Concert Git plugin cannot reliably detect such a URL from within itself.
boolean
timeout
(optional)
The timeout period in seconds for Jazz repository requests made during the build.
int
trackBuildWorkItem
(optional)
Specify an Id of a Work Item in Rational Team Concert. The Work Item will be updated with the execution status of the Jenkins build.
String
useBuildDefinition
(optional)
boolean
useTrackBuildWorkItem
(optional)
boolean
useWorkItems
(optional)
boolean
workItemUpdateType
(optional)
String
rabbitMQPublisher
rabbitName
String
exchange
String
data
String
conversion
(optional)
boolean
routingKey
(optional)
String
toJson
(optional)
boolean
$class: 'RadarGunBuilder'
radarGunInstance
$class: 'RadarGunCustomInstallation'
home
String
$class: 'RadarGunInstallationWrapper'
radarGunName
String
scenarioSource
$class: 'FileScenarioSource'
scenarioPath
String
$class: 'TextScenarioSource'
scenario
String
nodeSource
$class: 'FileNodeConfigSource'
nodeListPath
String
$class: 'TextNodeConfigSource'
nodes
String
scriptSource
$class: 'BuildInScriptSource'
$class: 'FileScriptSource'
mainPath
String
workerPath
String
$class: 'TextScriptSource'
mainScript
String
workerScript
String
remoteLoginProgram
String
remoteLogin
String
workspacePath
String
pluginPath
String
pluginConfigPath
String
reporterPath
String
$class: 'Rake'
rakeInstallation
String
rakeFile
String
tasks
String
rakeLibDir
String
rakeWorkingDir
String
silent
boolean
bundleExec
boolean
$class: 'RallyBuild'
preRallyState
stateName
String
issueString
String
updateOnce
boolean
preComment
preCommentText
String
preReady
preReadyState
boolean
changeReady
issueReady
boolean
createComment
commentText
String
changeRallyState
issueRallyState
String
changeDefectRallyState
defectRallyState
String
rancherRedeploy
credential
String
workload
since endpoint part has bean set in Credential, you only need specify path from "/p/" or "/project", eg:
/project/c-h4hxd:p-c9j8z/workloads/deployment:default:busybox
or /p/c-h4hxd:p-dwqfr/workload/deployment:jenkins:jenkins
String
images
nginx;nginx:1.0;myteam/myproject:v2.0;docker.io/team/image:v1.0.${BUILD_NUMBER}
this plugin will update all images in this workload by match the name part exactly, and simply set version part as you specified. so you may need Jenkins variables to dynamic generate new version number.String
alwaysPull
boolean
rancher
environmentId
String
endpoint
String
credentialId
String
service
String
image
String
confirm
boolean
startFirst
boolean
ports
String
environments
String
timeout
int
ranorex
cmdLineArgs
(optional)
Flag | Function |
---|---|
config | cfg:<config parameter name>=<value> | Set values for configuration parameters. |
reportlevel | rl: Debug|Info|Warn|Error|Success|Failure|<any integer> | Sets the minimum report level that log messages need to have in order to be included in the log file. Specify 'None' to completely disable reporting. These levels correspond to the following integer values: Debug=10,Info=20,Warn=30,Error=40,Success=110,Failure=120 |
testcase | tc:<name or guid of test case> | Runs this test case only. |
testsuite | ts:<path to test suite file> | Runs the test cases defined by the test suite (rxtst) file. By default the rxtst file with the same name as the <TestSuiteExe> is used or the first rxtst file in the same folder as <TestSuiteExe>. |
module | mo:<module name or guid> | Runs the module with the specified name or guid. Assemblies loaded by <TestSuiteExe> and assemblies referenced in the rxtst file are searched. |
testcaseparam | tcpa:<name or guid of test case>:<parameter name>=<value> | Creates or overrides values for testcase parameters specified in the test suite. |
runlabel | rul:<custom value> | Sets a custom runlabel for the test run. |
testcasedatarange | tcdr:<name or guid of test case>=<data range> | Sets the data range for a testcase. |
String
rxGlobalParameter
(optional)
String
rxJUnitReport
(optional)
boolean
rxReportDirectory
(optional)
String
rxReportExtension
(optional)
String
rxReportFile
(optional)
String
rxRunConfiguration
(optional)
String
rxTestRail
(optional)
boolean
rxTestRailPassword
(optional)
String
rxTestRailRID
(optional)
String
rxTestRailRunName
(optional)
String
rxTestRailUser
(optional)
String
rxTestSuiteFilePath
(optional)
String
rxZippedReport
(optional)
boolean
rxZippedReportDirectory
(optional)
String
rxZippedReportFile
(optional)
String
$class: 'RapidDeployJobPlanRunner'
serverUrl
String
authenticationToken
String
jobPlan
String
asynchronousJob
boolean
showIndividualLogs
boolean
showFullLog
boolean
$class: 'RapidDeployJobRunner'
serverUrl
String
authenticationToken
String
project
String
target
String
packageName
String
asynchronousJob
boolean
showFullLog
boolean
$class: 'RapidDeployPackageBuilder'
serverUrl
String
authenticationToken
String
project
String
enableCustomPackageName
boolean
packageName
String
archiveExtension
String
$class: 'RawCliBuilder'
changeLogFile
(optional)
String
changeLogParameters
(optional)
String
commandArguments
(optional)
String
contexts
(optional)
String
credentialsId
(optional)
String
installationName
(optional)
String
labels
(optional)
String
liquibasePropertiesPath
(optional)
String
password
(optional)
String
resourceDirectories
(optional)
String
url
(optional)
String
username
(optional)
String
$class: 'RebaseBuilder'
You can rebase from the latest revision in the upstream branch, but you can also do safer rebase by choosing the permalink. For example, if you specify "last stable", then Jenkins will look for the last stable build, then rebase with the corresponding Subversion revision. Thus you know that you are rebasing to the known good state.
If you don't want Jenkins to automatically rebase, you can still use the "Rebase From Upstream" link from the left to manually initiate the rebase.
permalink
String
stopBuildIfMergeFails
boolean
setUnstableIfMergeFails
boolean
$class: 'RebootIOSDevice'
url
String
cloudTestServerID
String
additionalOptions
String
$class: 'ReconfigureBox'
id
String
cloud
String
workspace
String
box
String
instance
String
variables
String
buildStep
String
buildStepVariables
String
$class: 'ReinstallBox'
cloud
String
workspace
String
box
String
instance
String
buildStep
String
$class: 'ReleaseMarker'
releaseName
String
services
(optional)
name
String
scopedTo
(optional)
applications
name
String
applications
(optional)
name
String
releaseEndTimestamp
(optional)
String
releaseStartTimestamp
(optional)
String
androidApkMove
apkFilesPattern
(optional)
String
applicationId
(optional)
String
filesPattern
(optional)
String
fromVersionCode
(optional)
boolean
googleCredentialsId
(optional)
String
inAppUpdatePriority
(optional)
String
releaseName
(optional)
String
rolloutPercent
(optional)
double
rolloutPercentage
(optional)
String
trackName
(optional)
String
versionCodes
(optional)
String
addRelizaRelease
artId
(optional)
String
artType
(optional)
String
envSuffix
(optional)
String
projectId
(optional)
String
status
(optional)
String
uri
(optional)
String
useCommitList
(optional)
String
version
(optional)
String
$class: 'RemoteBuildConfiguration'
abortTriggeredJob
(optional)
boolean
auth2
(optional)
BearerTokenAuth
token
(optional)
class hudson.util.Secret
CredentialsAuth
credentials
(optional)
String
NoneAuth
NullAuth
TokenAuth
apiToken
(optional)
class hudson.util.Secret
userName
(optional)
String
blockBuildUntilComplete
(optional)
boolean
disabled
(optional)
boolean
enhancedLogging
(optional)
boolean
httpGetReadTimeout
(optional)
int
httpPostReadTimeout
(optional)
int
job
(optional)
String
loadParamsFromFile
(optional)
boolean
maxConn
(optional)
int
overrideTrustAllCertificates
(optional)
boolean
parameterFile
(optional)
String
parameters
(optional)
String
pollInterval
(optional)
int
preventRemoteBuildQueue
(optional)
boolean
remoteJenkinsName
(optional)
String
remoteJenkinsUrl
(optional)
String
shouldNotFailBuild
(optional)
boolean
token
(optional)
String
trustAllCertificates
(optional)
It is possible to override/rewrite the 'Trust all certificate'-setting for each Job separately. Setting this checkbox to 'true' will result in accepting all certificates for the given Job.
This is unsafe and should only be used for testing or if you trust the host.
boolean
useCrumbCache
(optional)
boolean
useJobInfoCache
(optional)
boolean
crxReplicate
packageIds
(optional)
String
baseUrls
(optional)
username[:password]@
between the scheme and the hostname.
String
credentialsId
(optional)
/$username/keys/$fingerprint
.
String
ignoreErrors
(optional)
boolean
requestTimeout
(optional)
long
serviceTimeout
(optional)
long
waitDelay
(optional)
long
acmRepoSync
url
String
credentialsId
String
force
(optional)
boolean
$class: 'ReqtifyGenerateReport'
reportArgumentList
String
nameReport
(optional)
String
modelReport
(optional)
String
templateReport
(optional)
String
$class: 'RetrieveArtifactsBuildStep'
names
(optional)
name
(optional)
String
stage
(optional)
String
variableName
(optional)
String
publishReview
downloadOnly
boolean
installRBTools
boolean
$class: 'ReviewboardApplyPatch'
$class: 'ReviewboardPollingBuilder'
reviewbotJobName
String
checkBackPeriod
String
reviewbotRepoId
String
restrictByUser
boolean
disableAdvanceNotice
boolean
$class: 'RigorBuilder'
credentialsId
Please select a credential of Kind Rigor API Key here.
Note: Your Rigor Optimization API key can be found on the API Credentials settings page in the Rigor Optimization application. The API key must have User or higher level permissions.
String
performanceTestIds
List 1 or more test IDs (as a comma separated list) of Rigor Optimization Performance Tests to be run during this step. You can locate the performance test ID by hovering over the Info (i) icon on any performance test in the View Results page of your Rigor Optimization account.
If Fail build based on results is checked below, this step will wait until all tests complete before proceeding. If unchecked, this step will launch these tests, but not wait for them to complete.
String
failOnSnapshotError
If checked, the build will be marked as failed if there are any errors running your configured performance tests. If unchecked, any errors creating tests will be treated as warnings and not fail the build.
boolean
failOnResults
If checked, the build will wait for your configured tests to complete (may take 30 seconds to a few minutes) and pass/fail based on the results configured below. If unchecked, your configured tests will run, but the build will not wait for the tests to complete nor fail this step based on any results (useful for historical change logging of your site in the Rigor Optimization application).
boolean
performanceScore
Optional
Fail the build if any test reports an overall performance score lower than this value (1-100)
String
criticalNumber
Optional
Fail the build if any test has more than this # of critical first party content defects found.
Note: You can customize when critical defects occur by customizing your Defect Check Policy. Learn more in this article.
String
foundDefectIds
Optional
Fail the build if any of the listed defect IDs (comma separated) are found for any first party content items in any configured test.
Note: You can locate any defect ID at the top of any defect detail page in your results, or in the Knowledge Base. See Example.
String
enforcePerformanceBudgets
Optional
Fail the build if any test exceeds its performance budgets
boolean
totalContentSize
String
totalFoundItems
String
testTimeoutSeconds
Timeout in seconds to wait for all configured performance tests to complete. Defaults to 300 seconds (5 minutes).
This value is only used if Fail build based on test results is enabled.
String
snRollbackApp
credentialsId
(optional)
String
apiVersion
(optional)
String
appScope
(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.
String
appSysId
(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.
String
rollbackAppVersion
(optional)
String
url
(optional)
String
$class: 'RollbackBuilder'
changeLogFile
(optional)
String
changeLogParameters
(optional)
String
contexts
(optional)
String
credentialsId
(optional)
String
installationName
(optional)
String
labels
(optional)
String
liquibasePropertiesPath
(optional)
String
numberOfChangesetsToRollback
(optional)
String
password
(optional)
String
resourceDirectories
(optional)
String
rollbackLastHours
(optional)
String
rollbackToDate
(optional)
String
rollbackToTag
(optional)
String
rollbackType
(optional)
String
url
(optional)
String
username
(optional)
String
snRollbackPlugin
credentialsId
(optional)
String
apiVersion
(optional)
String
pluginId
(optional)
String
url
(optional)
String
$class: 'RqmBuilder'
collectionStrategy
$class: 'RqmTestSuiteExectionRecordCollectionStrategy'
executionRecordName
String
planName
String
projectName
String
iterativeTestCaseBuilders
hudson.tasks.BuildStep
)preBuildSteps
hudson.tasks.BuildStep
)postBuildSteps
hudson.tasks.BuildStep
)credentialId
String
$class: 'RubyMotionBuilder'
platform
String
rakeTask
String
outputStyle
String
outputFileName
String
useBundler
boolean
installCocoaPods
boolean
needClean
boolean
outputResult
boolean
deviceName
String
simulatorVersion
String
envVars
String
$class: 'RunApplicationAction'
applicationName
Application selection is mandatory
Select an existing Application in Calm or the ones provisioned in Nutanix Calm Blueprint Launch Steps.
String
actionName
Application Action selection is mandatory
String
runtimeVariables
Click on Fetch Runtime Variables to fetch all editable variables for the selected Action in JSON format. Modify the key values from the defaults as needed.The values can also reference jenkins environment variables.
String
runFromAlmBuilder
almServerName
String
almCredentialsScope
String
almUserName
String
almPassword
String
almDomain
String
almProject
String
almTestSets
String
almRunResultsMode
String
almTimeout
String
almRunMode
String
almRunHost
String
almClientID
String
almApiKey
String
isSSOEnabled
boolean
isFilterTestsEnabled
(optional)
boolean
filterTestsModel
(optional)
blockedCheckbox
boolean
failedCheckbox
boolean
notCompletedCheckbox
boolean
noRunCheckbox
boolean
passedCheckbox
boolean
testName
(optional)
String
almServerSettingsModel
(optional)
almServerName
String
almServerUrl
String
almCredentials
almUsername
String
almPassword
String
almSSOCredentials
almClientID
String
almApiKeySecret
String
runFromFSBuilder
fsTests
String
fileSystemTestSetModel
fileSystemTestSet
tests
String
parallelRunnerEnvironments
environment
String
environmentType
String
summaryDataLogModel
logVusersStates
boolean
logErrorCount
boolean
logTransactionStatistics
boolean
pollingInterval
String
scriptRTSSetModel
scripts
scriptName
String
additionalAttributes
name
String
value
String
description
String
isParallelRunnerEnabled
(optional)
boolean
uftSettingsModel
(optional)
selectedNode
(optional)
String
numberOfReruns
(optional)
String
cleanupTest
(optional)
String
onCheckFailedTest
(optional)
String
fsTestType
(optional)
String
rerunSettingsModels
(optional)
test
(optional)
String
checked
(optional)
boolean
numberOfReruns
(optional)
int
cleanupTest
(optional)
String
analysisTemplate
(optional)
String
controllerPollingInterval
(optional)
String
displayController
(optional)
String
fsAutActions
(optional)
String
fsDeviceId
(optional)
String
fsDevicesMetrics
(optional)
String
fsExtraApps
(optional)
String
fsInstrumented
(optional)
String
fsJobId
(optional)
String
fsLaunchAppName
(optional)
String
fsManufacturerAndModel
(optional)
String
fsOs
(optional)
String
fsPassword
(optional)
String
fsReportPath
(optional)
String
fsTargetLab
(optional)
String
fsTimeout
(optional)
String
fsUftRunMode
(optional)
String
fsUserName
(optional)
String
ignoreErrorStrings
(optional)
String
mcServerName
(optional)
String
mcTenantId
(optional)
String
perScenarioTimeOut
(optional)
String
proxySettings
(optional)
fsUseAuthentication
boolean
fsProxyAddress
String
fsProxyUserName
String
fsProxyPassword
class hudson.util.Secret
resultFileNames
(optional)
java.util.Map<java.lang.Long, java.lang.String>
useSSL
(optional)
boolean
$class: 'RunInCloudBuilder'
projectId
The Bitbar Cloud project in which to start the new test run.
String
appPath
String
testPath
String
dataPath
String
testRunName
String
scheduler
String
testRunner
String
deviceGroupId
String
language
String
screenshotsDirectory
String
keyValuePairs
String
withAnnotation
String
withoutAnnotation
String
testCasesSelect
String
testCasesValue
String
failBuildIfThisStepFailed
boolean
virusScanTimeout
String
waitForResultsBlock
testRunStateCheckMethod
(optional)
HOOK_URL
, API_CALL
downloadScreenshots
(optional)
boolean
forceFinishAfterBreak
(optional)
boolean
hookURL
(optional)
String
resultsPath
(optional)
String
waitForResultsTimeout
(optional)
int
testTimeout
String
credentialsId
String
cloudUrl
String
cloudUIUrl
String
frameworkId
long
osType
IOS
, ANDROID
, DESKTOP
, UNDEFINED
tpJobRun
projectId
(optional)
String
jobId
(optional)
String
agentId
(optional)
String
waitJobFinishSeconds
(optional)
int
executionParameters
(optional)
String
junitResultsFile
(optional)
String
osfBuilderSuiteForSFCCRunJob
hostname
(optional)
String
ocCredentialsId
(optional)
String
ocVersion
(optional)
String
jobName
(optional)
String
jobArguments
(optional)
name
String
value
String
$class: 'RunLoadRunnerScript'
scriptsPath
String
$class: 'RunMatlabCommandBuilder'
matlabCommand
(optional)
String
$class: 'RunMatlabTestsBuilder'
coberturaArtifact
(optional)
coberturaReportFilePath
String
junitArtifact
(optional)
junitReportFilePath
String
modelCoverageArtifact
(optional)
modelCoverageFilePath
String
pdfReportArtifact
(optional)
pdfReportFilePath
String
selectByFolder
(optional)
testFolderPaths
testFolders
String
selectByTag
(optional)
testTag
String
sourceFolder
(optional)
Specify the location of folders containing source code, relative to the project root folder. The specified folders and their subfolders are added to the top of the MATLAB search path. To generate a coverage report, MATLAB uses only the source code in the specified folders and their subfolders.
Paste the source folder path in the Folder path box. To add more folders, click Add folder.
sourceFolderPaths
srcFolderPath
String
stmResultsArtifact
(optional)
stmResultsFilePath
String
tapArtifact
(optional)
tapReportFilePath
String
$class: 'RunPcTestBuildStep'
almPassword
(optional)
String
almUser
(optional)
String
domain
(optional)
String
failIfTaskFails
(optional)
boolean
outputDir
(optional)
String
pollingInterval
(optional)
int
postRunActionString
(optional)
String
project
(optional)
String
retryCollateAndAnalysisAttempts
(optional)
int
retryCollateAndAnalysisFlag
(optional)
boolean
retryCollateAndAnalysisInterval
(optional)
int
retryCount
(optional)
int
retryInterval
(optional)
int
retryIntervalMultiplier
(optional)
double
testLabPath
(optional)
String
testPlanPath
(optional)
String
timeout
(optional)
int
timeslotDuration
(optional)
int
vudsMode
(optional)
boolean
runPromotion
artifact
(optional)
String
artifactType
(optional)
String
keepTargetResources
(optional)
boolean
keepTargetRunProfiles
(optional)
boolean
plan
(optional)
String
promotion
(optional)
String
task
(optional)
String
workspace
(optional)
String
runTask
environment
(optional)
String
parameters
(optional)
String
task
(optional)
String
workspace
(optional)
String
tpTestRun
junitResultsFile
String
waitTestFinishSeconds
int
projectId
String
testId
String
agentId
String
browser
String
device
String
executionParameters
String
$class: 'RunTestSetBuildStep'
domain
String
project
String
runMode
String
host
String
testSets
String
outputDirPath
String
timeOut
int
snRunTestSuite
credentialsId
(optional)
String
apiVersion
(optional)
String
browserName
(optional)
Valid values:
String
browserVersion
(optional)
String
osName
(optional)
String
osVersion
(optional)
String
responseBodyFormat
(optional)
String
testSuiteName
(optional)
String
testSuiteSysId
(optional)
sys_id
of the test suite to run. This value is located in the Test [sys_atf_test_suite] table.
String
url
(optional)
String
withResults
(optional)
boolean
$class: 'RunUftTestBuildStep'
testPath
String
outputDirPath
String
$class: 'RunscopeBuilder'
triggerEndPoint
String
accessToken
String
timeout
int
s3CopyArtifact
projectName
String
buildSelector
downstream
upstreamProjectName
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).
String
upstreamBuildNumber
String
lastWithArtifacts
lastCompleted
$class: 'MultiJobBuildSelector'
buildParameter
parameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
String
permalink
id
String
$class: 'PromotedBuildSelector'
level
int
latestSavedBuild
specific
buildNumber
String
lastSuccessful
stable
(optional)
boolean
upstream
allowUpstreamDependencies
(optional)
boolean
fallbackToLastSuccessful
(optional)
boolean
upstreamFilterStrategy
(optional)
UseGlobalSetting
, UseOldest
, UseNewest
workspace
filter
String
excludeFilter
String
target
String
flatten
boolean
optional
boolean
$class: 'SASUnitPlugInBuilder'
This is the Jenkins Plug-In for SASUnit the unit testing framework for SAS.
sasunitBatch
String
doxygenBatch
Please enter the relative path to the executable to create the doxygen report
String
sasunitVersion
Please pick a SASUnit installation that shall be used.
To add an installation please go to Jenins->Manage Jenkins->Setting or follow this link.
String
createDoxygenDocu
boolean
$class: 'SBuild'
sbuildVersion
String
targets
String
buildFiles
String
options
String
scmSkip
deleteBuild
(optional)
boolean
skipPattern
(optional)
String
$class: 'SConsBuilderCommand'
sconsName
String
options
String
variables
String
targets
String
rootSconsscriptDirectory
String
commandScript
String
$class: 'SConsBuilderScriptFile'
sconsName
String
options
String
variables
String
targets
String
rootSconsscriptDirectory
String
sconsscript
String
$class: 'SMABuilder'
validateEnabled
boolean
username
String
password
String
securityToken
String
serverType
String
testLevel
String
prTargetBranch
String
$class: 'SQLPlusRunnerBuilder'
credentialsId
String
instance
String
scriptType
String
script
String
scriptContent
SELECT sysdate from dual; show user; |
String
customNLSLang
(optional)
String
customOracleHome
(optional)
String
customSQLPath
(optional)
String
customSQLPlusHome
(optional)
String
customTNSAdmin
(optional)
String
$class: 'SSHBuilder'
siteName
String
command
String
execEachLine
Execute each line in the script individually.
By default, all of the commands are concatenated into a single "command" issued over a single SSH exec channel. Selecting this option causes each line to be executed over it's own SSH exec channel, each of which is part of the same session.
This is useful in certain cases where the commands cannot be concatenated into a single script executed at one time, for example, when issuing commands using the sourceforge.net shell.
If unsure, leave this box unchecked.
boolean
hideCommand
(optional)
boolean
$class: 'SaltAPIBuilder'
authtype
String
clientInterface
hook
post
String
tag
String
batch
function
String
arguments
String
batchSize
String
batchWait
String
target
String
targettype
String
local
function
String
arguments
String
target
String
targettype
String
blockbuild
(optional)
boolean
jobPollTime
(optional)
int
minionTimeout
(optional)
int
subset
function
String
arguments
String
subset
String
target
String
targettype
String
runner
function
String
arguments
String
mods
String
pillarvalue
String
credentialsId
String
servername
(optional)
String
saveEnvVar
(optional)
boolean
saveFile
(optional)
boolean
skipValidation
(optional)
boolean
$class: 'SbtPluginBuilder'
name
String
jvmFlags
String
sbtFlags
String
actions
String
subdirPath
String
$class: 'ScanBuilder'
scanURL
String
apiKey
class hudson.util.Secret
source
String
exclude
String
rule
String
timeout
int
isAbortBuild
boolean
isPrivateScan
boolean
isShowBlockedOnly
boolean
isCreateLog
boolean
vdooScan
baseApi
(optional)
String
failThreshold
(optional)
String
firmwareLocation
(optional)
String
maliciousFiles
(optional)
String
maxHighlightedCVEs
(optional)
String
maxHighlightedExposures
(optional)
String
maxHighlightedIssues
(optional)
String
productId
(optional)
String
vdooToken
(optional)
class hudson.util.Secret
waitForResults
(optional)
boolean
$class: 'ScriptBuildStep'
buildStepId
String
defineArgs
boolean
buildStepArgs
arg
String
tokenized
boolean
$class: 'ScriptBuilder'
scriptFilePath
String
credentialsId
String
hubUrl
String
imageName
String
vmVersion
String
containerWorkingDir
String
mountSettings
sourceContainer
String
sourceFolder
String
targetFolder
String
routeFile
String
noBase
boolean
overwrite
boolean
diagnostic
boolean
$class: 'SealightsCLIBuildStep'
enabled
boolean
failBuildIfStepFail
boolean
commandMode
$class: 'ConfigView'
appName
String
branchName
String
buildName
$class: 'DefaultBuildName'
$class: 'EmptyBuildName'
$class: 'LatestBuildName'
$class: 'ManualBuildName'
insertedBuildName
String
$class: 'UpstreamBuildName'
upstreamProjectName
String
labId
String
buildSessionId
String
additionalArguments
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). |
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). |
String
techOptions
$class: 'DotNetOptions'
namespacesIncluded
String
namespacesExcluded
String
includedFilePatterns
String
excludedFilePatterns
String
$class: 'JavaOptions'
packagesIncluded
String
packagesExcluded
String
$class: 'EndView'
buildSessionId
String
labId
String
additionalArguments
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). |
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). |
appname | Override default app name coming from build session id |
buildname | Override default build name coming from build session id |
branchname | Override default branch name coming from build session id |
String
$class: 'ExternalReportView'
report
String
buildSessionId
String
additionalArguments
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). |
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). |
appname | Override default app name coming from build session id |
buildname | Override default build name coming from build session id |
branchname | Override default branch name coming from build session id |
String
$class: 'PrConfigView'
appName
String
branchName
String
buildName
$class: 'DefaultBuildName'
$class: 'EmptyBuildName'
$class: 'LatestBuildName'
$class: 'ManualBuildName'
insertedBuildName
String
$class: 'UpstreamBuildName'
upstreamProjectName
String
labId
String
buildSessionId
String
additionalArguments
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). |
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). |
String
techOptions
$class: 'DotNetOptions'
namespacesIncluded
String
namespacesExcluded
String
includedFilePatterns
String
excludedFilePatterns
String
$class: 'JavaOptions'
packagesIncluded
String
packagesExcluded
String
latestCommit
String
pullRequestNumber
String
repoUrl
String
targetBranch
String
$class: 'StartView'
testStage
String
buildSessionId
String
labId
String
additionalArguments
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). |
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). |
appname | Override default app name coming from build session id |
buildname | Override default build name coming from build session id |
branchname | Override default branch name coming from build session id |
String
$class: 'UploadReportsView'
reportFiles
String
reportsFolders
String
source
String
buildSessionId
String
labId
String
additionalArguments
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). |
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). |
appname | Override default app name coming from build session id |
buildname | Override default build name coming from build session id |
branchname | Override default branch name coming from build session id |
String
cliRunner
class io.sealights.plugins.sealightsjenkins.buildsteps.cli.CLIRunner
logDestination
CONSOLE
, FILE
logFolder
String
logLevel
OFF
, INFO
, DEBUG
, WARN
, ERROR
logFilename
String
$class: 'SecurityCheckerBuilder'
$class: 'SeleniumAutoExecBuilder'
serverUrl
String
$class: 'SeleniumBuilderBuilder'
scriptFile
String
parallelSettings
threadPoolSize
int
$class: 'SelfServiceBookmarkBuilder'
delphixEngine
String
delphixBookmark
String
delphixOperation
String
delphixContainer
String
loadFromProps
(optional)
boolean
saveToProps
(optional)
boolean
$class: 'SelfServiceContainerBuilder'
delphixEngine
String
delphixEnvironment
String
delphixOperation
String
delphixBookmark
String
loadFromProps
(optional)
boolean
saveToProps
(optional)
boolean
$class: 'SemanticVersioningBuilder'
parser
String
namingStrategy
String
useJenkinsBuildNumber
boolean
envVariable
String
$class: 'SendMessageBuildStep'
message
String
filepath
String
recipients
id
String
sensediaApiDeploy
enviromentName
String
revision
String
sensediaApiJson
apiId
String
sensediaApiQA
revisionNumber
int
destination
boolean
logInterceptor
boolean
resourceOutOfSize
boolean
resourceSize
int
shell
sh
, but this is configurable) for building the project. The script will be run with the workspace as the current directory. Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh
—, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl
) or control the options that shell uses.
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.
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
(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.
boolean
variables
(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.
String
unstableReturn
(optional)
int
$class: 'SideeX'
protocolMenu
The default protocol is "HTTP".
Use "HTTPS (Disable certificate checking)" to disable certificate checking.
Use "HTTPS (Enable certificate checking)" to enable certificate checking.
$class: 'HTTPItem'
baseURL
String
$class: 'HTTPSDisableItem'
baseURL
String
$class: 'HTTPSEnableItem'
baseURL
String
caFilePath
String
stateTime
String
testCaseFilePath
String
sigma
commandLine
(optional)
The command line arguments to execute for Rapid Scan Static which override the default analyze command. This allows for any Rapid Scan Static command line options to be specified.
If this field is empty the default command will be:
'sigma analyze --format jenkins'
String
ignorePolicies
(optional)
Prevents Rapid Scan Static from failing the build based on violated policies.
If selected, then the '--ignore-policies' command line argument will be added to the Rapid Scan Static analyze sub-command.
boolean
sigmaToolName
(optional)
Select the name of the Rapid Scan Static tool installation to execute Rapid Scan Static with this build step.
String
signAndroidApks
androidHome
(optional)
zipalign
tool. You can also set the ANDROID_HOME
environment variable in your Jenkins system or node configuration. E.g., /usr/local/android-sdk
.
String
apksToSign
(optional)
myApp/build/outputs/apk/myApp-unsigned.apk
or **/*-unsigned.apk
or app1/**/*-unsigned.apk, app2/**/*-unsigned.apk
.
String
archiveSignedApks
(optional)
SignApksBuilder-out/myApp-unsigned.apk/myApp-signed.apk
, where myApp-unsigned.apk
is a directory named for the input unsigned APK.
boolean
archiveUnsignedApks
(optional)
boolean
keyAlias
(optional)
Key Store ID
references. If your key store contains only one key entry, which is the most common case, you can leave this field blank.
String
keyStoreId
(optional)
String
signedApkMapping
(optional)
unsignedApkNameDir
unsignedApkSibling
skipZipalign
(optional)
boolean
zipalignPath
(optional)
zipalign
executable this build step should use to align the target APKs. You can also set the ANDROID_ZIPALIGN
environment variable in your Jenkins system or node configuration. E.g., /opt/android-tools/bin/zipalign
String
venafiCodeSignWithSignTool
tppName
String
fileOrGlob
A path or a glob that specifies the file(s) to be signed.
String
appendSignatures
(optional)
boolean
extraArgs
(optional)
This plugin invokes Signtool under the hood. Here you can specify extra custom CLI arguments to pass to Signtool.
These arguments will be appended to the Signtool CLI invocation. If they overlap with any arguments implicitly passed by this plugin, then Signtool will raise an error.
argument
String
sha1
(optional)
The SHA-1 hash of the certificate (inside the TPP) to use for code signing.
Normally you should use 'Signing certificate subject name' instead, but if that name is ambiguous, then use the SHA-1 hash to select a specific signing certificate.
Either a subject name or SHA-1 hash of the signing certificate must be given.
String
signToolPath
(optional)
String
signatureDigestAlgos
(optional)
The digest algorithm(s) to use to creating signatures.
If none specified, 'sha256' is used as the default algorithm. This is very secure, but may not be compatible with older Windows versions. If you need compatibility with older Windows versions, you should specify 'sha1' and 'sha256' (in that order).
When multiple digest algorithms are specified, they are applied in the order specified.
algorithm
String
subjectName
(optional)
The Common Name ("Issued to" or "CN") of the certificate (inside the TPP) to use for code signing.
You can obtain a list of Common Names with 'cspconfig listcertificates' and checking what comes after 'CN='.
Either a subject name or SHA-1 hash of the signing certificate must be given.
String
timestampingServers
(optional)
Specifies one or more timestamping authority servers to use during signing. Specifying this is strongly recommended, because it allows signed files to be usable even after the original signing certificate has expired.
If you specify more than one server, then a random one will be used.
Tip: here are some public timestamping authorities that you can use:
address
String
useMachineConfiguration
(optional)
boolean
venafiClientToolsDir
(optional)
C:\Program Files\Venafi CodeSign Protect
.String
venafiVerifyWithSignTool
tppName
String
fileOrGlob
A path or a glob that specifies the file(s) to be verified.
String
signToolPath
(optional)
String
useMachineConfiguration
(optional)
boolean
venafiClientToolsDir
(optional)
C:\Program Files\Venafi CodeSign Protect
.String
$class: 'SilkPerformerBuilder'
projectLoc
String
workload
String
successCriteria
userType
String
measureCategory
String
measureType
String
measureName
String
valueType
String
operatorType
String
chosenValue
String
SimplifyQA
api
String
token
class hudson.util.Secret
$class: 'SingleConditionalBuilder'
buildStep
hudson.tasks.BuildStep
)condition
$class: 'AlwaysRun'
$class: 'And'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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'
skenai
orgId
String
appId
String
$class: 'SkytapBuilder'
action
$class: 'AddConfigurationToProjectStep'
configurationID
String
configurationFile
String
projectID
String
projectName
String
$class: 'AddTemplateToProjectStep'
templateID
String
templateFile
String
projectID
String
projectName
String
$class: 'ChangeConfigurationStateStep'
configurationID
String
configurationFile
String
targetRunState
String
haltOnFailedShutdown
boolean
$class: 'ChangeContainerStateStep'
containerID
String
containerFile
String
targetContainerAction
String
$class: 'ChangeVMContainerHostStatus'
configurationID
String
configurationFile
String
vmID
String
vmName
String
containerHostStatus
String
$class: 'ConnectToVPNTunnelStep'
configurationID
String
configurationFile
String
configurationNetworkName
String
vpnID
String
$class: 'CreateConfigurationStep'
templateID
String
templateFile
String
configName
String
configFile
String
$class: 'CreateContainerStep'
configurationID
String
configurationFile
String
vmID
String
vmName
String
containerRegistryName
String
repositoryName
String
containerName
If no name is provided, the container will be named New_Container_[timestamp]
String
containerCommand
If no command is provided, will default to using the command in the image spec (if applicable).
String
exposeAllPorts
boolean
containerSaveFilename
String
$class: 'CreatePublishURLStep'
configurationID
String
configurationFile
String
urlSaveFilename
String
portalName
String
permissionOption
Don't Publish: The Sharing Portal URL will not be available to the user in any way.
View Only: User can view the VM through the Sharing Portal URL. No mouse or keyboard control is allowed, and desktop resizing is disabled.
Use:User can view the VM through the Sharing Portal URL and interact with it using a mouse or keyboard. Desktop resizing is allowed.
Run, Suspend: User can view the VM through the Sharing Portal URL and interact with it using a mouse or keyboard. Desktop resizing is allowed, and the user can also run the machine if it is in a stopped or suspended state.
String
hasPassword
urlPassword
class hudson.util.Secret
$class: 'CreatePublishedServiceStep'
configurationID
String
configurationFile
String
vmID
String
vmName
String
networkName
String
portNumber
String
publishedServiceFile
String
$class: 'CreateTemplateFromConfigurationStep'
configurationID
String
configurationFile
String
templateName
String
templateDescription
String
templateSaveFilename
String
$class: 'DeleteConfigurationStep'
configurationID
String
configurationFile
String
$class: 'DeleteContainerStep'
containerID
String
containerFile
String
$class: 'GetContainerMetaDataStep'
configurationID
String
configurationFile
String
vmID
String
vmName
String
containerName
String
containerDataFile
String
$class: 'ListPublishedURLForConfigurationStep'
configurationID
String
configurationFile
String
urlName
String
urlFile
String
$class: 'ListVMPublishedServiceStep'
configurationID
String
configurationFile
String
vmID
String
vmName
String
networkName
String
portNumber
String
publishedServiceFile
String
$class: 'MergeTemplateIntoConfigurationStep'
configurationID
String
configurationFile
String
templateID
String
templateFile
String
configFile
String
$class: 'NetworkConnectStep'
sourceNetworkConfigurationID
String
targetNetworkConfigurationID
String
sourceNetworkConfigurationFile
String
targetNetworkConfigurationFile
String
sourceNetworkName
String
targetNetworkName
String
$class: 'SleepBuilder'
time
long
$class: 'SmartFrogBuilder'
smartFrogName
String
deployHost
String
hosts
String
sfUserHome
String
sfUserHome2
String
sfUserHome3
String
sfUserHome4
String
sfOpts
String
builderId
String
useAltIni
boolean
sfIni
String
sfScriptSource
$class: 'FileScriptSource'
scriptName
String
scriptPath
String
$class: 'StringScriptSource'
scriptName
String
scriptContent
String
$class: 'SnapshotBuilder'
xStudioPath
String
xStudioLicensePath
String
vagrantBox
String
overwrite
boolean
preInstallScriptPath
String
postSnapshotScriptPath
String
resourceDirectoryPath
String
dependencies
String
snapshotFilesToDelete
String
installScriptSettings
class org.jenkinsci.plugins.spoontrigger.SnapshotBuilder$InstallScriptSettings
startupFileSettings
class org.jenkinsci.plugins.spoontrigger.SnapshotBuilder$StartupFileSettings
$class: 'SnykStepBuilder'
additionalArguments
(optional)
Additional runtime arguments that will be used to invoke the Snyk CLI. See the Snyk CLI help page for more details.
Use the standalone double-dash --
to pass arguments to the build tool invoked by the Snyk CLI. For example:
-- -Pprofile -Dkey=value
for Maven
projects.-- --configuration runtime
for Gradle
projects.-- -Dkey=value
for SBT
projects.String
failOnError
(optional)
Whether the step should fail if Snyk fails to scan the project due to an error. Errors include scenarios like: failing to download Snyk's binaries, improper Jenkins setup, bad configuration and server errors.
boolean
failOnIssues
(optional)
The "When issues are found" selection specifies if builds should be failed or continued based on issues found by Snyk.
The corresponding CLI option for severity parameter: --severity-threshold
boolean
monitorProjectOnBuild
(optional)
Monitor the project on every build by taking a snapshot of its current dependencies on Snyk.io. Selecting this option will keep you notified about newly disclosed vulnerabilities and remediation options in the project.
boolean
organisation
(optional)
The Snyk organisation in which this project should be tested and monitored. Leave empty to use your default organisation.
The corresponding CLI option for this parameter: --org
String
projectName
(optional)
A custom name for the Snyk project created for this Jenkins project on every build. Leave empty for the project's name to be detected in the manifest file.
The corresponding CLI option for this parameter: --project-name
String
severity
(optional)
String
snykInstallation
(optional)
Ensures that the selected version of Snyk tools are installed. In addition, the Snyk tools will be added at the start of the PATH
environment variable during builds.
If no Snyk installations have been defined in the Jenkins system config, then none of the above steps will take place.
String
snykTokenId
(optional)
This needs to be the ID of an existing "Snyk API Token" credential. The token will be used to authenticate with Snyk.
If you prefer to provide the Snyk API Token another way, such using alternative credential bindings, you'll need to provide a SNYK_TOKEN
build environment variable.
String
targetFile
(optional)
The path to the manifest file to be used by Snyk. Leave empty for Snyk to auto-detect the manifest file in the project's root folder.
The corresponding CLI option for this parameter: --file
String
addALMOctaneSonarQubeListener
pushCoverage
(optional)
boolean
pushVulnerabilities
(optional)
boolean
skipWebhookCreation
(optional)
boolean
sonarServerUrl
(optional)
String
sonarToken
(optional)
String
$class: 'SonarRunnerBuilder'
additionalArguments
(optional)
String
installationName
(optional)
String
javaOpts
(optional)
String
jdk
(optional)
String
project
(optional)
String
properties
(optional)
String
sonarScannerName
(optional)
String
task
(optional)
String
$class: 'SoundsBuildTask'
afterDelayMs
String
soundSource
selectedSound
String
value
INTERNAL
, URL
soundUrl
String
$class: 'SparkNotifyBuilder'
disable
boolean
messageType
String
roomList
rName
String
rId
String
messageContent
(optional)
String
credentialsId
(optional)
String
split
splitTask
String
splitName
String
environmentName
String
workspaceName
String
trafficTypeName
String
splitDefinitions
String
whitelistKey
String
treatmentName
String
splitYAMLFile
String
springBoot
selectedIDs
(optional)
String
artifactId
(optional)
String
autocomplete
(optional)
String
bootVersion
(optional)
String
description
(optional)
String
groupId
(optional)
String
javaVersion
(optional)
String
language
(optional)
String
packaging
(optional)
String
projectName
(optional)
String
type
(optional)
String
sseBuild
almServerName
String
almProject
String
credentialsId
String
clientType
String
almDomain
String
runType
String
almEntityId
String
timeslotDuration
String
cdaDetails
(optional)
deploymentAction
String
deployedEnvironmentName
String
deprovisioningAction
String
description
(optional)
String
environmentConfigurationId
(optional)
String
postRunAction
(optional)
String
stackrox
apiToken
(optional)
String
caCertPEM
(optional)
String
enableTLSVerification
(optional)
boolean
failOnCriticalPluginError
(optional)
boolean
failOnPolicyEvalFailure
(optional)
boolean
imageNames
(optional)
String
portalAddress
(optional)
String
osfBuilderSuiteStandaloneSonarLinter
sourcePatterns
(optional)
sourcePattern
String
excludePatterns
excludePattern
String
reportPath
(optional)
String
$class: 'StartBox'
cloud
String
workspace
String
box
String
instance
String
buildStep
String
startET
Configure and start a preconfigured ECU-TEST installation.
Pipeline usagestartET(String toolName) : void
startET(String toolName, String workspaceDir, String settingsDir, int timeout, boolean debugMode, boolean keepInstance, boolean updateUserLibs) : void
ETInstance.start() : void
ETInstance.start(String workspaceDir, String settingsDir, int timeout, boolean debugMode, boolean keepInstance, boolean updateUserLibs) : void
ETInstance.start(Map<String, Object> settings) : void
startET('ECU-TEST')
def instance = ET.installation('ECU-TEST') startET installation: instance.installation, workspaceDir: 'C:\\Data'
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0') instance.start()
def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0' instance.start workspaceDir: 'C:\\Data', settingsDir: 'C:\\Data', timeout: 120, debugMode: true, keepInstance: false, updateUserLibs: true
toolName
String
debugMode
(optional)
boolean
installation
(optional)
name
String
home
String
properties
? extends hudson.tools.ToolProperty<?>
keepInstance
(optional)
boolean
settingsDir
(optional)
String
timeout
(optional)
String
updateUserLibs
(optional)
boolean
workspaceDir
(optional)
String
$class: 'StartGrid'
url
String
cloudTestServerID
String
name
String
timeOut
int
acmStartPipeline
aioProject
(optional)
String
pipeline
(optional)
String
program
(optional)
String
$class: 'StartRSDB'
url
String
cloudTestServerID
String
name
String
timeOut
int
startTS
Configure and start Tool-Server.
Pipeline usagestartTS(String toolName) : void
startTS(String toolName, String toolLibsIniPath, int tcpPort, int timeout, boolean keepInstance) : void
ETInstance.startTS() : void
ETInstance.startTS(String toolLibsIniPath, int tcpPort, int timeout, boolean keepInstance) : void
ETInstance.startTS(Map<String, Object> settings) : void
startTS('ECU-TEST')
def instance = ET.installation('ECU-TEST') startTS installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0') instance.startTS()
def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0' instance.startTS toolLibsIniPath: C:\\ToolLibs.ini, tcpPort: 5017, timeout: 60, keepInstance: false
toolName
String
installation
(optional)
name
String
home
String
properties
? extends hudson.tools.ToolProperty<?>
keepInstance
(optional)
boolean
tcpPort
(optional)
String
timeout
(optional)
String
toolLibsIni
(optional)
String
$class: 'StartTestEnvironment'
url
String
cloudTestServerID
String
name
String
timeOut
int
$class: 'StopBox'
cloud
String
workspace
String
box
String
instance
String
buildStep
String
stopET
Shutdown ECU-TEST.
Pipelines usage:stopET(String toolName) : void
stopET(String toolName, int timeout) : void
ETInstance.stop() : void
ETInstance.stop(int timeout) : void
ETInstance.stop(Map<String, Object> settings) : void
stopET('ECU-TEST')
def instance = ET.installation('ECU-TEST') stopET installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0') instance.stop()
def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0' instance.stop timeout: 60
toolName
String
installation
(optional)
name
String
home
String
properties
? extends hudson.tools.ToolProperty<?>
timeout
(optional)
String
$class: 'StopGrid'
url
String
cloudTestServerID
String
name
String
$class: 'StopRSDB'
url
String
cloudTestServerID
String
name
String
stopTS
Shutdown Tool-Server.
Pipelines usage:stopTS(String toolName) : void
stopTS(String toolName, int timeout) : void
ETInstance.stopTS() : void
ETInstance.stopTS(int timeout) : void
ETInstance.stopTS(Map<String, Object> settings) : void
stopTS('ECU-TEST')
def instance = ET.installation('ECU-TEST') stopTS installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0') instance.stopTS()
def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0' instance.stopTS timeout: 60
toolName
String
installation
(optional)
name
String
home
String
properties
? extends hudson.tools.ToolProperty<?>
timeout
(optional)
String
$class: 'StopTestEnvironment'
url
String
cloudTestServerID
String
name
String
strobeMeasurement
connectionId
String
credentialsId
String
requestType
String
jobName
String
body
(optional)
String
duration
(optional)
String
emailto
(optional)
String
finalAction
(optional)
String
headers
(optional)
String
hlq
(optional)
String
limit
(optional)
String
method
(optional)
String
profileName
(optional)
String
samples
(optional)
String
tags
(optional)
String
transactionId
(optional)
String
url
(optional)
String
$class: 'StudioToolsBuilder'
name
String
operation
String
projectDir
String
outputArchiveFile
String
extendedClassPath
String
overwriteOutput
boolean
TRAPropertyFIle
String
topazSubmitFreeFormJcl
connectionId
String
credentialsId
String
maxConditionCode
String
jcl
String
topazSubmitJclMembers
connectionId
String
credentialsId
String
maxConditionCode
String
jclMember
String
$class: 'SvChangeModeBuilder'
serverName
String
force
boolean
mode
OFFLINE
, SIMULATING
, STAND_BY
, LEARNING
dataModel
selectionType
BY_NAME
, NONE
, DEFAULT
dataModel
String
performanceModel
selectionType
BY_NAME
, NONE
, OFFLINE
, DEFAULT
performanceModel
String
serviceSelection
selectionType
SERVICE
, PROJECT
, ALL_DEPLOYED
, DEPLOY
service
String
projectPath
String
projectPassword
String
$class: 'SvDeployBuilder'
serverName
String
force
boolean
service
String
projectPath
String
projectPassword
String
firstAgentFallback
boolean
$class: 'SvExportBuilder'
serverName
String
force
boolean
targetDirectory
String
cleanTargetDirectory
boolean
serviceSelection
selectionType
SERVICE
, PROJECT
, ALL_DEPLOYED
, DEPLOY
service
String
projectPath
String
projectPassword
String
switchToStandByFirst
boolean
archive
boolean
$class: 'SvUndeployBuilder'
serverName
String
continueIfNotDeployed
boolean
force
boolean
serviceSelection
selectionType
SERVICE
, PROJECT
, ALL_DEPLOYED
, DEPLOY
service
String
projectPath
String
projectPassword
String
SWEAGLEExport
actionName
String
mdsName
String
args
(optional)
String
exporter
(optional)
String
fileLocation
(optional)
String
format
(optional)
String
mapToVariables
(optional)
String
markFailed
(optional)
boolean
showResults
(optional)
boolean
tag
(optional)
String
SWEAGLESnapshot
actionName
String
mdsName
String
description
(optional)
String
markFailed
(optional)
boolean
showResults
(optional)
boolean
tag
(optional)
String
SWEAGLEUpload
actionName
String
fileLocation
String
format
String
nodePath
String
allowDelete
(optional)
Allow Delete If checked will delete any nodes and MDIs that are not part of the upload. If the nodes are included or inherited the nodes and MDIs at points of inclusion will also be deleted unless "Only Parent" is also checked.
boolean
autoRecognize
(optional)
boolean
description
(optional)
String
filenameNodes
(optional)
Create Filename Nodes If checked, nodes will be created for all matching files names in the file location and file data will be placed under file name node.
boolean
identifierWords
(optional)
Identifier Words To make nodes part of an array uniquely identifiable, a comma separated list of 'identifier words' can be added. If no identifierWords are provided, the behavior will default to the identifierWords listed in the find.identity_attributes_discovery.word_list preference
String
markFailed
(optional)
boolean
onlyParent
(optional)
Only Parent This controls if in case the allowDelete flag is set to true if the deletion of nodes and CDIs will only happen at the node itself, or also at any other place where the node is included or in every child node that is inheriting.
boolean
showResults
(optional)
boolean
subDirectories
(optional)
Search Sub-directories If checked sub-directories will also be searched recursively for matching files.
boolean
tag
(optional)
String
withSnapshot
(optional)
Allow Delete If checked will delete any nodes and MDIs that are not part of the upload. In case the nodes are included or inherited, also the nodes and MDIs at points of inclusion will be deleted
Only Parent If checked will delete any nodes and MDIs that are not part of the upload. In case the nodes are included or inherited, also the nodes and MDIs at points of inclusion will be deleted
Store Snapshot. This controls if automatically a snapshot should be created for each of the impacted config data sets by this data upload.
boolean
SWEAGLEValidate
actionName
String
mdsName
String
errMax
(optional)
int
markFailed
(optional)
boolean
noPending
(optional)
boolean
retryCount
(optional)
int
retryInterval
(optional)
int
showResults
(optional)
boolean
stored
(optional)
boolean
warnMax
(optional)
int
$class: 'SyncBuilder'
packageid
String
serverName
String
dbName
String
serverAuth
value
String
username
String
password
class hudson.util.Secret
encryptConnection
boolean
trustServerCertificate
boolean
options
String
dataOptions
String
filter
String
packageVersion
String
isolationLevel
String
updateScript
boolean
sqlChangeAutomationVersionOption
value
Latest
, Specific
specificVersion
String
$class: 'SyncStepBuilder'
packageId
String
server
String
database
String
authenticationType
String
userName
String
password
class hudson.util.Secret
compareOptions
(optional)
String
filterFile
(optional)
String
transactionIsoLvl
(optional)
String
$class: 'SysdigBuilder'
name
String
bailOnFail
(optional)
boolean
bailOnPluginFail
(optional)
boolean
engineCredentialsId
(optional)
String
engineurl
(optional)
String
engineverify
(optional)
boolean
forceScan
(optional)
boolean
inlineScanExtraParams
(optional)
String
inlineScanning
(optional)
boolean
runAsUser
(optional)
String
$class: 'SystemGroovy'
Executes a system groovy script similarly to hudson_url/script. The script is always executed on master.
Predefined variables:
build
AbstractBuild
.
launcher
Launcher
.
listener
BuildListener
.
out
PrintStream
(listener.logger
).
source
$class: 'FileSystemScriptSource'
scriptFile
String
$class: 'StringSystemScriptSource'
script
script
String
sandbox
boolean
classpath
path
String
bindings
(optional)
Define variable bindings (in the properties file format). Specified variables can be addressed from the script.
String
$class: 'TATestRunRegistrationBuildStep'
This step registers new test run with given category and sets the 'dtTestrunID' build variable.
category
String
platform
String
$class: 'TagBuilder'
changeLogFile
(optional)
String
changeLogParameters
(optional)
String
contexts
(optional)
String
credentialsId
(optional)
String
installationName
(optional)
String
labels
(optional)
String
liquibasePropertiesPath
(optional)
String
password
(optional)
String
resourceDirectories
(optional)
String
tag
(optional)
String
url
(optional)
String
username
(optional)
String
tanaguru
name
String
scenario
String
urlToAudit
String
urlTanaguruWebService
String
performanceUnstableMark
int
performanceFailedMark
int
proxy_uri
String
proxy_username
String
proxy_password
String
$class: 'TattletaleBuilder'
inputDirectory
String
outputDirectory
String
testcompletetest
suite
(optional)
String
accessKeyId
(optional)
String
actionOnErrors
(optional)
String
actionOnWarnings
(optional)
String
commandLineArguments
(optional)
String
credentialsId
(optional)
String
executorType
(optional)
String
executorVersion
(optional)
String
generateMHT
(optional)
boolean
launchConfig
(optional)
project
(optional)
String
routine
(optional)
String
tags
(optional)
String
test
(optional)
String
unit
(optional)
String
value
(optional)
String
launchType
(optional)
String
project
(optional)
String
publishJUnitReports
(optional)
boolean
routine
(optional)
String
sessionScreenResolution
(optional)
String
tags
(optional)
String
test
(optional)
String
timeout
(optional)
String
unit
(optional)
String
useActiveSession
(optional)
boolean
useTCService
(optional)
boolean
useTimeout
(optional)
boolean
userName
(optional)
String
userPassword
(optional)
String
$class: 'TelegramBotBuilder'
message
String
$class: 'TelerikAppBuilder'
applicationId
String
accessToken
class hudson.util.Secret
configuration
String
buildSettingsiOS
mobileProvisionIdentifieriOS
String
codesigningIdentityiOS
String
buildSettingsAndroid
codesigningIdentityAndroid
String
buildSettingsWP
boolean
prismaIaC
assetName
String
templateType
String
templateVersion
String
tags
String
failureCriteriaHigh
String
failureCriteriaLow
String
failureCriteriaMedium
String
failureCriteriaOperator
String
$class: 'TerminateBox'
cloud
String
workspace
String
box
String
instance
String
buildStep
String
delete
boolean
cfyTerraform
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deploymentId
(optional)
ID to assign to the created Cloudify deployment. If not provided, one will be randomly generated. You can obtain the deployment ID from the "environment data" output file.
String
echoEnvData
(optional)
If checked, then the created environment's data will be printed to the job's log.
boolean
echoInputs
(optional)
boolean
envDataLocation
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
String
environmentVariables
(optional)
java.util.Map<java.lang.String, java.lang.String>
environmentVariablesAsString
(optional)
YAML/JSON containing environment variables to pass to the Terraform process. The provided string will be expanded for environment variables (${VAR_NAME}
).
String
environmentVariablesFile
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing environment variables to pass to the Terraform process.
String
executable
(optional)
Path, on Cloudify Manager, of the Terraform executable. If omitted, the value of the terraform_executable
Cloudify secret will be used.
String
pluginsDirectory
(optional)
Path, on Cloudify Manager, of Terraform's plugins directory. If omitted, the value of the terraform_plugins_dir
Cloudify secret will be used.
String
storageDirectory
(optional)
Path, on Cloudify Manager, of Terraform's storage directory. If omitted, the value of the terraform_storage_dir
Cloudify secret will be used.
String
templateUrl
(optional)
URL of the Terraform template. May be a ZIP, tar.gz
, or a Git repository.
String
tenant
(optional)
String
variables
(optional)
java.util.Map<java.lang.String, java.lang.Object>
variablesAsString
(optional)
YAML/JSON containing variables to pass to the Terraform template. The provided string will be expanded for environment variables (${VAR_NAME}
).
String
variablesFile
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
String
dotnetTest
dotnet test
command is used to execute unit tests in a given solution. It builds the solution and runs a test host application for each test project in the solution. The test host executes tests in the given project using a test framework, for example: MSTest, NUnit, or xUnit, and reports the success or failure of each test. If all tests are successful, the test runner returns 0 as an exit code; otherwise if any test fails, it returns 1.
blame
(optional)
TestResults/<Guid>/<Guid>_Sequence.xml
that captures the order of tests that were run before the crash.
boolean
blameCrash
(optional)
--blame
.
VSTEST_DUMP_FORCEPROCDUMP
environment variable to 1
.
boolean
blameCrashCollectAlways
(optional)
boolean
blameCrashDumpType
(optional)
--blame-crash
.
String
blameHang
(optional)
boolean
blameHangDumpType
(optional)
full
, mini
, or none
. When none
is specified, the test host is terminated on timeout, but no dump is collected. Implies --blame-hang
.
String
blameHangTimeout
(optional)
--blame
and --blame-hang
.
int
collect
(optional)
String
configuration
(optional)
Debug
, but you can override the build configuration settings in your project.
String
diag
(optional)
*.host_<date>.txt
for the test host log, and *.datacollector_<date>.txt
for the data collector log.
String
filter
(optional)
String
framework
(optional)
dotnet
or a .NET Framework test host for the test binaries. This option only determines which type of host to use. The actual framework version to be used is determined by the runtimeconfig.json of the test project. When not specified, the TargetFramework assembly attribute is used to determine the type of host. When that attribute is stripped from the .dll, the .NET Framework host is used.
String
listTests
(optional)
boolean
logger
(optional)
dotnet test
doesn't accept abbreviations: instead of "console;v=d
", use "console;verbosity=detailed
".
String
noBuild
(optional)
boolean
noRestore
(optional)
boolean
nologo
(optional)
boolean
option
(optional)
String
options
(optional)
String
optionsString
(optional)
String
outputDirectory
(optional)
./bin/<configuration>/<framework>/
. For projects with multiple target frameworks (via the TargetFrameworks
property), you also need to specify a framework when you specify this option. dotnet test
always runs tests from the output directory. You can use AppDomain.BaseDirectory to consume test assets in the output directory.
String
project
(optional)
String
properties
(optional)
java.util.Map<java.lang.String, java.lang.String>
propertiesString
(optional)
String
resultsDirectory
(optional)
TestResults
in the directory that contains the project file.
String
runSettings
(optional)
java.util.Map<java.lang.String, java.lang.String>
runSettingsString
(optional)
RunSettings
values, specified in in Java properties syntax.
String
runtime
(optional)
String
sdk
(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.
String
settings
(optional)
.runsettings
file to use for running the tests. Note that the TargetPlatform
element (x86|x64) has no effect for dotnet test
. To run tests that target x86, install the x86 version of .NET Core. The bitness of the dotnet.exe that is on the path is what will be used for running tests.
String
showSdkInfo
(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.
boolean
shutDownBuildServers
(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).
boolean
specificSdkVersion
(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.
boolean
testAdapterPath
(optional)
.TestAdapter.dll
are inspected. If not specified, the directory of the test .dll is searched.
String
unstableIfWarnings
(optional)
boolean
verbosity
(optional)
String
workDirectory
(optional)
String
$class: 'TestBuilder'
packageid
String
tempServer
value
String
serverName
String
dbName
String
serverAuth
value
String
username
String
password
class hudson.util.Secret
encryptConnection
boolean
trustServerCertificate
boolean
runTestSet
value
String
runOnlyParams
String
generateTestData
sqlgenPath
String
options
String
dataOptions
String
filter
String
packageVersion
String
sqlChangeAutomationVersionOption
value
Latest
, Specific
specificVersion
String
testSource
value
scaproject
, socartifact
projectPath
String
packageid
String
packageVersion
String
$class: 'TestCompositionRunner'
url
String
cloudTestServerID
String
composition
String
deleteOldResults
maxDaysOfResults
int
additionalOptions
String
thresholds
transactionname
String
thresholdname
String
thresholdvalue
String
thresholdid
String
generatePlotCSV
boolean
testFolder
testFile
String
executionConfig
(optional)
timeout
String
stopOnError
boolean
checkTestFile
boolean
recordWarnings
boolean
failFast
(optional)
boolean
packageConfig
(optional)
runTest
boolean
runTraceAnalysis
boolean
parameters
name
String
value
String
outputParameters
name
String
projectConfig
(optional)
execInCurrentPkgDir
boolean
filterExpression
String
jobExecMode
NO_EXECUTION
, SEQUENTIAL_EXECUTION
, PARALLEL_EXECUTION
, SEPARATE_SEQUENTIAL_EXECUTION
, SEPARATE_PARALLEL_EXECUTION
, NO_TESTCASE_EXECUTION
, TEST_GUIDE_EXECUTION
recursiveScan
(optional)
boolean
scanMode
(optional)
PACKAGES_ONLY
, PROJECTS_ONLY
, PACKAGES_AND_PROJECTS
testConfig
(optional)
tbcFile
String
tcfFile
String
forceReload
boolean
loadOnly
boolean
keepConfig
boolean
constants
name
String
value
String
$class: 'TestLinkBuilder'
testLinkName
String
testProjectName
String
testPlanName
String
platformName
String
buildName
String
customFields
String
testPlanCustomFields
String
executionStatusNotRun
boolean
executionStatusPassed
boolean
executionStatusFailed
boolean
executionStatusBlocked
boolean
singleBuildSteps
hudson.tasks.BuildStep
)beforeIteratingAllTestCasesBuildSteps
hudson.tasks.BuildStep
)iterativeBuildSteps
hudson.tasks.BuildStep
)afterIteratingAllTestCasesBuildSteps
hudson.tasks.BuildStep
)transactional
boolean
failedTestsMarkBuildAsFailure
boolean
failIfNoResults
boolean
failOnNotRun
boolean
resultSeekers
$class: 'JUnitCaseClassNameResultSeeker'
includePattern
String
keyCustomField
String
attachJUnitXML
boolean
includeNotes
boolean
$class: 'JUnitCaseNameResultSeeker'
includePattern
String
keyCustomField
String
attachJUnitXML
boolean
includeNotes
boolean
$class: 'JUnitMethodNameResultSeeker'
includePattern
String
keyCustomField
String
attachJUnitXML
boolean
includeNotes
boolean
$class: 'JUnitSuiteNameResultSeeker'
includePattern
String
keyCustomField
String
attachJUnitXML
boolean
includeNotes
boolean
$class: 'TAPFileNameMultiTestPointsResultSeeker'
includePattern
String
keyCustomField
String
attachTAPStream
boolean
attachYAMLishAttachments
boolean
includeNotes
boolean
compareFullPath
boolean
testpointsAsExecutions
boolean
$class: 'TAPFileNameResultSeeker'
includePattern
String
keyCustomField
String
attachTAPStream
boolean
attachYAMLishAttachments
boolean
includeNotes
boolean
compareFullPath
boolean
$class: 'TestNGClassNameResultSeeker'
includePattern
String
keyCustomField
String
attachTestNGXML
boolean
markSkippedTestAsBlocked
boolean
includeNotes
boolean
$class: 'TestNGMethodNameDataProviderNameResultSeeker'
includePattern
String
keyCustomField
String
attachTestNGXML
boolean
markSkippedTestAsBlocked
boolean
dataProviderNameKeyCustomField
String
includeNotes
boolean
$class: 'TestNGMethodNameResultSeeker'
includePattern
String
keyCustomField
String
attachTestNGXML
boolean
markSkippedTestAsBlocked
boolean
includeNotes
boolean
$class: 'TestNGSuiteNameResultSeeker'
includePattern
String
keyCustomField
String
attachTestNGXML
boolean
markSkippedTestAsBlocked
boolean
includeNotes
boolean
$class: 'TestOdysseyBuilder'
jobId
String
projectId
String
minPassPercentage
String
testPackage
testFile
String
executionConfig
(optional)
timeout
String
stopOnError
boolean
checkTestFile
boolean
recordWarnings
boolean
packageConfig
(optional)
runTest
boolean
runTraceAnalysis
boolean
parameters
name
String
value
String
outputParameters
name
String
testConfig
(optional)
tbcFile
String
tcfFile
String
forceReload
boolean
loadOnly
boolean
keepConfig
boolean
constants
name
String
value
String
testProject
testFile
String
executionConfig
(optional)
timeout
String
stopOnError
boolean
checkTestFile
boolean
recordWarnings
boolean
projectConfig
(optional)
execInCurrentPkgDir
boolean
filterExpression
String
jobExecMode
NO_EXECUTION
, SEQUENTIAL_EXECUTION
, PARALLEL_EXECUTION
, SEPARATE_SEQUENTIAL_EXECUTION
, SEPARATE_PARALLEL_EXECUTION
, NO_TESTCASE_EXECUTION
, TEST_GUIDE_EXECUTION
testConfig
(optional)
tbcFile
String
tcfFile
String
forceReload
boolean
loadOnly
boolean
keepConfig
boolean
constants
name
String
value
String
$class: 'TestRunner'
stack
String
branch
String
testNames
String
undeploy
boolean
apiKey
String
$class: 'TestStepBuilder'
packageId
String
serverType
String
server
String
database
String
authenticationType
String
userName
String
password
class hudson.util.Secret
runTestMode
String
runTests
String
compareOptions
(optional)
String
dgenFile
(optional)
String
filterFile
(optional)
String
generateTestData
(optional)
boolean
transactionIsoLvl
(optional)
String
$class: 'TestStudioAPITestBuilder'
apiRunnerPath
(optional)
String
project
(optional)
String
test
(optional)
String
startFrom
(optional)
String
stopAfter
(optional)
String
variable
(optional)
String
dontSaveContexts
(optional)
boolean
testAsUnit
(optional)
boolean
$class: 'TestStudioTestBuilder'
artOfTestRunnerPath
String
testPath
String
settingsPath
String
dateFormat
Letter | Date or Time Component | Presentation | Examples |
---|---|---|---|
G | Era designator | Text | AD |
y | Year | Year | 1996; 96 |
Y | Week year | Year | 2009; 09 |
M/L | Month in year | Month | July; Jul; 07 |
w | Week in year | Number | 27 |
W | Week in month | Number | 2 |
D | Day in year | Number | 189 |
d | Day in month | Number | 10 |
F | Day of week in month | Number | 2 |
E | Day in week | Text | Tuesday; Tue |
u | Day number of week | Number | 1 |
a | Am/pm marker | Text | PM |
H | Hour in day (0-23) | Number | 0 |
k | Hour in day (1-24) | Number | 24 |
K | Hour in am/pm (0-11) | Number | 0 |
h | Hour in am/pm (1-12) | Number | 12 |
m | Minute in hour | Number | 30 |
s | Second in minute | Number | 55 |
S | Millisecond | Number | 978 |
z | Time zone | General time zone | Pacific Standard Time; PST; GMT-08:00 |
Z | Time zone | RFC 822 time zone | -0800 |
X | Time zone | ISO 8601 time zone | -08; -0800; -08:00 |
Input string | Pattern |
---|---|
2001.07.04 AD at 12:08:56 PDT | yyyy.MM.dd G 'at' HH:mm:ss z |
Wed, Jul 4, '01 | EEE, MMM d, ''yy |
12:08 PM | h:mm a |
12 o'clock PM, Pacific Daylight Time | hh 'o''clock' a, zzzz |
0:08 PM, PDT | K:mm a, z |
02001.July.04 AD 12:08 PM | yyyyy.MMMM.dd GGG hh:mm aaa |
Wed, 4 Jul 2001 12:08:56 -0700 | EEE, d MMM yyyy HH:mm:ss Z |
010704120856-0700 | yyMMddHHmmssZ |
2001-07-04T12:08:56.235-0700 | yyyy-MM-dd'T'HH:mm:ss.SSSZ |
2001-07-04T12:08:56.235-07:00 | yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
2001-W27-3 | YYYY-'W'ww-u |
String
projectRoot
(optional)
String
testAsUnit
(optional)
boolean
outputPath
(optional)
String
$class: 'TestSwarmBuilder'
testswarmServerUrl
String
jobName
String
userName
String
authToken
String
maxRuns
String
chooseBrowsers
String
pollingIntervalInSecs
String
timeOutPeriodInMins
String
minimumPassing
String
testSuiteList
testName
String
testUrl
String
testCacheCracker
boolean
disableTest
boolean
testweaver
projectPath
String
experimentName
String
jUnitReportDirectory
String
acceptInconclusiveWatchers
(optional)
boolean
exportAsCsvDecimalSeparator
(optional)
String
exportAsCsvDirectory
(optional)
String
exportAsCsvNoQuote
(optional)
boolean
exportAsCsvQuote
(optional)
String
exportAsCsvReports
(optional)
String
exportAsCsvSeparator
(optional)
String
htmlReportDirectory
(optional)
String
instrumentView
(optional)
boolean
namespacePattern
(optional)
String
parameterValues
(optional)
String
runScenarioLimit
(optional)
int
runTimeLimit
(optional)
long
silverParameters
(optional)
String
$class: 'TesteinRunBuilder'
targetType
String
targetId
String
downloadReport
boolean
downloadLogs
boolean
$class: 'TesteinUploadStepBuilder'
enableJs
jsFilePath
String
jsonFilePath
String
enableJar
jarFilePath
String
overwrite
boolean
$class: 'TestingBotBuilder'
name
String
$class: 'TestiniumPlugin'
projectId
(optional)
int
planId
(optional)
int
abortOnError
(optional)
boolean
abortOnFailed
(optional)
boolean
failOnTimeout
(optional)
boolean
ignoreInactive
(optional)
boolean
timeoutSeconds
(optional)
int
$class: 'TestopiaBuilder'
testopiaInstallationName
String
testRunId
int
singleBuildSteps
hudson.tasks.BuildStep
)beforeIteratingAllTestCasesBuildSteps
hudson.tasks.BuildStep
)iterativeBuildSteps
hudson.tasks.BuildStep
)afterIteratingAllTestCasesBuildSteps
hudson.tasks.BuildStep
)failedTestsMarkBuildAsFailure
boolean
resultSeekers
$class: 'JUnitCaseClassNameResultSeeker'
includePattern
String
$class: 'JUnitCaseNameResultSeeker'
includePattern
String
$class: 'JUnitMethodNameResultSeeker'
includePattern
String
$class: 'JUnitSuiteNameResultSeeker'
includePattern
String
$class: 'TAPFileNameResultSeeker'
includePattern
String
$class: 'TestNGClassNameResultSeeker'
includePattern
String
markSkippedTestAsBlocked
boolean
$class: 'TestNGMethodNameResultSeeker'
includePattern
String
markSkippedTestAsBlocked
boolean
$class: 'TestNGSuiteNameResultSeeker'
includePattern
String
markSkippedTestAsBlocked
boolean
convertTestsToRun
Framework | Linux shell |
Maven Surefire | mvn clean -Dtest=$testsToRunConverted test |
Maven Failsafe | mvn clean -Dit.test=$testsToRunConverted verify |
Gradle | gradle test $testsToRunConverted |
Protractor | protractor conf.js --grep="$testsToRunConverted" |
Cucumber-JVM over Maven/ BDD Scenario |
mvn clean -Dcucumber.options="$testsToRunConverted" test |
JBehave over Maven | mvn clean -Dfeatures="$testsToRunConverted" test |
Framework | Windows batch command |
Maven Surefire | mvn clean -Dtest=%testsToRunConverted% test |
Maven Failsafe | mvn clean -Dit.test=%testsToRunConverted% verify |
Gradle | gradle test %testsToRunConverted% |
Protractor | protractor conf.js --grep="%testsToRunConverted%" |
Cucumber-JVM over Maven/ BDD Scenario |
mvn clean -Dcucumber.options="%testsToRunConverted%" test |
JBehave over Maven | mvn clean -Dfeatures="%testsToRunConverted%" test |
Framework | Pipeline script |
Maven Surefire | bat 'mvn clean -Dtest=${params.testsToRunConverted} test' |
Maven Failsafe | bat 'mvn clean -Dit.test=${params.testsToRunConverted} verify' |
Gradle | bat 'gradle test ${params.testsToRunConverted}' |
Protractor | bat(/protractor conf.js --grep="${params.testsToRunConverted}"/) |
Cucumber-JVM over Maven/ BDD Scenario |
bat(/mvn clean -Dcucumber.options="${params.testsToRunConverted}" test/) |
JBehave over Maven | bat(/mvn clean -Dfeatures="${testsToRunConverted}" test/) |
framework
String
format
{ "testPattern": "$package.$class#$testName", "testDelimiter": "," }
"replacements": [ { "type": "replaceRegex", "target": "$package|$class|$testName", "regex": "aaa", "replacement": "bbb", "description": "Replaces all the sequence of characters matching the regex with a replacement string." },{ "type": "replaceRegexFirst", "target": "$package|$class|$testName", "regex": "aaa", "replacement": "bbb", "description": "Replaces the first substring that matches the given regex with the given replacement. For example, given regex '@(.*)@.*' , replacement '$1', and test name '@myTag@ my test name' - will replace test name by the content located between @, that is - 'myTag'." },{ "type": "replaceString", "target": "$package|$class|$testName", "string": "xxx", "replacement": "yyy", "description": "Replaces all occurrences of ‘string’ with ‘replacement’." },{ "type": "joinString", "target": "$package|$class|$testName", "prefix": "xxx", "suffix": "yyy", "description": "Add prefix and suffix to the test template." },{ "type": "toLowerCase", "target": "$package|$class|$testName", "description": "Convert test template to lower case." },{ "type": "toUpperCase", "target": "$package|$class|$testName", "description": "Convert test template to upper case." },{ "type": "notLatinAndDigitToOctal", "target": "$package|$class|$testName", "description": "Replaces all non-latin characters and digits ^[a-zA-Z0-9] to their ASCII octal value." }]
String
$class: 'TestsigmaExecutionBuilder'
apiEndPoint
String
apiKey
String
testPlanId
String
maxWaitInMinutes
String
reportsFilePath
String
$class: 'TicsAnalyzer'
ticsPath
C:\Program Files (x86)\TIOBE\TICS\BuildServer
. This directory should contain the TICSQServer
and TICSMaintenance
executables. You can leave this field empty if these executables can be found on the PATH environment variable of the Jenkins slave user.String
ticsConfiguration
C:\Program Files (x86)\TIOBE\TICS\FileServer\cfg
. The TICS configuration directory contains the SERVER.txt
and PROJECTS.txt
configuration files, among others. This setting sets the TICS
environment variable before executing TICSQServer
. You can leave this field empty if this variable is already set on the Jenkins slave.String
projectName
TICSMaintenance
from the command line. Note that you can use Jenkins environment variables such as $JOB_NAME
here.String
branchName
String
branchDirectory
TICSMaintenance -branchdir
. Note that you can use Jenkins variables (such as $WORKSPACE
) here.String
environmentVariables
$WORKSPACE
here. Example:
TICS_M2_OPTS=-s C:\Tools\apache-maven\conf\settings.xml TICS_COVERITY_URL=http://localhost:8080 QACBIN=C:/QAC/common/bin PATH=C:\Tools\bin;$PATH
String
createTmpdir
boolean
tmpdir
C:/temp/$JOB_NAME
.String
extraArguments
String
calc
ABSTRACTINTERPRETATION
boolean
ACCUCHANGERATE
boolean
ACCUFIXRATE
boolean
ACCULINESADDED
boolean
ACCULINESCHANGED
boolean
ACCULINESDELETED
boolean
ALL
boolean
AVGCYCLOMATICCOMPLEXITY
boolean
BUILDRELATIONS
boolean
CHANGEDFILES
boolean
CHANGERATE
boolean
CODINGSTANDARD
boolean
COMPILERWARNING
boolean
DEADCODE
boolean
DUPLICATEDCODE
boolean
ELOC
boolean
FANOUT
boolean
FINALIZE
boolean
FIXRATE
boolean
GLOC
boolean
INCLUDERELATIONS
boolean
INTEGRATIONTESTCOVERAGE
boolean
LINESADDED
boolean
LINESCHANGED
boolean
LINESDELETED
boolean
LOC
boolean
MAXCYCLOMATICCOMPLEXITY
boolean
PREPARE
boolean
SECURITY
boolean
SYSTEMTESTCOVERAGE
boolean
TOTALTESTCOVERAGE
boolean
UNITTESTCOVERAGE
boolean
recalc
ABSTRACTINTERPRETATION
boolean
ACCUCHANGERATE
boolean
ACCUFIXRATE
boolean
ACCULINESADDED
boolean
ACCULINESCHANGED
boolean
ACCULINESDELETED
boolean
ALL
boolean
AVGCYCLOMATICCOMPLEXITY
boolean
BUILDRELATIONS
boolean
CHANGEDFILES
boolean
CHANGERATE
boolean
CODINGSTANDARD
boolean
COMPILERWARNING
boolean
DEADCODE
boolean
DUPLICATEDCODE
boolean
ELOC
boolean
FANOUT
boolean
FINALIZE
boolean
FIXRATE
boolean
GLOC
boolean
INCLUDERELATIONS
boolean
INTEGRATIONTESTCOVERAGE
boolean
LINESADDED
boolean
LINESCHANGED
boolean
LINESDELETED
boolean
LOC
boolean
MAXCYCLOMATICCOMPLEXITY
boolean
PREPARE
boolean
SECURITY
boolean
SYSTEMTESTCOVERAGE
boolean
TOTALTESTCOVERAGE
boolean
UNITTESTCOVERAGE
boolean
runTics
projectName
String
branchName
String
branchDirectory
(optional)
String
calc
(optional)
String
environmentVariables
(optional)
java.util.LinkedHashMap<java.lang.String, java.lang.String>
extraArguments
(optional)
String
recalc
(optional)
String
ticsBin
(optional)
String
ticsConfiguration
(optional)
String
tmpdir
(optional)
String
totaltestUT
connectionId
String
credentialsId
String
projectFolder
String
testSuite
Wild carding of test scenarios/suites names can be done using '*' for any characters and '?' for a single character. 'All_Scenarios' can be used to run all test scenarios or 'All_Suites' can be used to run all test suites.
String
jcl
String
ccClearStats
(optional)
boolean
ccDB2
(optional)
boolean
ccPgmType
(optional)
String
ccRepo
(optional)
String
ccSystem
(optional)
String
ccTestId
(optional)
String
deleteTemp
(optional)
boolean
hlq
(optional)
String
hostPort
(optional)
String
recursive
(optional)
boolean
useStubs
(optional)
boolean
totaltest
environmentId
String
folderPath
String
serverUrl
String
serverCredentialsId
String
connectionId
String
credentialsId
String
sonarVersion
(optional)
String
logLevel
(optional)
String
accountInfo
(optional)
Use the accounting information field to enter an account number and any other accounting information that your installation requires.
The accounting information must be entered, just as it would be on the job card. Currently only 52 characters are allowed for the accounting information.
String
ccThreshold
(optional)
int
clearCodeCoverage
(optional)
boolean
collectCCRepository
(optional)
String
collectCCSystem
(optional)
String
collectCCTestID
(optional)
String
collectCodeCoverage
(optional)
boolean
compareJUnits
(optional)
boolean
contextVariables
(optional)
String
createJUnitReport
(optional)
boolean
createReport
(optional)
boolean
createResult
(optional)
boolean
createSonarReport
(optional)
boolean
customerId
(optional)
String
enterpriseDataHostPort
(optional)
String
enterpriseDataWorkspace
(optional)
String
haltAtFailure
(optional)
boolean
haltPipelineOnFailure
(optional)
boolean
jclPath
(optional)
String
jsonFile
(optional)
Use the JSON file field to enter a JSON file containing the tests to execute.
Note: This field is only used for Total Test CLI version 20.04.01 and later
String
localConfig
(optional)
boolean
localConfigLocation
(optional)
String
programList
(optional)
Use the Test list field to enter a comma separated list of program names to be tested. Will only include test scenarios that have component under test defined as one of these
Note: This field is only used for Total Test CLI version 20.04.01 and later
String
recursive
(optional)
boolean
reportFolder
(optional)
String
selectEnvironmentRadio
(optional)
String
selectProgramsOption
(optional)
boolean
selectProgramsRadio
(optional)
String
siteId
(optional)
String
sourceFolder
(optional)
String
stopIfTestFailsOrThresholdReached
(optional)
boolean
uploadToServer
(optional)
boolean
useEnterpriseData
(optional)
boolean
useScenarios
(optional)
boolean
$class: 'ToxBuilder'
toxIni
String
recreate
boolean
toxenvPattern
String
tptExecute
exePaths
String
executionConfiguration
tptFile
String
configuration
String
id
String
enableTest
(optional)
boolean
reportDir
(optional)
String
testSet
(optional)
String
testdataDir
(optional)
String
timeout
(optional)
long
arguments
(optional)
String
enableJunit
(optional)
boolean
isTptMaster
(optional)
boolean
jUnitLogLevel
(optional)
NONE
, ERROR
, WARNING
, INFO
, ALL
jUnitreport
(optional)
String
slaveJob
(optional)
String
slaveJobCount
(optional)
String
slaveJobTries
(optional)
String
tptBindingName
(optional)
String
tptPort
(optional)
String
tptStartUpWaitTime
(optional)
String
tptAgent
exePaths
String
tptBindingName
(optional)
String
tptPort
(optional)
String
tptStartUpWaitTime
(optional)
String
tricentisCI
newTricentisClientPath
String
newEndpoint
String
configurationFilePath
(optional)
Specify the path to the Tricentis CI test execution configuration XML file. The test configuration file includes more details about which items you would like to execute.
If you use this setting, leave the TestEvents setting of this page empty. Otherwise, this build step fails.
String
endpoint
(optional)
Specify the address of the webservice. This component triggers the test execution.
If you execute your tests via Tosca Remote Service, the endpoint needs to point to the TOSCARemoteExecutionService (e.g. http://servername:8732/TOSCARemoteExecutionService/).
If you execute your tests via Tosca Distributed Execution, the endpoint needs to point to the Manager Service of the Tosca Distribution Server (e.g. http://servername:8732/DistributionServerService/ManagerService.svc).
String
testEvents
(optional)
Input the TestEvents that you want to execute, separated by semicolons. You can identify the TestEvents with their name or their system ID.
This field is optional. It can only be used if you execute your tests via Tosca Distributed Execution.
If you use this setting, leave the Configuration File setting of this page empty. Otherwise, this build step fails.
String
tricentisClientPath
(optional)
Specify the path to the Tricentis CI test execution configuration XML file. The test configuration file includes more details about which items you would like to execute.
If you use this setting, leave the TestEvents setting of this page empty. Otherwise, this build step fails.
String
$class: 'TriggerBuilder'
configs
projects
String
block
buildStepFailureThreshold
String
unstableThreshold
String
failureThreshold
String
configFactories
$class: 'AllNodesBuildParameterFactory'
$class: 'AllNodesForLabelBuildParameterFactory'
name
String
nodeLabel
String
ignoreOfflineNodes
boolean
$class: 'BinaryFileParameterFactory'
This implementation does not interpret the contents of those files, and instead it simply gets passed and placed into the workspace of the triggered project(s) under the name specified here.
This is useful, for example, when you have a portion of the job that can be split into concurrently executable subtasks. In such a situation, you can have an earlier step produce subtask work units by packaging necessary stuff into individual files, then use this mode to execute them all in parallel.
parameterName
String
filePattern
String
noFilesFoundAction
SKIP
, NOPARMS
, FAIL
$class: 'CounterBuildParameterFactory'
from
String
to
String
step
String
paramExpr
String
validationFail
FAIL
, SKIP
, NOPARMS
$class: 'CounterGeneratorParameterFactory'
from
String
to
String
step
String
paramExpr
String
validationFail
FAIL
, SKIP
, NOPARMS
$class: 'FileBuildParameterFactory'
filePattern
String
encoding
String
noFilesFoundAction
SKIP
, NOPARMS
, FAIL
$class: 'FileGeneratorParameterFactory'
filePattern
String
noFilesFoundAction
SKIP
, NOPARMS
, FAIL
$class: 'MultipleBinaryFileParameterFactory'
parametersList
class org.jenkinsci.plugins.parallel_test_executor.MultipleBinaryFileParameterFactory$ParameterBinding
noFilesFoundAction
SKIP
, NOPARMS
, FAIL
$class: 'NodeListBuildParameterFactory'
name
String
nodeListString
String
configs
$class: 'BooleanParameters'
configs
name
String
value
boolean
$class: 'CurrentBuildParameters'
$class: 'FileBuildParameters'
propertiesFile
String
encoding
String
failTriggerOnMissing
boolean
useMatrixChild
boolean
combinationFilter
String
onlyExactRuns
boolean
textParamValueOnNewLine
boolean
$class: 'GeneratorCurrentParameters'
$class: 'GitRevisionBuildParameters'
combineQueuedCommits
boolean
$class: 'MatrixSubsetBuildParameters'
filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggered job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String
$class: 'NodeLabelBuildParameter'
name
String
nodeLabel
String
$class: 'NodeParameters'
$class: 'PredefinedBuildParameters'
properties
String
textParamValueOnNewLine
boolean
$class: 'PredefinedGeneratorParameters'
properties
String
$class: 'SubversionRevisionBuildParameters'
includeUpstreamParameters
boolean
$class: 'TwitterPublisher'
tokenCredentialsID
String
consumerCredentialsID
String
tweetText
String
UiPathAssets
assetsAction
AutoVersion
CurrentVersion
DeleteAssets
DeployAssets
Dynamically
jobsCount
int
user
String
machine
String
ExternalApp
accountForApp
String
applicationId
String
applicationSecret
String
applicationScope
String
identityUrl
String
CustomVersion
version
String
NonProduction
Robot
robotsIds
String
Test
TestProject
testProjectPath
String
environments
String
TestSet
testSet
String
Token
credentialsId
String
accountName
String
Unattended
UserPass
credentialsId
String
orchestratorAddress
String
orchestratorTenant
String
folderName
String
credentials
AutoVersion
CurrentVersion
DeleteAssets
DeployAssets
Dynamically
jobsCount
int
user
String
machine
String
ExternalApp
accountForApp
String
applicationId
String
applicationSecret
String
applicationScope
String
identityUrl
String
CustomVersion
version
String
NonProduction
Robot
robotsIds
String
Test
TestProject
testProjectPath
String
environments
String
TestSet
testSet
String
Token
credentialsId
String
accountName
String
Unattended
UserPass
credentialsId
String
filePath
String
traceLevel
None
, Critical
, Error
, Warning
, Information
, Verbose
UiPathPack
version
AutoVersion
CurrentVersion
DeleteAssets
DeployAssets
Dynamically
jobsCount
int
user
String
machine
String
ExternalApp
accountForApp
String
applicationId
String
applicationSecret
String
applicationScope
String
identityUrl
String
CustomVersion
version
String
NonProduction
Robot
robotsIds
String
Test
TestProject
testProjectPath
String
environments
String
TestSet
testSet
String
Token
credentialsId
String
accountName
String
Unattended
UserPass
credentialsId
String
projectJsonPath
String
outputPath
String
traceLevel
None
, Critical
, Error
, Warning
, Information
, Verbose
credentials
(optional)
AutoVersion
CurrentVersion
DeleteAssets
DeployAssets
Dynamically
jobsCount
int
user
String
machine
String
ExternalApp
accountForApp
String
applicationId
String
applicationSecret
String
applicationScope
String
identityUrl
String
CustomVersion
version
String
NonProduction
Robot
robotsIds
String
Test
TestProject
testProjectPath
String
environments
String
TestSet
testSet
String
Token
credentialsId
String
accountName
String
Unattended
UserPass
credentialsId
String
orchestratorAddress
(optional)
String
orchestratorTenant
(optional)
String
outputType
(optional)
String
runWorkflowAnalysis
(optional)
boolean
useOrchestrator
(optional)
boolean
$class: 'UnicornValidationBuilder'
unicornUrl
String
siteUrl
String
maxErrorsForStable
String
maxWarningsForStable
String
maxErrorsForUnstable
String
maxWarningsForUnstable
String
$class: 'UninstallBuilder'
packageId
String
failOnUninstallFailure
boolean
$class: 'Unity3dBuilder'
For projects that use Unity3d as the build system.
This causes Jenkins to invoke the Unity3d Editor with the given command line arguments.
A non-zero exit code from Unity3d makes Jenkins mark the build as a failure.
unity3dName
String
argLine
-quit -batchmode -executeMethod YourEditorScript.YourBuildMethod [-nographics]
or
-quit -batchmode -buildWindowsPlayer path/to/your/build.exe
or
-quit -batchmode -buildOSXPlayer path/to/your/build.app
If this value isn't set, the globalArgLine is used.
Note: we make little to no attempt to detect conflicting arguments or arguments not suitable to the platform neither at configuration nor at runtime.
If the specified command line contains no -projectpath
argument, the plugin automatically adds one with the proper parameter (the workspace of the project on the target machine). This is to make sure unity builds the proper project. Otherwise unity would reuse the last opened project. You can override it, but this hasn't been thoroughly tested.
If your build agent have multiple executors (which you should probably do), it is highly recommended to make use of a -logFile
argument to avoid letting Unityed write to the standard editor.log concurrently. A recommended practise is to use something like -logFile "$WORKSPACE/unity3d_editor.log"
.
See the official Editor command line arguments documentation.
String
unstableReturnCodes
String
unshelve
shelf
String
resolve
String
tidy
boolean
ignoreEmpty
boolean
tpAppUpdateFile
projectId
(optional)
String
appId
(optional)
String
filePath
(optional)
String
tpAppUpdateURL
projectId
(optional)
String
appId
(optional)
String
applicationUrl
(optional)
String
$class: 'UpdateBox'
cloud
String
workspace
String
box
String
variables
String
tpDataSourceUpdate
projectId
(optional)
String
dataSourceId
(optional)
String
filePath
(optional)
String
azureVMSSUpdateInstances
azureCredentialsId
String
resourceGroup
String
name
String
instanceIds
,
'.
String
$class: 'UpdatePriority'
prefix
String
priority
String
$class: 'UpdateProjectBuilder'
tpProjectParamUpdate
projectId
(optional)
String
parameterId
(optional)
String
parameterValue
(optional)
String
$class: 'UpdateReleaseStage'
releasePrefix
String
stage
String
$class: 'UpdateStatus'
prefix
String
status
String
tpTestPackageUpdate
projectId
(optional)
String
testPackageId
(optional)
String
filePath
(optional)
String
resolveConflicts
(optional)
boolean
updraftPublish
url
String
path
String
$class: 'UploadAppBuildStep'
applicationLocation
String
keystoreInfo
keystoreLocation
String
keystorePassword
String
keyAlias
String
keyPassword
String
extraArguments
touchId
boolean
camera
boolean
allowResign
boolean
uuid
String
uniqueName
String
$class: 'UploadAppBuilder'
mcServerName
String
mcUserName
String
mcPassword
String
mcTenantId
String
proxySettings
fsUseAuthentication
boolean
fsProxyAddress
String
fsProxyUserName
String
fsProxyPassword
class hudson.util.Secret
applicationPaths
mcAppPath
String
uploadCloudifyBlueprint
Use this step to upload a blueprint to Cloudify Manager.
Two paramters are mandatory:
In addition, exactly one of the following parameters is mandatory:
If you provide a blueprint's root directory, then the entire directory contents are packaged into a blueprint archive.
archivePath
(optional)
String
archiveUrl
(optional)
String
blueprintId
(optional)
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
mainFileName
(optional)
String
rootDirectory
(optional)
String
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
$class: 'UploadBuild'
tenantId
String
id
String
name
String
versionName
String
revision
String
requestor
String
status
String
startTime
String
endTime
String
appName
String
appId
String
appExtId
String
debug
boolean
fatal
boolean
upload-pgyer
uKey
String
apiKey
String
scanDir
String
wildcard
String
installType
String
password
String
updateDescription
String
channelShortcut
String
qrcodePath
String
envVarsPath
String
upload-pgyer-v2
apiKey
String
scanDir
String
wildcard
String
buildName
String
buildInstallType
String
buildPassword
String
buildUpdateDescription
String
buildChannelShortcut
String
qrcodePath
String
envVarsPath
String
$class: 'UploadDeployment'
id
String
tenantId
String
name
String
result
String
initiator
String
versionName
String
versionExtId
String
type
String
environmentId
String
environmentName
String
description
String
startTime
String
endTime
String
appName
String
appId
String
appExtId
String
debug
boolean
fatal
boolean
$class: 'UploadJUnitTestResult'
properties
java.util.Map<java.lang.String, java.lang.String>
$class: 'UploadMetricsFile'
tenantId
String
name
String
filePath
String
testSetName
String
environment
String
combineTestSuites
boolean
fatal
boolean
debug
boolean
pluginType
String
dataFormat
String
recordName
String
metricDefinitionId
String
metricsRecordUrl
String
description
String
executionDate
String
buildId
String
buildUrl
String
appId
String
appName
String
appExtId
String
uploadProgetPackage
feedName
String
groupName
A string of no more than fifty characters:
String
packageName
A string of no more than fifty characters:
String
version
String
artifacts
Removing Unwanted Folders
Top level folders can be excluded from the package using a custom addition to the Ant fileset - wrapping unwanted folder names in square brackets ([ ]):
String
caseSensitive
(optional)
org.apache.tools.ant.DirectoryScanner
which by default is case sensitive. For instance, if the job produces *.hpi files, pattern "**/*.HPI" will fail to find them.
boolean
defaultExcludes
(optional)
boolean
dependencies
(optional)
String
description
(optional)
String
excludes
(optional)
String
icon
(optional)
String
metadata
(optional)
If you need to add additional metadata, it's strongly recommended that you prefix these properties with an underscore (_) on the off-chance that a property you add will exist in a future version of the specification.
String
title
(optional)
A string of no more than fifty characters
String
uploadCloudifyBlueprint
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
outputLocation
(optional)
String
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
wagonLocation
(optional)
String
yamlLocation
(optional)
plugin.yaml
file of the plugin.
String
$class: 'UpmergeBuilder'
commitUsername
String
uTesterUrlListTask
initialUrl
String
urlsWhiteList
String
rulesList
rule
String
complianceMinimum
float
allowSimultaneousLogins
boolean
loginFlowJson
String
useRunner
boolean
fetchResponseTimeout
int
useMango
useSlaveNodes
String
nodeLabel
String
projectId
String
tags
String
testName
String
testStatus
String
assignedTo
String
vb6
projectFile
String
compileConstants
(optional)
String
outDir
(optional)
String
vCommander
action
$class: 'VCommanderRequestNewServiceAction'
payload
String
sync
boolean
timeout
long
polling
long
$class: 'VCommanderRunWorkflowAction'
targetType
String
targetName
String
workflowName
String
sync
boolean
timeout
long
polling
long
$class: 'VCommanderWaitForRequestNewServiceAction'
requestId
String
timeout
long
polling
long
$class: 'VCommanderWaitForRunWorkflowAction'
taskId
String
timeout
long
polling
long
$class: 'VMGRAPI'
vAPIUrl
String
vAPIUser
String
vAPIPassword
String
vAPIInput
String
vJsonInputFile
String
deleteInputFile
boolean
authRequired
boolean
apiType
String
dynamicUserId
boolean
apiUrl
String
requestMethod
String
advConfig
boolean
connTimeout
int
readTimeout
int
$class: 'VMGRLaunch'
vAPIUrl
String
vAPIUser
String
vAPIPassword
String
vSIFName
String
vSIFInputFile
String
credentialInputFile
String
deleteInputFile
boolean
deleteCredentialInputFile
boolean
useUserOnFarm
boolean
authRequired
boolean
vsifType
String
userFarmType
String
dynamicUserId
boolean
advConfig
boolean
connTimeout
int
readTimeout
int
envVarible
boolean
envVaribleFile
String
inaccessibleResolver
String
stoppedResolver
String
failedResolver
String
doneResolver
String
suspendedResolver
String
waitTillSessionEnds
boolean
stepSessionTimeout
int
generateJUnitXML
boolean
extraAttributesForFailures
boolean
staticAttributeList
String
markBuildAsFailedIfAllRunFailed
boolean
failJobIfAllRunFailed
boolean
envSourceInputFile
String
vMGRBuildArchive
boolean
deleteAlsoSessionDirectory
boolean
genericCredentialForSessionDelete
boolean
archiveUser
String
archivePassword
String
famMode
String
famModeLocation
String
noAppendSeed
boolean
markBuildAsPassedIfAllRunPassed
boolean
failJobUnlessAllRunPassed
boolean
userPrivateSSHKey
boolean
attrValues
boolean
attrValuesFile
String
executionType
String
sessionsInputFile
String
deleteSessionInputFile
boolean
envVariableType
String
envVariableText
String
attrVariableType
String
attrVariableText
String
pauseSessionOnBuildInterruption
boolean
envSourceInputFileType
String
executionScript
String
executionShellLocation
String
executionVsifFile
String
defineVaribleFile
String
defineVarible
boolean
defineVariableType
String
defineVariableText
String
$class: 'VSphereBuildStepContainer'
buildStep
$class: 'Clone'
sourceName
String
clone
String
linkedClone
boolean
resourcePool
String
cluster
String
datastore
String
folder
String
powerOn
boolean
timeoutInSeconds
int
customizationSpec
String
$class: 'ConvertToTemplate'
vm
String
force
boolean
$class: 'ConvertToVm'
template
String
resourcePool
String
cluster
String
$class: 'Delete'
vm
String
failOnNoExist
boolean
$class: 'DeleteSnapshot'
vm
String
snapshotName
String
consolidate
boolean
failOnNoExist
boolean
$class: 'Deploy'
template
String
clone
String
linkedClone
boolean
resourcePool
String
cluster
String
datastore
String
folder
String
customizationSpec
String
timeoutInSeconds
int
powerOn
boolean
$class: 'ExposeGuestInfo'
vm
String
envVariablePrefix
String
waitForIp4
boolean
$class: 'PowerOff'
vm
String
evenIfSuspended
boolean
shutdownGracefully
boolean
ignoreIfNotExists
boolean
gracefulShutdownTimeout
(optional)
int
$class: 'PowerOn'
vm
String
timeoutInSeconds
int
$class: 'Reconfigure'
vm
String
reconfigureSteps
$class: 'ReconfigureAnnotation'
annotation
(optional)
String
append
(optional)
boolean
$class: 'ReconfigureCpu'
cpuCores
String
coresPerSocket
String
$class: 'ReconfigureDisk'
diskSize
String
datastore
String
$class: 'ReconfigureMemory'
memorySize
String
$class: 'ReconfigureNetworkAdapters'
deviceAction
ADD
, EDIT
, REMOVE
deviceLabel
String
macAddress
String
standardSwitch
boolean
portGroup
String
distributedSwitch
boolean
distributedPortGroup
String
distributedPortId
String
$class: 'Rename'
oldName
String
newName
String
$class: 'RenameSnapshot'
vm
String
oldName
String
newName
String
newDescription
String
$class: 'RevertToSnapshot'
vm
String
snapshotName
String
$class: 'SuspendVm'
vm
String
$class: 'TakeSnapshot'
vm
String
snapshotName
String
description
String
includeMemory
boolean
serverName
String
$class: 'VaddyPlugin'
host
String
userId
String
authKey
String
crawlId
String
apiServerUrl
String
proxyHost
String
proxyPort
String
$class: 'VagrantDestroyCommand'
vagrantFile
String
vagrantVm
String
$class: 'VagrantProvisionCommand'
vagrantFile
String
vagrantVm
String
provisioners
String
parallel
boolean
$class: 'VagrantSshCommand'
vagrantFile
String
vagrantVm
String
command
String
asRoot
boolean
$class: 'VagrantUpCommand'
vagrantFile
String
vagrantVm
String
destroyOnError
boolean
provider
String
dontKillMe
boolean
$class: 'ValgrindBuilder'
valgrindExecutable
String
workingDirectory
String
includePattern
String
excludePattern
String
outputDirectory
String
outputFileEnding
String
programOptions
String
tool
$class: 'ValgrindToolHelgrind'
historyLevel
String
$class: 'ValgrindToolMemcheck'
showReachable
boolean
undefinedValueErrors
boolean
leakCheckLevel
String
trackOrigins
boolean
valgrindOptions
String
ignoreExitCode
boolean
traceChildren
boolean
childSilentAfterFork
boolean
generateSuppressions
boolean
suppressionFiles
String
removeOldReports
boolean
crxValidate
packageIdFilters
(optional)
**/*.zipThis pattern will only match packages located directly under the Packages folder whose filenames begin with 'acme-':
Packages/acme-*.zipMatching packages will be validated in the order in which the filters are specified. At least one package must match each filter or the step will fail.
String
allowNonCoveredRoots
(optional)
boolean
forbiddenACHandlingModeSet
(optional)
String
forbiddenExtensions
(optional)
.jar .zipThis field supports parameter tokens.
String
forbiddenFilterRootPrefixes
(optional)
/apps/system
/apps/system/config
/apps/systemOfADown/config
String
localDirectory
(optional)
String
pathsDeniedForInclusion
(optional)
/apps/system/rep:policy /etc/map/http/site_root_redirectUse this test to safeguard specific paths or possible paths within unrestricted roots from overly broad workspace filters.
String
validationFilter
(optional)
/etc # define /etc as the filter root -/etc/packages(/.)? # exclude package pathsThis field supports parameter tokens.
String
$class: 'Validator'
stack
String
branch
String
apiKey
String
contentReplace
configs
(optional)
filePath
String
fileEncoding
String
variablesPrefix
String
variablesSuffix
String
emptyValue
String
configs
name
String
value
String
$class: 'VectorCASTCommand'
winCommand
String
unixCommand
String
$class: 'VectorCASTSetup'
environmentSetupWin
String
environmentSetupUnix
String
executePreambleWin
String
executePreambleUnix
String
environmentTeardownWin
String
environmentTeardownUnix
String
optionUseReporting
boolean
optionErrorLevel
String
optionHtmlBuildDesc
String
optionExecutionReport
boolean
optionClean
boolean
waitLoops
long
waitTime
long
manageProjectName
String
jobName
String
nodeLabel
String
$class: 'ViberNotifier'
token
(optional)
String
sender
(optional)
String
message
(optional)
String
$class: 'ViewCloner'
url
String
replacePatternString
String
niewViewName
String
password
String
username
String
$class: 'VirtualenvBuilder'
pythonName
String
home
String
clear
boolean
systemSitePackages
boolean
nature
String
command
String
ignoreExitCode
boolean
visualexpert
installPath
String
projectName
String
doAnalysis
boolean
createReferenceDocument
boolean
createCodeReviewDocument
boolean
$class: 'VsCodeMetricsBuilder'
toolName
String
files
Assembly file(s) to analyze.
You can specify multiple analyze assemblies by separating them with new-line or space.
Command Line Argument: /file:[ assembly file path ]
String
outputXML
Metrics results XML output file.
Command Line Argument: /out:[ output file path ]
String
directory
Location to search for assembly dependencies.
You can specify multiple directories by separating them with new-line or space.
Command Line Argument: /directory:[ directory ]
String
searchGac
Search the Global Assembly Cache for missing references.
Command Line Argument: /searchgac
boolean
platform
Location of framework assemblies, such as mscorlib.dll.
Command Line Argument: /platform:[ directory ]
String
reference
Reference assemblies required for analysis.
You can specify multiple reference assemblies by separating them with new-line or space.
Command Line Argument: /reference:[ assembly file path ]
String
ignoreInvalidTargets
Silently ignore invalid target files.
Command Line Argument: /ignoreinvalidtargets
boolean
ignoreGeneratedCode
Suppress analysis results against generated code.
Command Line Argument: /ignoregeneratedcode
boolean
cmdLineArgs
String
failBuild
boolean
vsTest
cmdLineArgs
(optional)
String
enablecodecoverage
(optional)
Enables data diagnostic adapter CodeCoverage in the test run.
Default settings are used if not specified using settings file.
Command Line Argument: /Enablecodecoverage
boolean
failBuild
(optional)
boolean
framework
(optional)
Target .NET Framework version to be used for test execution.
Valid values are Framework35, Framework40 and Framework45.
Command Line Argument: /Framework: [ framework version ]
String
inIsolation
(optional)
Runs the tests in an isolated process.
This makes vstest.console.exe process less likely to be stopped on an error in the tests, but tests might run slower.
boolean
logger
(optional)
Specify a logger for test results. For example, to log results into a Visual Studio Test Results File (TRX) use /Logger:trx.
Command Line Argument: /Logger:[ uri/friendlyname ]
String
platform
(optional)
Target platform architecture to be used for test execution.
Valid values are x86, x64 and ARM.
String
settings
(optional)
Run tests with additional settings such as data collectors.
Example: Local.RunSettings
Command Line Argument: /Settings:[ file name ]
String
testCaseFilter
(optional)
Run tests that match the given expression.
<Expression> is of the format <property>=<value>[||<Expression>].
Example: TestCategory=Nightly||Name=Namespace.ClassName.MethodName
The TestCaseFilter command line option cannot be used with the Tests command line option.
Command Line Argument: /TestCaseFilter:[ expression ]
String
testFiles
(optional)
Specify the path to your VSTest compiled assemblies.
You can specify multiple test assemblies by separating them with new-line or space.
String
tests
(optional)
Run tests with names that match the provided values.
To provide multiple values, separate them by commas.
Example: TestMethod1,testMethod2
The /Tests command line option cannot be used with the /TestCaseFilter command line option.
Command Line Argument: /Tests:[ test name ]
String
useVs2017Plus
(optional)
This makes adjustments to the arguments for the sake of compatibility with Visual Studio 2017+.
Command Line Argument: /UseVs2017Plus:true
boolean
useVsixExtensions
(optional)
This makes vstest.console.exe process use or skip the VSIX extensions installed (if any) in the test run.
Command Line Argument: /UseVsixExtensions:true
boolean
vsTestName
(optional)
String
$class: 'WASBuildStep'
additionalClasspath
String
appendTrace
boolean
commands
String
javaOptions
String
jobId
String
language
String
profileScriptFiles
String
propertiesFiles
String
runIf
true
.String
scriptFile
String
scriptParameters
String
traceFile
String
wasServerName
String
user
String
password
String
greet
projectId
String
appPath
String
scriptPath
String
groupId
String
timeout
The timeout of this test run.The default value is 60 minutes.
String
frameType
String
caseTimeout
The timeout of each device running in your test.The default value is 10 minutes.
String
targetOsType
String
$class: 'WakeUpIOSDevice'
url
String
cloudTestServerID
String
additionalOptions
String
$class: 'WallarmFastBuilder'
appHost
String
appPort
String
fastPort
String
fastName
String
policyId
int
testRecordId
int
wallarmApiHost
String
testRunName
String
testRunDesc
String
record
boolean
stopOnFirstFail
boolean
failBuild
boolean
withoutSudo
boolean
localDockerNetwork
String
localDockerIp
String
wallarmVersion
String
fileExtensionsToExclude
String
inactivityTimeout
int
testRunRps
int
wallarmApiToken
(optional)
String
$class: 'WarriorPluginBuilder'
configType
String
gitConfigUrl
String
gitConfigCredentials
boolean
gitConfigTagValue
String
gitConfigCloneType
String
gitConfigUname
String
gitConfigPwd
String
gitConfigFile
String
sftpConfigIp
String
sftpConfigUname
String
sftpConfigPwd
String
sftpConfigFile
String
pythonPath
String
uploadExecLog
boolean
uploadServerIp
String
uploadServerUname
String
uploadServerPwd
String
uploadServerType
String
uploadServerDir
String
runFiles
runFile
String
wattspeed
token
class hudson.util.Secret
projects
int
$class: 'WebLoadAnalyticsBuilder'
inputLsFile
String
portfolioFile
String
format
JUNIT
, HTML
, DOC
, ODT
, XLS
, XLSX
, RTF
, PDF
, CSV
, RAW
location
String
reportName
String
compareToSessions
String
compareToPreviousBuilds
int
$class: 'WebLoadConsoleBuilder'
tplFile
String
lsFile
String
executionDuration
long
virtualClients
long
probindClient
long
$class: 'WildflyBuilder'
war
String
host
String
port
String
username
String
password
String
server
String
$class: 'WinBatchBuildStep'
buildStepId
String
defineArgs
boolean
buildStepArgs
arg
String
$class: 'WinDocksBuilder'
ipaddress
String
image
String
winRMClient
hostName
String
credentialsId
String
winRMOperations
invokeCommand
command
String
sendFile
source
String
destination
String
configurationName
String
$class: 'WixToolsetBuilder'
sources
String
markAsUnstable
boolean
compileOnly
boolean
useUiExt
boolean
useUtilExt
boolean
useBalExt
boolean
useComPlusExt
boolean
useDependencyExt
boolean
useDifxAppExt
boolean
useDirectXExt
boolean
useFirewallExt
boolean
useGamingExt
boolean
useIISExt
boolean
useMsmqExt
boolean
useNetfxExt
boolean
usePsExt
boolean
useSqlExt
boolean
useTagExt
boolean
useVsExt
boolean
msiOutput
Enter a name for the generated MSI/EXE package. If left blank, the MSI package is named setup.msi. You can also use the file ending *.exe. But keep in mind, that you have to create a Bootstrapper and activeate the BalExtension to create an Executable.
You can use environment variables like $GIT_BRANCH to define a package name.
String
arch
String
$class: 'WsapBuilder'
wsapLocation
String
envVar
String
credentialsId
String
targetUrl
String
ipAddress
String
port
int
apiKey
String
sastAnalysis
target
String
dastAnalysis
scanMethod
scan
String
apiUrl
String
apiDefinition
String
includeUrls
$class: 'DASTAnalysis'
$class: 'ExcludeEntry'
url
String
$class: 'HeaderEntry'
header
String
value
String
$class: 'IncludeEntry'
url
String
$class: 'LoginProperties'
useLogin
boolean
loginUrl
String
requestJson
String
usernameField
String
passwordField
String
loggedInRegex
String
loggedOutRegex
String
headers
$class: 'DASTAnalysis'
$class: 'ExcludeEntry'
url
String
$class: 'HeaderEntry'
header
String
value
String
$class: 'IncludeEntry'
url
String
$class: 'LoginProperties'
$class: 'SASTAnalysis'
target
String
$class: 'ScanMethod'
scan
String
apiUrl
String
apiDefinition
String
$class: 'UserEntry'
username
String
password
String
users
$class: 'DASTAnalysis'
$class: 'ExcludeEntry'
url
String
$class: 'HeaderEntry'
header
String
value
String
$class: 'IncludeEntry'
url
String
$class: 'LoginProperties'
$class: 'SASTAnalysis'
target
String
$class: 'ScanMethod'
scan
String
apiUrl
String
apiDefinition
String
$class: 'UserEntry'
username
String
password
String
$class: 'SASTAnalysis'
target
String
$class: 'ScanMethod'
scan
String
apiUrl
String
apiDefinition
String
$class: 'UserEntry'
username
String
password
String
excludeUrls
$class: 'DASTAnalysis'
$class: 'ExcludeEntry'
url
String
$class: 'HeaderEntry'
header
String
value
String
$class: 'IncludeEntry'
url
String
$class: 'LoginProperties'
useLogin
boolean
loginUrl
String
requestJson
String
usernameField
String
passwordField
String
loggedInRegex
String
loggedOutRegex
String
headers
$class: 'DASTAnalysis'
$class: 'ExcludeEntry'
url
String
$class: 'HeaderEntry'
header
String
value
String
$class: 'IncludeEntry'
url
String
$class: 'LoginProperties'
$class: 'SASTAnalysis'
target
String
$class: 'ScanMethod'
scan
String
apiUrl
String
apiDefinition
String
$class: 'UserEntry'
username
String
password
String
users
$class: 'DASTAnalysis'
$class: 'ExcludeEntry'
url
String
$class: 'HeaderEntry'
header
String
value
String
$class: 'IncludeEntry'
url
String
$class: 'LoginProperties'
$class: 'SASTAnalysis'
target
String
$class: 'ScanMethod'
scan
String
apiUrl
String
apiDefinition
String
$class: 'UserEntry'
username
String
password
String
$class: 'SASTAnalysis'
target
String
$class: 'ScanMethod'
scan
String
apiUrl
String
apiDefinition
String
$class: 'UserEntry'
username
String
password
String
loginProperties
useLogin
boolean
loginUrl
String
requestJson
String
usernameField
String
passwordField
String
loggedInRegex
String
loggedOutRegex
String
headers
$class: 'DASTAnalysis'
$class: 'ExcludeEntry'
url
String
$class: 'HeaderEntry'
header
String
value
String
$class: 'IncludeEntry'
url
String
$class: 'LoginProperties'
$class: 'SASTAnalysis'
target
String
$class: 'ScanMethod'
scan
String
apiUrl
String
apiDefinition
String
$class: 'UserEntry'
username
String
password
String
users
$class: 'DASTAnalysis'
$class: 'ExcludeEntry'
url
String
$class: 'HeaderEntry'
header
String
value
String
$class: 'IncludeEntry'
url
String
$class: 'LoginProperties'
$class: 'SASTAnalysis'
target
String
$class: 'ScanMethod'
scan
String
apiUrl
String
apiDefinition
String
$class: 'UserEntry'
username
String
password
String
xcodeBuild
allowFailingBuildResults
(optional)
Checking this option will prevent a build step from failing if xcodebuild exits with a non-zero return code.
This can be useful for build steps that run unit tests and also have a post-build task to publish unit test results: the test step will not fail the entire build for a failing unit test, but will instead mark the build unstable in the "publish test" phase.
boolean
appURL
(optional)
String
assetPackManifestURL
(optional)
String
assetPacksBaseURL
(optional)
String
assetPacksInBundle
(optional)
boolean
buildDir
(optional)
The value to use for the BUILD_DIR setting. You only need to supply this value if you want the product of the Xcode build to be in a location other than the one specified in project settings and this job 'SYMROOT' parameter.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/build
String
buildIpa
(optional)
Checking this option will create a .ipa for each .app found in the build directory.
An .ipa is basically a zipped up .app.
This is quite handy for distributing ad-hoc builds to testers as they can just double-click the .ipa and it will import into iTunes.
boolean
bundleID
(optional)
The new bundle ID. Usually something like com.companyname.projectname.
String
bundleIDInfoPlistPath
(optional)
The path to the info.plist file which contains the CFBundleIdentifier of your project.
Usually something like:
String
cfBundleShortVersionStringValue
(optional)
This will set the CFBundleShortVersionString to the specified string.
Supports all macros and also environment and build variables from the Token Macro Plugin.
String
cfBundleVersionValue
(optional)
This will set the CFBundleVersion to the specified string.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example the value ${BUILD_NUMBER} will be replaced with the current build number.
We advice you to generate a unique value for each build if you want for example deploy it into a private store.
In that case, for example, you can use : ${JOB_NAME}-${BUILD_NUMBER}
String
changeBundleID
(optional)
Checking this option will replace the bundle identifier.
You will need to specify which bundle ID (CFBundleIdentifier) to use and where is the Info.plist file located.
This is handy for example when you want to use a different code signing identity in your development projects.
boolean
cleanBeforeBuild
(optional)
This will delete the build directories before invoking the build. This will force the rebuilding of ALL dependencies and can make large projects take a lot longer.
boolean
cleanResultBundlePath
(optional)
This will delete the ResultBundlePath before invoking the build.
If the directory already exists in the location specified by ResultBundlePath, xcodebuild will be an error and should be checked.
boolean
cleanTestReports
(optional)
boolean
compileBitcode
(optional)
boolean
configuration
(optional)
This is the name of the configuration as defined in the Xcode project.
By default there are Debug and Release configurations.
String
copyProvisioningProfile
(optional)
boolean
developmentTeamID
(optional)
String
developmentTeamName
(optional)
String
displayImageURL
(optional)
String
fullSizeImageURL
(optional)
String
generateArchive
(optional)
Checking this option will create an .xcarchive .app found in the build directory.
An .xcarchive is useful for submission to the app store or third party crash reporters.
You must specify a Scheme to perform an archive.
boolean
ignoreTestResults
(optional)
boolean
interpretTargetAsRegEx
(optional)
Build all entries listed under the "Targets:" section of the xcodebuild -list output that match the regexp.
boolean
ipaExportMethod
(optional)
String
ipaName
(optional)
String
ipaOutputDirectory
(optional)
String
keychainId
(optional)
String
keychainName
(optional)
The name of this configured keychain. Each job will specify a keychain configuration by the name.
String
keychainPath
(optional)
The path of the keychain to use to retrieve certificates to sign the package (default : ${HOME}/Library/Keychains/login.keychain).
String
keychainPwd
(optional)
The password of the keychain to use to retrieve certificates to sign the package.
class hudson.util.Secret
logfileOutputDirectory
(optional)
Specify the directory to output the log of xcodebuild.
If you leave it blank, it will be output to "project directory/builds/${BUILD_NUMBER}/log" with other logs.
If an output path is specified, it is output as a xcodebuild.log file in a relative directory under the "build output directory"
String
manualSigning
(optional)
boolean
noConsoleLog
(optional)
boolean
provideApplicationVersion
(optional)
boolean
provisioningProfiles
(optional)
provisioningProfileAppId
String
provisioningProfileUUID
String
resultBundlePath
(optional)
Specify the directory to output the output the test result.
If you leave it blank, it will not output a test result and will not analyze the test results.
If an output path is specified, it is output as a test result in a relative directory under the "ResultBundlePath".
The plug-in analyzes the test result here and outputs a JUnit compatible XML file under the ${WORKSPACE}/test-reports.
String
sdk
(optional)
You only need to supply this value if you want to specify the SDK to build against. If empty, the SDK will be determined by Xcode. If you wish to run OCUnit tests, you will need to use the iPhone Simulator's SDK, for example:
/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator4.1.sdk/
String
signingMethod
(optional)
String
stripSwiftSymbols
(optional)
boolean
symRoot
(optional)
You only need to supply this value if you want to specify the SYMROOT path to use.
If empty, the default SYMROOT path will be used (it could be different depending of your Xcode version).
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/symroot
String
target
(optional)
The target to build. If left empty, this will build all targets in the project.
If you wish to build your binary and the unit test module, it is best to do this as two separate steps each with their own target.
This was, the iPhone Simulator SDK can be specified for the unit tests.
String
thinning
(optional)
String
unlockKeychain
(optional)
boolean
uploadBitcode
(optional)
boolean
uploadSymbols
(optional)
boolean
useLegacyBuildSystem
(optional)
Instead of "New Builld System" which became available from Xcode 9, we build the application using the legacy build system.
There is a possibility that you can handle old projects that cause problems with the new build system.
Also, since new output formats of logs are changed in the new build system, it is also useful when you want to handle logs with legacy third party tools.
boolean
xcodeName
(optional)
String
xcodeProjectFile
(optional)
String
xcodeProjectPath
(optional)
String
xcodeSchema
(optional)
String
xcodeWorkspaceFile
(optional)
String
xcodebuildArguments
(optional)
Extra xcodebuild parameters, added after the command that jenkins generates based on the rest of the config
String
$class: 'XFramiumBuilder'
configFile
String
suiteName
String
testNames
String
tagNames
String
stepTags
String
deviceTags
String
defaultCloud
String
overrideDefaults
boolean
$class: 'XLRVarSetterBuilder'
XLR_releaseId
String
XLR_varName
String
JKS_varName
String
debug
boolean
osfBuilderSuiteXMLLint
xsdsPath
(optional)
String
xmlsPath
(optional)
String
reportPath
(optional)
String
$class: 'XShellBuilder'
commandLine
String
executeFromWorkingDir
boolean
regexToKill
String
timeAllocated
String
$class: 'XrayExportBuilder'
serverInstance
String
issues
String
filter
String
filePath
String
credentialId
String
fields
(optional)
java.util.Map<java.lang.String, java.lang.String>
xrayInstance
(optional)
configID
String
alias
String
hosting
SERVER
, CLOUD
serverAddress
String
credentialId
String
$class: 'XrayImportFeatureBuilder'
serverInstance
String
folderPath
String
projectKey
String
testInfo
String
preconditions
String
credentialId
String
lastModified
(optional)
String
yarn
command
String
workspaceSubdirectory
(optional)
String
$class: 'ZAPBuilder'
startZAPFirst
boolean
zapHost
String
zapPort
String
zaproxy
autoInstall
boolean
toolUsed
String
zapHome
String
jdk
String
timeout
int
zapSettingsDir
String
autoLoadSession
boolean
loadSession
String
sessionFilename
String
removeExternalSites
boolean
internalSites
String
contextName
String
includedURL
String
excludedURL
String
alertFilters
String
authMode
boolean
username
String
password
String
loggedInIndicator
String
loggedOutIndicator
String
authMethod
String
loginURL
String
usernameParameter
String
passwordParameter
String
extraPostData
String
authScript
String
authScriptParams
scriptParameterName
String
scriptParameterValue
String
targetURL
String
spiderScanURL
boolean
spiderScanRecurse
boolean
spiderScanSubtreeOnly
boolean
spiderScanMaxChildrenToCrawl
int
ajaxSpiderURL
boolean
ajaxSpiderInScopeOnly
boolean
activeScanURL
boolean
activeScanRecurse
boolean
activeScanPolicy
String
generateReports
boolean
selectedReportMethod
String
deleteReports
boolean
reportFilename
String
selectedReportFormats
String
selectedExportFormats
String
exportreportTitle
String
exportreportBy
String
exportreportFor
String
exportreportScanDate
String
exportreportReportDate
String
exportreportScanVersion
String
exportreportReportVersion
String
exportreportReportDescription
String
exportreportAlertHigh
boolean
exportreportAlertMedium
boolean
exportreportAlertLow
boolean
exportreportAlertInformational
boolean
exportreportCWEID
boolean
exportreportWASCID
boolean
exportreportDescription
boolean
exportreportOtherInfo
boolean
exportreportSolution
boolean
exportreportReference
boolean
exportreportRequestHeader
boolean
exportreportResponseHeader
boolean
exportreportRequestBody
boolean
exportreportResponseBody
boolean
jiraCreate
boolean
jiraProjectKey
String
jiraAssignee
String
jiraAlertHigh
boolean
jiraAlertMedium
boolean
jiraAlertLow
boolean
jiraFilterIssuesByResourceType
boolean
cmdLinesZAP
cmdLineOption
String
cmdLineValue
String
zAdviserDownload
connectionId
String
credentialsId
String
jcl
String
encryptedDataFile
String
unencryptedDataFile
String
encryptData
(optional)
boolean
uploadData
(optional)
boolean
zAdviserUpload
connectionId
String
uploadDataFile
String
$class: 'ZOSJobSubmitter'
server
String
port
int
credentialsId
String
wait
boolean
waitTime
int
deleteJobFromSpool
boolean
jobLogToConsole
boolean
jobFile
String
MaxCC
String
JESINTERFACELEVEL1
boolean
FTPActiveMode
boolean
$class: 'ZanataCliBuilder'
projFile
String
syncG2zanata
boolean
syncZ2git
boolean
zanataCredentialsId
String
extraPathEntries
(optional)
String
$class: 'ZanataSyncStep'
zanataCredentialsId
String
pullFromZanata
(optional)
boolean
pushToZanata
(optional)
boolean
syncOption
(optional)
String
zanataLocaleIds
(optional)
String
zanataProjectConfigs
(optional)
String
zanataURL
(optional)
String
$class: 'ZapRunner'
host
String
zapInstallDescription
value
String
path
String
repositoryURL
String
sourcePath
String
zulipSend
message
(optional)
String
stream
(optional)
String
topic
(optional)
String
cfyCloudFormation
awsCredentialsId
(optional)
The ID of the credentials to use when accessing AWS. Parameters' expansion is supported when using freestyle jobs.
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deploymentId
(optional)
ID to assign to the created Cloudify deployment. If not provided, one will be randomly generated. You can obtain the deployment ID from the "environment data" output file.
String
echoEnvData
(optional)
If checked, then the created environment's data will be printed to the job's log.
boolean
echoInputs
(optional)
boolean
envDataLocation
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
String
parameters
(optional)
java.util.Map<java.lang.String, java.lang.Object>
parametersAsString
(optional)
String
parametersFile
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
String
regionName
(optional)
AWS region to use. If not specified, the value of the aws_region_name
secret is used.
String
stackName
(optional)
Name of the new stack.
String
templateBody
(optional)
String
templateBucketName
(optional)
String
templateFile
(optional)
String
templateResourceName
(optional)
String
templateUrl
(optional)
URL of the Terraform template. May be a ZIP, tar.gz
, or a Git repository.
String
tenant
(optional)
String
$class: 'com.alauda.jenkins.plugins.freestyle.CreateStep'
jsonyaml
String
advancedArguments
(optional)
value
String
clusterName
(optional)
String
credentialsId
(optional)
String
logLevel
(optional)
String
project
(optional)
String
$class: 'com.alauda.jenkins.plugins.freestyle.DeleteStep'
advancedArguments
(optional)
value
String
clusterName
(optional)
String
credentialsId
(optional)
String
ignoreNotFound
(optional)
boolean
logLevel
(optional)
String
project
(optional)
String
selector
(optional)
kind
(optional)
String
labels
(optional)
name
String
value
String
names
(optional)
name
String
$class: 'com.alauda.jenkins.plugins.freestyle.RawStep'
command
String
arguments
String
advancedArguments
(optional)
value
String
clusterName
(optional)
String
credentialsId
(optional)
String
logLevel
(optional)
String
project
(optional)
String
$class: 'com.alauda.jenkins.plugins.freestyle.WatchStep'
advancedArguments
(optional)
value
String
clusterName
(optional)
String
credentialsId
(optional)
String
failPattern
(optional)
String
logLevel
(optional)
String
project
(optional)
String
selector
(optional)
kind
(optional)
String
labels
(optional)
name
String
value
String
names
(optional)
name
String
successPattern
(optional)
String
template
(optional)
String
$class: 'com.cloudbees.dockerpublish.DockerBuilder'
repoName
String
buildAdditionalArgs
(optional)
String
buildContext
(optional)
String
createFingerprint
(optional)
boolean
dockerToolName
(optional)
String
dockerfilePath
(optional)
String
forcePull
(optional)
boolean
forceTag
(optional)
boolean
noCache
(optional)
boolean
registry
(optional)
url
https://index.docker.io/v1/
).
String
credentialsId
String
repoTag
(optional)
String
server
(optional)
uri
unix:///var/run/docker.sock
or tcp://127.0.0.1:2376
).
String
credentialsId
String
skipBuild
(optional)
boolean
skipDecorate
(optional)
boolean
skipPush
(optional)
boolean
skipTagLatest
(optional)
boolean
$class: 'com.cloudbees.plugins.deployer.DeployBuilder'
hosts
? extends com.cloudbees.plugins.deployer.hosts.DeployHost<?, ?>
$class: 'com.etas.jenkins.plugins.CreateTextFile.CreateFileBuilder'
textFilePath
String
textFileContent
String
fileOption
String
useWorkspace
boolean
$class: 'com.groupon.jenkinsci.plugins.DotCiFigtemplate.HelloWorldBuilder'
name
String
azureVMSSUpdate
azureCredentialsId
String
resourceGroup
String
name
String
imageReference
id
(optional)
Resource ID or VHD URI of the custom image.
Example Resource ID: /subscriptions/your-subscription-id/resourceGroups/your-resource-group/providers/Microsoft.Compute/images/your-image-name
Example VHD URI: http://your-storage-account.blob.core.windows.net/vhds/your-disk-image.vhd
String
offer
(optional)
String
publisher
(optional)
String
sku
(optional)
String
version
(optional)
String
$class: 'com.openshift.jenkins.plugins.freestyle.CreateStep'
jsonyaml
String
advancedArguments
(optional)
value
String
clusterName
(optional)
String
credentialsId
(optional)
String
logLevel
(optional)
String
project
(optional)
String
$class: 'com.openshift.jenkins.plugins.freestyle.DeleteStep'
advancedArguments
(optional)
value
String
clusterName
(optional)
String
credentialsId
(optional)
String
ignoreNotFound
(optional)
boolean
logLevel
(optional)
String
project
(optional)
String
selector
(optional)
kind
(optional)
String
labels
(optional)
name
String
value
String
names
(optional)
name
String
$class: 'com.openshift.jenkins.plugins.freestyle.RawStep'
command
String
arguments
String
advancedArguments
(optional)
value
String
clusterName
(optional)
String
credentialsId
(optional)
String
logLevel
(optional)
String
project
(optional)
String
$class: 'com.openshift.jenkins.plugins.freestyle.WatchStep'
advancedArguments
(optional)
value
String
clusterName
(optional)
String
credentialsId
(optional)
String
failPattern
(optional)
String
logLevel
(optional)
String
project
(optional)
String
selector
(optional)
kind
(optional)
String
labels
(optional)
name
String
value
String
names
(optional)
name
String
successPattern
(optional)
String
template
(optional)
String
$class: 'com.syncapse.jenkinsci.plugins.awscloudformationwrapper.CloudFormationBuildStep'
stacks
stackName
Name of the stack. The name associated with the stack. The name must be unique within your AWS account. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters. You can pass Environment Variables into this field.
String
description
String
cloudFormationRecipe
String
parameters
The parameters to pass into the recipe. A comma separated list of key/value pairs. ie: key1=value1,key2=value2
You can pass environment variables as values to a stack parameters.
String
timeout
long
awsAccessKey
String
awsSecretKey
String
awsRegion
US_East_Northern_Virginia
, US_WEST_Oregon
, US_WEST_Northern_California
, EU_Ireland
, EU_Frankfurt
, Asia_Pacific_Singapore
, Asia_Pacific_Sydney
, Asia_Pacific_Tokyo
, South_America_Sao_Paulo
sleep
long
$class: 'com.synopsys.integration.jenkins.coverity.extensions.buildstep.CoverityBuildStep'
coverityInstanceUrl
Specify which Synopsys Coverity connect instance to run this job against.
The resulting Synopsys Coverity connect instance URL is stored in the $COV_URL environment variable, and will affect both the full and incremental analysis.
String
onCommandFailure
Specify the action to take if a Coverity static analysis command fails.
String
projectName
Specify the name of the Coverity project.
The resulting project name is stored in the $COV_PROJECT environment variable, and will affect both the full and incremental analysis.
String
streamName
Specify the name of the Coverity stream that you would like to use for the commands.
The resulting stream name is stored in the $COV_STREAM environment variable, and will affect both the full and incremental analysis.
String
checkForIssuesInView
viewName
Specify the name of the Coverity view that you would like to check for issues.
The resulting view name is stored in the $COV_VIEW environment variable, and affects checking for issues in both the full and incremental analysis, if configured.
String
buildStatusForIssues
Specify the build status to set if issues are found in the configured view.
String
configureChangeSetPatterns
changeSetExclusionPatterns
Specify a comma separated list of filename patterns that you would like to explicitly excluded from the Jenkins change set.
The pattern is applied to the $CHANGE_SET environment variable, and will affect which files are analyzed in an incremental analysis (cov-run-desktop).
Examples:
File Name | Pattern | Will be excluded |
---|---|---|
test.java | *.java | Yes |
test.java | *.jpg | No |
test.java | test.* | Yes |
test.java | test.???? | Yes |
test.java | test.????? | No |
String
changeSetInclusionPatterns
Specify a comma separated list of filename patterns that you would like to explicitly included from the Jenkins change set.
The pattern is applied to the $CHANGE_SET environment variable, and will affect which files are analyzed in an incremental analysis (cov-run-desktop).
Examples:
File Name | Pattern | Will be included |
---|---|---|
test.java | *.java | Yes |
test.java | *.jpg | No |
test.java | test.* | Yes |
test.java | test.???? | Yes |
test.java | test.????? | No |
String
coverityRunConfiguration
$class: 'AdvancedCoverityRunConfiguration'
commands
command
Provide the Coverity command you want to run.
The command should start with the name of the Coverity command you want to run. Ex: cov-build, cov-analyze, etc.
For examples and a list of the available environment variables that can be used, refer to the Command Examples documentation
String
$class: 'SimpleCoverityRunConfiguration'
coverityAnalysisType
Specify the way you wish to perform your Coverity analysis.
Each analysis type runs a specific Coverity command with some default arguments, followed by cov-commit-defects with some default arguments. Additional command-specific arguments can be provided below.
Full Analysis:
cov-analyze --dir ${WORKSPACE}/idir
cov-commit-defects --dir ${WORKSPACE}/idir --url ${COV_URL} --stream ${COV_STREAM}
Incremental Analysis:
cov-run-desktop --dir ${WORKSPACE}/idir --url ${COV_URL} --stream ${COV_STREAM} ${CHANGE_SET}
cov-commit-defects --dir ${WORKSPACE}/idir --url ${COV_URL} --stream ${COV_STREAM}
Determined by change set threshold
Will run the commands specified by Full Analysis if the number of files listed in the CHANGE_SET environment variable meets or exceeds the specified threshold, otherwise will run the commands specified by Incremental Analysis.
COV_ANALYZE
, COV_RUN_DESKTOP
, THRESHOLD
sourceArgument
The argument that specifies the source for the given capture type.
For Build, this is the build command to pass to cov-build.
For Buildless Capture (Project) this is the project directory to pass to cov-capture.
For Buildless Capture (SCM) this is the scm url to pass to cov-capture.
String
commandArguments
covBuildArguments
Specify additional arguments to apply to the invocation of the cov-build command. Affects the Build capture type.
Note:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
String
covAnalyzeArguments
Specify additional arguments to apply to the invocation of the cov-analyze command. Affects the Full Analysis analysis type.
Note:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
String
covRunDesktopArguments
Specify additional arguments to apply to the invocation of the cov-run-desktop command. Affects the Incremental Analysis analysis type.
Note:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
String
covCommitDefectsArguments
Specify additional arguments to apply to the invocation of the cov-commit-defects command. Affects all analysis types.
Note:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
String
covCaptureArguments
Specify additional arguments to apply to the invocation of the cov-capture command. Affects the Buildless Capture (Project) and Buildless Capture (SCM) capture types.
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
With the Buildless Capture (Project) capture type, the following arguments are automatically provided:
With the Buildless Capture (SCM) capture type, the following arguments are automatically provided:
String
changeSetAnalysisThreshold
(optional)
For use with the Coverity Analysis Type Determined by change set threshold. Specifies the number of files that triggers a Full Analysis.
Determined by change set threshold will run an Incremental Analysis unless the number of files specified in the $CHANGE_SET environment variable meets or exceeds the value of this field.
If the number of files specified in the $CHANGE_SET environment variable meets or exceeds the value of this field, Determined by change set threshold will run a Full Analysis
int
coverityCaptureType
(optional)
Specify the way you wish to capture your source for Coverity analysis.
Each capture type runs a specific Coverity command with some default arguments. Additional command-specific arguments can be provided below.
Build
cov-build --dir ${WORKSPACE}/idir Source Argument (build command)
Buildless Capture (Project)
cov-capture --project-dir Source Argument (project directory)
Buildless Capture (SCM)
cov-capture --scm-url Source Argument (scm url)
COV_BUILD
, COV_CAPTURE_PROJECT
, COV_CAPTURE_SCM
customWorkingDirectory
(optional)
The fully qualified path to a directory in which to run the cov-build or cov-capture command.
String
cleanUpAction
(optional)
Specify the clean up action to perform on a successful execution.
Will either persist or delete the intermediate directory created by the specified capture type.
PERSIST_INTERMEDIATE_DIRECTORY
, DELETE_INTERMEDIATE_DIRECTORY
credentialsId
(optional)
Specify the credentials to use with the Synopsys Coverity connect instance.
String
overrideDefaultCredentials
(optional)
boolean
$class: 'eggPlantBuilder'
script
Relative to the Execution Directory, specify the script or scripts, separated by commas to execute in the test relative to the workspace directory for this job, for example:
NOTE: To have scripts run against different SUTs, it is necessary to create a build step for each SUT.
String
SUT
String
port
Set the VNC Server port for the SUT, eg. 5900. Leaving this blank will use the default port for VNC, 5900.
String
password
Specifies the password for the VNC server. If there's no password, this field can be left blank.
String
colorDepth
String
globalResultsFolder
OPTIONAL. Specify the path to the global results folder, relative to the workspace.
String
defaultDocumentDirectory
Specify the path to the Default Document Directory, relative to the Execution Directory. See Running Eggplant From the Command Line in the Eggplant documentation
String
params
Parameters to be passed to the script(s). Equivalent to the -params flag when executing from the command line.
String
reportFailures
boolean
commandLineOutput
Pipe eggPlant results out as part of the console output.
boolean
installationName
String
$class: 'iOSAppInstaller'
url
String
cloudTestServerID
String
ipa
String
additionalOptions
String
$class: 'iOSSimulatorLauncher'
url
String
cloudTestServerID
String
app
String
sdk
String
family
String
dotnetRestore
dotnet restore
command uses NuGet to restore dependencies as well as project-specific tools that are specified in the project file. In most cases, you don't need to explicitly use the dotnet restore
command, since a NuGet restore is run implicitly if necessary when you run the following commands:
dotnet restore
explicitly to control when the restore occurs so that they can control network usage. To prevent the implicit NuGet restore, you can use the --no-restore
flag with any of these commands to disable implicit restore.
configfile
(optional)
String
disableParallel
(optional)
boolean
force
(optional)
boolean
forceEvaluate
(optional)
boolean
ignoreFailedSources
(optional)
boolean
lockFilePath
(optional)
String
lockedMode
(optional)
boolean
noCache
(optional)
boolean
noDependencies
(optional)
boolean
packages
(optional)
String
project
(optional)
String
runtime
(optional)
String
runtimes
(optional)
String
runtimesString
(optional)
<RuntimeIdentifiers>
tag in the .csproj file. For a list of Runtime Identifiers (RIDs), see the RID catalog.
String
sdk
(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.
String
showSdkInfo
(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.
boolean
source
(optional)
String
sources
(optional)
String
sourcesString
(optional)
String
specificSdkVersion
(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.
boolean
useLockFile
(optional)
boolean
verbosity
(optional)
String
workDirectory
(optional)
String
dotnetToolRestore
dotnet tool restore
command finds the tool manifest file that is in scope for the current directory and installs the tools that are listed in it. For information about manifest files, see Install a local tool and Invoke a local tool.
additionalSource
(optional)
String
additionalSources
(optional)
String
additionalSourcesString
(optional)
String
configfile
(optional)
String
disableParallel
(optional)
boolean
ignoreFailedSources
(optional)
boolean
noCache
(optional)
boolean
sdk
(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.
String
showSdkInfo
(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.
boolean
specificSdkVersion
(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.
boolean
toolManifest
(optional)
String
verbosity
(optional)
q[uiet]
, m[inimal]
, n[ormal]
, d[etailed]
, and diag[nostic]
.
String
workDirectory
(optional)
String
$class: 'jenkins.plugins.coverity.CoverityBuildStep'
The build step can be configured as any other build steps. Choose the appropriate builder and configure the command to be performed. The configured build step will be wrapped with the Coverity cov-build executables so that it captures the build and can be used to further analysis by using coverity static tools. This build step is only for capturing build of compiled sources.
buildStep
hudson.tasks.BuildStep
)$class: 'org.jenkinsci.plugins.dockerbuildstep.DockerBuilder'
dockerCmd
$class: 'CommitCommand'
containerId
String
repo
String
tag
String
runCmd
String
$class: 'CreateContainerCommand'
image
String
command
String
hostName
String
containerName
String
envVars
String
links
String
exposedPorts
String
cpuShares
String
memoryLimit
String
dns
String
extraHosts
String
networkMode
String
publishAllPorts
This setting corresponds to the --publish-all
(-P
) option of the docker run
CLI command.
boolean
portBindings
--publish
(-p
) option of the docker run
CLI command.
Enter one or more port binding, each on its own line. The syntax is host container
where host
is either hostPort
or hostIp:hostPort
and container
is either containerPort
or containerPort/protocol
.
Alternatively, you can separate host and port with a colon (":"), thus using the same syntax as in the Docker CLI.
Examples
String
bindMounts
--volume
(-v
) option of the docker run
CLI command.
Enter one or more bind mount, each on its own line. The syntax is hostPath containerPath[ rw|ro]
String
privileged
This setting corresponds to the --privileged
option of the docker run
CLI command.
boolean
alwaysRestart
boolean
$class: 'CreateImageCommand'
dockerFolder
String
imageTag
String
dockerFile
String
pull
boolean
noCache
boolean
rm
boolean
buildArgs
String
$class: 'ExecCreateAndStartCommand'
containerIds
String
command
String
$class: 'ExecCreateCommand'
containerIds
String
command
String
$class: 'ExecStartCommand'
commandIds
String
$class: 'KillCommand'
containerIds
String
$class: 'PullImageCommand'
fromImage
String
tag
String
registry
String
dockerRegistryEndpoint
url
https://index.docker.io/v1/
).
String
credentialsId
String
$class: 'PushImageCommand'
image
String
tag
String
registry
String
dockerRegistryEndpoint
url
https://index.docker.io/v1/
).
String
credentialsId
String
$class: 'RemoveAllCommand'
removeVolumes
boolean
force
boolean
$class: 'RemoveCommand'
containerIds
String
ignoreIfNotFound
boolean
removeVolumes
boolean
force
boolean
$class: 'RemoveImageCommand'
imageName
String
imageId
String
ignoreIfNotFound
boolean
$class: 'RestartCommand'
containerIds
String
timeout
int
$class: 'SaveImageCommand'
imageName
String
imageTag
String
destination
String
filename
String
ignoreIfNotFound
boolean
$class: 'StartByImageIdCommand'
imageId
String
$class: 'StartCommand'
containerIds
String
waitPorts
String
containerIdsLogging
String
$class: 'StopAllCommand'
$class: 'StopByImageIdCommand'
imageId
String
$class: 'StopCommand'
containerIds
String
$class: 'TagImageCommand'
image
String
repository
String
tag
String
ignoreIfNotFound
boolean
withForce
boolean
$class: 'org.jenkinsci.plugins.ios.connector.DeployBuilder'
path
String
udid
(We are looking for more ways to let you specify the target device flexibly. Please send in your suggestions.)
String
$class: 'org.jenkinsci.plugins.liquibase.builder.UpdateBuilder'
changeLogFile
(optional)
String
changeLogParameters
(optional)
String
contexts
(optional)
String
credentialsId
(optional)
String
installationName
(optional)
String
labels
(optional)
String
liquibasePropertiesPath
(optional)
String
password
(optional)
String
resourceDirectories
(optional)
String
url
(optional)
String
username
(optional)
String
osfBuilderSuiteForSFCCDeploy
hostname
(optional)
String
tfCredentialsId
(optional)
String
ocCredentialsId
(optional)
String
ocVersion
(optional)
String
buildVersion
(optional)
String
createBuildInfoCartridge
(optional)
boolean
activateBuild
(optional)
boolean
sourcePaths
(optional)
sourcePath
String
excludePatterns
excludePattern
String
tempDirectory
(optional)
String
greet
name
String
useFrench
(optional)
boolean
$class: 'org.quality.gates.jenkins.plugin.QGBuilder'
jobConfigData
class org.quality.gates.jenkins.plugin.JobConfigData
globalConfigDataForSonarInstance
class org.quality.gates.jenkins.plugin.GlobalConfigDataForSonarInstance
$class: 'quality.gates.jenkins.plugin.QGBuilder'
jobConfigData
class quality.gates.jenkins.plugin.JobConfigData
$class: 'vRABlueprintBuildStep'
params
serverUrl
String
userName
String
password
String
tenant
String
packageBlueprint
boolean
blueprintPath
String
overWrite
boolean
publishBlueprint
boolean
serviceCategory
String
$class: 'vRADeploymentBuildStep'
params
serverUrl
String
userName
String
password
String
tenant
String
blueprintName
String
waitExec
boolean
requestTemplate
boolean
requestParams
json
String
$class: 'ConditionalBuilder'
runCondition
$class: 'AlwaysRun'
$class: 'And'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
hudson.tasks.BuildStep
)$class: 'ConfigFileBuildStep'
managedFiles
fileId
Name of the file.
String
replaceTokens
(optional)
Decides whether the token should be replaced using macro.
boolean
targetLocation
(optional)
Name of the file (with optional file relative to workspace directory) where the config file should be copied.
String
variable
(optional)
Name of the variable which can be used as the reference for further configuration.
String
$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
(optional)
String
apiUri
(optional)
String
debugMode
(optional)
ENABLED
, DISABLED
envVarKey
(optional)
String
ignoreGlobalSettings
(optional)
boolean
keyValue
(optional)
String
requestMode
(optional)
READ
, WRITE
, DELETE
timeoutConnection
(optional)
int
timeoutResponse
(optional)
int
assessContainerImage
failOnPluginError
(optional)
boolean
imageId
(optional)
String
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
(optional)
boolean
workspaceDir
(optional)
String
contentReplace
configs
(optional)
filePath
String
fileEncoding
String
configs
search
String
replace
String
matchCount
int
$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
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 the wiki page "How to reference another project by name" for more information.
String
excludes
(optional)
String
filter
(optional)
String
fingerprintArtifacts
(optional)
boolean
flatten
(optional)
boolean
optional
(optional)
boolean
parameters
(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.
String
resultVariableSuffix
(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_ |
String
selector
(optional)
downstream
upstreamProjectName
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).
String
upstreamBuildNumber
String
lastWithArtifacts
lastCompleted
$class: 'MultiJobBuildSelector'
buildParameter
parameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
String
permalink
id
String
$class: 'PromotedBuildSelector'
level
int
latestSavedBuild
specific
buildNumber
String
lastSuccessful
stable
(optional)
boolean
upstream
allowUpstreamDependencies
(optional)
boolean
fallbackToLastSuccessful
(optional)
boolean
upstreamFilterStrategy
(optional)
UseGlobalSetting
, UseOldest
, UseNewest
workspace
target
(optional)
String
copy
dstFile
(optional)
String
keepMeta
(optional)
boolean
recursive
(optional)
boolean
srcFile
(optional)
String
$class: 'CreateBaselineBuilder'
outputFile
Path to the file that should be used to store baseline.
File location must be specified as:
String
inputFileOrFolder
Specify input folder/file for creating baseline. It should depend on input type you have selected.
Folder/file location must be specified as:
String
$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
The identifier of the BuildMaster application to trigger the build for.
Options are:
String
releaseNumber
The BuildMaster release number to trigger the build for. Options are:
The job will fail if there is no active BuildMaster release.
String
deployToFirstStage
(optional)
waitUntilCompleted
boolean
printLogOnFailure
(optional)
boolean
variables
(optional)
Provide a list of variables to pass to the build.
String
$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
(optional)
Unique identifier for the created deployment.
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deploymentId
(optional)
Identifies the blueprint to create a deployment off.
String
echoInputs
(optional)
boolean
echoOutputs
(optional)
boolean
inputs
(optional)
A YAML/JSON containing inputs for the deployment. These inputs will be merged with inputs provided through the " inputs file
" parameter.
String
inputsFile
(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.
String
mapping
(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.
String
mappingFile
(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.
String
outputFile
(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> }
String
skipInstall
(optional)
install
workflow.
boolean
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
$class: 'CreateFingerprint'
Create Fingerprints of specified files during a build process
targets
String
tektonCreateRaw
input
String
inputType
String
clusterName
(optional)
String
enableCatalog
(optional)
boolean
namespace
(optional)
String
$class: 'CreateRelease'
prefix
String
itemPrefix
String
releaseName
String
description
String
stage
String
owner
String
period
String
$class: 'CreateSnapshotBuilder'
outputFile
Path to the file that should be used to store snapshots.
File location must be specified as:
String
inputFileOrFolder
Specify input folder/file for creating snapshot. It should depend on input type you have selected.
Folder/file location must be specified as:
String
createTag
nexusInstanceId
String
tagName
String
tagAttributesJson
(optional)
String
tagAttributesPath
(optional)
String
createTask
artifact
(optional)
String
autoUpgradable
(optional)
boolean
environment
(optional)
String
overrideWithDefaultParameters
(optional)
boolean
parameters
(optional)
String
runtime
(optional)
String
runtimeType
(optional)
String
workspace
(optional)
String
$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: '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.
$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
(optional)
boolean
serverUrl
(optional)
String
username
(optional)
String
password
(optional)
String
isProxy
(optional)
boolean
configAsCode
(optional)
boolean
projectName
(optional)
String
projectId
(optional)
long
groupId
(optional)
String
preset
(optional)
String
jobStatusOnError
(optional)
GLOBAL
, FAILURE
, UNSTABLE
presetSpecified
(optional)
boolean
excludeFolders
(optional)
Conversion is done as follows:
fold1, fold2 fold3
is converted to:
!**/fold1/**/*, !**/fold2/**/*, !**/fold3/**/*,
String
filterPattern
(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").
String
incremental
(optional)
boolean
fullScansScheduled
(optional)
boolean
fullScanCycle
(optional)
int
postScanActionId
(optional)
int
sourceEncoding
(optional)
String
comment
(optional)
String
skipSCMTriggers
(optional)
boolean
waitForResultsEnabled
(optional)
boolean
vulnerabilityThresholdEnabled
(optional)
boolean
highThreshold
(optional)
int
mediumThreshold
(optional)
int
lowThreshold
(optional)
int
osaHighThreshold
(optional)
int
osaMediumThreshold
(optional)
int
osaLowThreshold
(optional)
int
generatePdfReport
(optional)
boolean
enableProjectPolicyEnforcement
(optional)
boolean
thresholdSettings
(optional)
String
vulnerabilityThresholdResult
(optional)
String
avoidDuplicateProjectScans
(optional)
boolean
addGlobalCommenToBuildCommet
(optional)
boolean
generateXmlReport
(optional)
boolean
hideDebugLogs
(optional)
boolean
forceScan
(optional)
boolean
customFields
(optional)
String
dependencyScanConfig
(optional)
SASTUserName
(optional)
String
dependencyScanExcludeFolders
(optional)
String
dependencyScanPatterns
(optional)
String
dependencyScannerType
(optional)
OSA
, SCA
enableScaResolver
(optional)
SCA_RESOLVER
, MANIFEST
fsaVariables
(optional)
String
isExploitablePath
(optional)
boolean
isIncludeSources
(optional)
boolean
osaArchiveIncludePatterns
(optional)
String
osaInstallBeforeScan
(optional)
boolean
overrideGlobalConfig
(optional)
boolean
pathToScaResolver
(optional)
String
sastCredentialsId
(optional)
String
scaAccessControlUrl
(optional)
String
scaConfigFile
(optional)
String
scaCredentialsId
(optional)
String
scaEnvVariables
(optional)
String
scaResolverAddParameters
(optional)
String
scaSASTProjectFullPath
(optional)
String
scaSASTProjectID
(optional)
String
scaSastServerUrl
(optional)
String
scaServerUrl
(optional)
String
scaTeamPath
(optional)
String
scaTenant
(optional)
String
scaTimeout
(optional)
int
scaWebAppUrl
(optional)
String
useJobLevelSastDetails
(optional)
boolean
excludeOpenSourceFolders
(optional)
String
includeOpenSourceFolders
(optional)
String
osaArchiveIncludePatterns
(optional)
String
osaEnabled
(optional)
boolean
osaInstallBeforeScan
(optional)
boolean
thisBuildIncremental
(optional)
boolean
DASTScan
apikey
(optional)
Your API key can be found on the Breachlock Platform under
Organization settings > Integrations > Jenkins
class hudson.util.Secret
asset
(optional)
Select the asset that will be scanned on build.
If the asset you are looking for is missing:
String
email
(optional)
The email-address you registered on Breachlock Platform.
String
osfBuilderSuiteForSFCCDataImport
hostname
(optional)
String
tfCredentialsId
(optional)
String
ocCredentialsId
(optional)
String
ocVersion
(optional)
String
archiveName
(optional)
String
sourcePath
(optional)
String
includePatterns
(optional)
includePattern
String
excludePatterns
(optional)
excludePattern
String
importStrategy
(optional)
String
tempDirectory
(optional)
String
$class: 'DaticalDBBuilder'
daticalDBProjectDir
String
daticalDBServer
String
daticalDBAction
String
daticalDBCmdProject
String
daticalDBExportSQL
String
daticalDBExportRollbackSQL
String
daticalDBScriptDir
String
debianPbuilder
additionalBuildResults
(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.
String
architecture
(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.
String
buildAsTag
(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.
boolean
components
(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.
String
debianDirLocation
(optional)
The location of the debian/ directory, relative to workspace root
This may also be set globally
String
distribution
(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.
String
guessComponents
(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"
boolean
keyring
(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.
String
mirrorSite
(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
String
numberCores
(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.
int
pristineTarName
(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.
String
runAutomationHubBuild
testSuiteId
String
startOnly
(optional)
boolean
userKeyId
(optional)
String
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
(optional)
String
forceEnglishOutput
(optional)
boolean
noServiceEndpoint
(optional)
boolean
packageName
(optional)
String
packageVersion
(optional)
String
sdk
(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.
String
showSdkInfo
(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.
boolean
source
(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
).
String
specificSdkVersion
(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.
boolean
workDirectory
(optional)
String
$class: 'DeleteApplication'
serverName
String
appName
String
domain
String
deleteCloudifyBlueprint
blueprintId
(optional)
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
deleteComponents
nexusInstanceId
String
tagName
String
deleteCloudifyEnv
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deleteBlueprintIfLast
(optional)
If checked, and this is the last environment for the associated blueprint, then also delete the blueprint.
boolean
deploymentId
(optional)
String
ignoreFailure
(optional)
If checked, then failures during the removal of the environment will be ignored.
boolean
skipUninstall
(optional)
uninstall
workflow.
boolean
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
$class: 'DeleteEnvironmentBuilder'
systemId
int
environmentName
String
$class: 'DeleteRaw'
deleteAllStatus
resourceName
String
resourceType
(optional)
String
clusterName
(optional)
String
resourceName
(optional)
String
$class: 'DeleteVirtualizeBuilder'
serverType
String
serverHost
String
serverName
String
dependencyCheck
additionalArguments
(optional)
String
odcInstallation
(optional)
String
skipOnScmChange
(optional)
boolean
skipOnUpstreamChange
(optional)
boolean
$class: 'DeployApplication'
This plugin creates a container on the OpenShift PaaS and deploys the application into the container.
serverName
String
appName
String
cartridges
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:
String
domain
String
gearProfile
String
deploymentPackage
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.
String
environmentVariables
Specify a space delimited list of environment variables (key=value) to be assigned to the application. e.g. LOAD_DATA=true MVN_DEPLOY=true
String
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
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
String
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
template.yaml
app/template.json
String
kmsKeyId
(optional)
String
outputTemplateFile
(optional)
template-#jobId.yaml
by default.
String
parameters
(optional)
key
String
value
String
roleArn
(optional)
String
s3Prefix
(optional)
String
tags
(optional)
key
String
value
String
crxDeploy
packageIdFilters
(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.
String
baseUrls
(optional)
username[:password]@
between the scheme and the hostname.
String
acHandling
(optional)
String
autosave
(optional)
int
behavior
(optional)
String
credentialsId
(optional)
/$username/keys/$fingerprint
.
String
disableForJobTesting
(optional)
boolean
localDirectory
(optional)
String
recursive
(optional)
boolean
replicate
(optional)
boolean
requestTimeout
(optional)
long
serviceTimeout
(optional)
long
waitDelay
(optional)
long
$class: 'DeployPromotionBuilder'
hosts
com.cloudbees.plugins.deployer.hosts.DeployHost<?, ?>
$class: 'DeployScriptBuilder'
out
Specify full path to target connection file.
File location must be specified as:
String
in
Specify path to file that contains SQL script.
File location must be specified as:
String
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
The identifier of the BuildMaster application to trigger the build for.
Options are:
String
releaseNumber
The BuildMaster release number to trigger the build for. Options are:
The job will fail if there is no active BuildMaster release.
String
buildNumber
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.
String
force
(optional)
boolean
printLogOnFailure
(optional)
boolean
stage
(optional)
Optional. If not supplied, the next stage in the pipeline will be used.
String
variables
(optional)
Set deployment level variables.
String
waitUntilCompleted
(optional)
boolean
$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
$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
\[INFO\] Uploading project information for [^\s]* ([^\s]*)
String
description
String
snDevOpsPackage
name
(optional)
String
artifactsPayload
(optional)
String
snDevOpsArtifact
artifactsPayload
(optional)
String
devSpacesCreate
azureCredentialsId
String
aksName
(optional)
String
kubeconfigId
(optional)
String
resourceGroupName
(optional)
String
sharedSpaceName
(optional)
String
spaceName
(optional)
String
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
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" } }
String
deploy
String
undeploy
String
inputFile1
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
String
inputFile2
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
String
activeConfig
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
String
dataFiles
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
String
swaggerurl
String
ramlurl
String
wadlurl
String
tokenCredentialId
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".
String
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
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".
String
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
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
String
tokenCredentialId
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".
String
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
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".
String
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
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".
String
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
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".
String
secured
boolean
importDeveloperProfile
importIntoExistingKeychain
(optional)
boolean
keychainId
(optional)
String
keychainName
(optional)
String
keychainPath
(optional)
String
keychainPwd
(optional)
class hudson.util.Secret
profileId
(optional)
String
$class: 'DiawiUploader'
token
String
fileName
String
proxyHost
String
proxyPort
int
proxyProtocol
String
dingtalk
robot
String
at
(optional)
String
atAll
(optional)
boolean
btnLayout
(optional)
H
, V
btns
(optional)
title
String
actionUrl
String
hideAvatar
(optional)
boolean
messageUrl
(optional)
String
picUrl
(optional)
String
singleTitle
(optional)
String
singleUrl
(optional)
String
text
(optional)
String
title
(optional)
String
type
(optional)
TEXT
, LINK
, MARKDOWN
, ACTION_CARD
$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
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.
String
waitForNodes
Wait for modes in the label which are now occupied by some other builds. This doesn't wait for nodes which are offline
boolean
compileTests
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".
boolean
$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
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
(optional)
boolean
bindPorts
(optional)
String
capabilitiesToAddString
(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.
String
capabilitiesToDropString
(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.
String
cpuPeriod
(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.
long
cpuQuota
(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.
long
cpuShares
(optional)
int
devicesString
(optional)
String
dnsString
(optional)
String
dockerCommand
(optional)
String
environmentsString
(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_SLAVE_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
can be (accidentally) turned into three separate settings:
JENKINS_SLAVE_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
thus preventing the configuration from working as was intended.
String
extraDockerLabelsString
(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:
String
extraGroupsString
(optional)
String
extraHostsString
(optional)
String
hostname
(optional)
String
macAddress
(optional)
String
memoryLimit
(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.
int
memorySwap
(optional)
int
mountsString
(optional)
String
network
(optional)
String
privileged
(optional)
boolean
pullCredentialsId
(optional)
String
securityOptsString
(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.
String
shmSize
(optional)
int
tty
(optional)
boolean
user
(optional)
String
volumesFromString
(optional)
String
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
(optional)
String
javaExe
(optional)
String
jvmArgsString
(optional)
String
user
(optional)
root
") will be used if this is left blank.
String
jnlp
jnlpLauncher
jnlp
tunnel
String
vmargs
String
webSocket
(optional)
boolean
workDirSettings
(optional)
disabled
boolean
workDirPath
String
internalDir
String
failIfWorkDirIsMissing
boolean
entryPointArgumentsString
(optional)
String
jenkinsUrl
(optional)
String
user
(optional)
String
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
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.
String
$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
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.
boolean
$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
(optional)
String
jvmOptions
(optional)
String
launchTimeoutSeconds
(optional)
int
maxNumRetries
(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.
int
port
(optional)
int
prefixStartSlaveCmd
(optional)
String
retryWaitTime
(optional)
int
suffixStartSlaveCmd
(optional)
String
labelString
String
instanceCapStr
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.
String
disabled
(optional)
disabledByChoice
(optional)
boolean
enabledByChoice
(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.
boolean
mode
(optional)
NORMAL
, EXCLUSIVE
name
(optional)
If blank or just whitespace, a default of "docker" will be used.
String
nodeProperties
(optional)
? extends hudson.slaves.NodeProperty<?>
pullStrategy
(optional)
PULL_ALWAYS
, PULL_LATEST
, PULL_NEVER
pullTimeout
(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).
int
remoteFs
(optional)
String
removeVolumes
(optional)
boolean
retentionStrategy
(optional)
Specify the strategy when docker containers shall be started and stopped:
idleMinutes
int
stopTimeout
(optional)
int
$class: 'DockerBuilderPublisher'
dockerFileDirectory
String
fromRegistry
url
https://index.docker.io/v1/
).
String
credentialsId
String
cloud
String
tagsString
String
pushOnSuccess
boolean
pushCredentialsId
String
cleanImages
boolean
cleanupWithJenkinsJobDelete
boolean
noCache
(optional)
--no-cache
which disables caching of layers. See the docker build command for more information.
boolean
pull
(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.
boolean
$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
https://index.docker.io/v1/
).
String
credentialsId
String
image
String
dockerShell
connector
(optional)
$class: 'CloudNameDockerConnector'
cloudName
String
$class: 'DockerConnector'
serverUrl
String
apiVersion
(optional)
String
connectTimeout
(optional)
int
connectorType
(optional)
JERSEY
, NETTY
, OKHTTP
credentialsId
(optional)
String
readTimeout
(optional)
int
containerLifecycle
(optional)
createContainer
(optional)
bindAllPorts
(optional)
boolean
bindPorts
(optional)
String
command
(optional)
String
cpuShares
(optional)
int
cpusetCpus
(optional)
String
cpusetMems
(optional)
String
devicesString
(optional)
String
dnsString
(optional)
String
dockerLabelsString
(optional)
String
entrypoint
(optional)
String
environmentString
(optional)
String
extraHostsString
(optional)
String
hostname
(optional)
String
linksString
(optional)
String
macAddress
(optional)
String
memoryLimit
(optional)
long
networkMode
(optional)
String
privileged
(optional)
boolean
restartPolicy
(optional)
policyName
NO
, UNLESS_STOPPED
, ALWAYS
, ON_FAILURE
maximumRetryCount
int
shmSize
(optional)
long
tty
(optional)
boolean
user
(optional)
String
volumesFromString
(optional)
String
volumesString
(optional)
String
workdir
(optional)
String
image
(optional)
String
pullImage
(optional)
connector
(optional)
$class: 'CloudNameDockerConnector'
cloudName
String
$class: 'DockerConnector'
serverUrl
String
apiVersion
(optional)
String
connectTimeout
(optional)
int
connectorType
(optional)
JERSEY
, NETTY
, OKHTTP
credentialsId
(optional)
String
readTimeout
(optional)
int
credentialsId
(optional)
String
pullStrategy
(optional)
PULL_ALWAYS
, PULL_ONCE
, PULL_LATEST
, PULL_NEVER
registriesCreds
(optional)
registryAddr
String
credentialsId
String
removeContainer
(optional)
force
(optional)
boolean
removeVolumes
(optional)
boolean
stopContainer
(optional)
connector
(optional)
$class: 'CloudNameDockerConnector'
cloudName
String
$class: 'DockerConnector'
serverUrl
String
apiVersion
(optional)
String
connectTimeout
(optional)
int
connectorType
(optional)
JERSEY
, NETTY
, OKHTTP
credentialsId
(optional)
String
readTimeout
(optional)
int
timeout
(optional)
int
executorScript
(optional)
String
longConnector
(optional)
$class: 'CloudNameDockerConnector'
cloudName
String
$class: 'DockerConnector'
serverUrl
String
apiVersion
(optional)
String
connectTimeout
(optional)
int
connectorType
(optional)
JERSEY
, NETTY
, OKHTTP
credentialsId
(optional)
String
readTimeout
(optional)
int
shellScript
(optional)
String
$class: 'DoktorStep'
server
String
markdownIncludePatterns
value
String
markdownExcludePatterns
value
String
asciidocIncludePatterns
value
String
asciidocExcludePatterns
value
String
$class: 'DotNetCoreRunner'
targetCode
//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);
String
additionalPackages
String
downloadProgetPackage
Download options are:
See Inedo documentation.
feedName
String
groupName
String
packageName
String
version
String
downloadFormat
String
downloadFolder
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}
String
crxDownload
packageIds
(optional)
String
baseUrl
(optional)
username[:password]@
between the scheme and the hostname.
String
credentialsId
(optional)
/$username/keys/$fingerprint
.
String
ignoreErrors
(optional)
boolean
localDirectory
(optional)
String
rebuild
(optional)
boolean
requestTimeout
(optional)
long
serviceTimeout
(optional)
long
waitDelay
(optional)
long
googleStorageDownload
credentialsId
String
bucketUri
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
.
String
localDirectory
The local directory that will store the downloaded files. The path specified is considered relative to the build's workspace. Example value:
String
pathPrefix
(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.
String
$class: 'DoxygenBuilder'
doxyfilePath
String
installationName
String
continueOnBuildFailure
boolean
unstableIfWarnings
boolean
$class: 'DrMemoryBuilder'
executable
String
arguments
String
logPath
String
treatFailed
boolean
$class: 'DropAllBuilder'
changeLogFile
(optional)
String
changeLogParameters
(optional)
String
contexts
(optional)
String
credentialsId
(optional)
String
installationName
(optional)
String
labels
(optional)
String
liquibasePropertiesPath
(optional)
String
password
(optional)
String
resourceDirectories
(optional)
String
url
(optional)
String
username
(optional)
String
$class: 'DrupalInstanceBuilder'
db
String
root
String
profile
String
refresh
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.
boolean
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
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.
String
ignoresPass
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.
boolean
$class: 'DrupalTestsBuilder'
uri
String
root
String
logs
String
exceptGroups
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.
String
exceptClasses
Specify Simpletest classes that should not be tested, for instance 'UserLoginTestCase'.
Multiple classes can be separated by a comma.
String
$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: 'ElasticsearchQueryBuilder'
query
String
aboveOrBelow
String
threshold
long
since
long
units
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
(optional)
String
clearWorkspace
(optional)
boolean
javaOpts
(optional)
String
logging
(optional)
boolean
loglevelLibCtrl
(optional)
String
loglevelTestCtrl
(optional)
String
loglevelTestLogic
(optional)
String
pathExecutionFile
(optional)
String
pathPCode
(optional)
String
pdfMeasureImages
(optional)
boolean
pdfReport
(optional)
boolean
pdfReportTemplate
(optional)
String
pdfSelectFilter
(optional)
String
reportPrefix
(optional)
String
testrunFilter
(optional)
name
String
value
String
adminCases
boolean
activateTestcases
boolean
timeout
(optional)
int
examTest_Model
examName
String
pythonName
String
examReport
String
executionFile
(optional)
String
systemConfiguration
(optional)
String
clearWorkspace
(optional)
boolean
examModel
(optional)
String
javaOpts
(optional)
String
logging
(optional)
boolean
loglevelLibCtrl
(optional)
String
loglevelTestCtrl
(optional)
String
loglevelTestLogic
(optional)
String
modelConfiguration
(optional)
String
pdfMeasureImages
(optional)
boolean
pdfReport
(optional)
boolean
pdfReportTemplate
(optional)
String
pdfSelectFilter
(optional)
String
reportPrefix
(optional)
String
testrunFilter
(optional)
name
String
value
String
adminCases
boolean
activateTestcases
boolean
timeout
(optional)
int
$class: 'ExeBuilder'
exeName
String
cmdLineArgs
String
failBuild
boolean
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
(optional)
String
additionalParameters
(optional)
java.util.Map<java.lang.String, java.lang.Object>
failOnMissingPlugin
(optional)
boolean
failOnSeedCollision
(optional)
boolean
ignoreExisting
(optional)
boolean
ignoreMissingFiles
(optional)
boolean
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
(optional)
boolean
scriptText
(optional)
String
targets
(optional)
Scripts are executed in the same order as specified. The execution order of expanded wildcards is unspecified.
String
unstableOnDeprecation
(optional)
boolean
useScriptText
(optional)
boolean
$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
apiKey
String
serverUrl
String
projectId
String
planId
String
execMan
requestType
(optional)
String
altEMConfig
(optional)
url
String
credentials
String
bookmark
(optional)
name
String
folder
(optional)
String
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
(optional)
String
fileEncoding
(optional)
String
filterFile
(optional)
String
ignoreError
(optional)
boolean
transactionIsoLvl
(optional)
String
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
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deploymentId
(optional)
String
executionParameters
(optional)
Parameters to pass to the execution, in YAML/JSON format.
String
printLogs
(optional)
boolean
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
waitForCompletion
(optional)
boolean
workflowId
(optional)
The ID of the workflow to execute.
String
$class: 'ExecutorBuildStep'
frameworkType
String
runningType
String
app
String
testApplication
String
deviceQueries
Other field that can be used:
String
runTags
String
executorOptions
maxDevices
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.
int
minDevices
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.
int
ignoreTestsFile
String
overallExecTimeout
int
creationTimeout
int
exportIpa
appURL
(optional)
String
archiveDir
(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
String
assetPackManifestURL
(optional)
String
compileBitcode
(optional)
boolean
copyProvisioningProfile
(optional)
boolean
developmentTeamID
(optional)
String
developmentTeamName
(optional)
String
displayImageURL
(optional)
String
fullSizeImageURL
(optional)
String
ipaExportMethod
(optional)
String
ipaName
(optional)
String
ipaOutputDirectory
(optional)
String
keychainId
(optional)
String
keychainName
(optional)
String
keychainPath
(optional)
String
keychainPwd
(optional)
class hudson.util.Secret
manualSigning
(optional)
boolean
packResourcesAsset
(optional)
boolean
provisioningProfiles
(optional)
provisioningProfileAppId
String
provisioningProfileUUID
String
resourcesAssetURL
(optional)
String
signingMethod
(optional)
String
stripSwiftSymbols
(optional)
boolean
symRoot
(optional)
String
thinning
(optional)
String
unlockKeychain
(optional)
boolean
uploadBitcode
(optional)
boolean
uploadSymbols
(optional)
boolean
xcodeName
(optional)
String
xcodeProjectPath
(optional)
String
xcodeSchema
(optional)
String
xcodeWorkspaceFile
(optional)
String
exportPackages
exportConfigs
(optional)
$class: 'ExportPackageAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ExportPackageConfig'
filePath
String
exportPath
String
createNewPath
boolean
credentialsId
String
timeout
String
$class: 'ExportProjectAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ExportProjectConfig'
filePath
String
exportPath
String
createNewPath
boolean
credentialsId
String
timeout
String
$class: 'ImportPackageAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ImportPackageConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ImportPackageDirConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ImportProjectArchiveConfig'
tmsPath
String
importPath
String
importConfigPath
String
replaceFiles
boolean
$class: 'ImportProjectAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ImportProjectConfig'
tmsPath
String
importPath
String
importMissingPackages
boolean
credentialsId
String
timeout
String
$class: 'ImportProjectDirConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ExportParametersBuilder'
filePath
String
fileFormat
String
keyPattern
String
useRegexp
boolean
exportProjects
exportConfigs
(optional)
$class: 'ExportPackageAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ExportPackageConfig'
filePath
String
exportPath
String
createNewPath
boolean
credentialsId
String
timeout
String
$class: 'ExportProjectAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ExportProjectConfig'
filePath
String
exportPath
String
createNewPath
boolean
credentialsId
String
timeout
String
$class: 'ImportPackageAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ImportPackageConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ImportPackageDirConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ImportProjectArchiveConfig'
tmsPath
String
importPath
String
importConfigPath
String
replaceFiles
boolean
$class: 'ImportProjectAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ImportProjectConfig'
tmsPath
String
importPath
String
importMissingPackages
boolean
credentialsId
String
timeout
String
$class: 'ImportProjectDirConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ExporterBuilder'
$class: 'ExtensiveTestingBuilder'
testPath
String
login
String
password
String
serverUrl
String
projectName
String
debug
boolean
downloadFeatureFiles
serverAddress
String
projectKey
String
targetPath
String
featureManagementConfig
credentialsId
String
applicationIdAndName
String
environmentIdAndName
String
$class: 'FeedStatus'
prefix
String
status
String
$class: 'FigletBuilder'
message
String
fileOperations
fileOperations
fileCopyOperation
includes
String
excludes
String
targetLocation
String
flattenFiles
boolean
renameFiles
boolean
sourceCaptureExpression
String
targetNameExpression
String
fileCreateOperation
fileName
String
fileContent
String
fileDeleteOperation
includes
String
excludes
String
fileDownloadOperation
url
String
userName
String
password
String
targetLocation
String
targetFileName
String
proxyHost
String
proxyPort
String
fileJoinOperation
sourceFile
String
targetFile
String
filePropertiesToJsonOperation
sourceFile
String
targetFile
String
fileRenameOperation
source
String
destination
String
fileTransformOperation
includes
String
excludes
String
fileUnTarOperation
filePath
String
targetLocation
String
isGZIP
boolean
fileUnZipOperation
filePath
String
targetLocation
String
fileZipOperation
folderPath
String
outputFolderPath
String
folderCopyOperation
sourceFolderPath
String
destinationFolderPath
String
folderCreateOperation
folderPath
String
folderDeleteOperation
folderPath
String
folderRenameOperation
source
String
destination
String
$class: 'FireLineBuilder'
fireLineTarget
csp
If you select "Yes", this plugin will set the following content of CSP to allow access to HTML with JS or CSS.
sandbox allow-scripts; default-src *; style-src * http://* 'unsafe-inline' 'unsafe-eval'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'
Warning:
There is a security risk if you select "Yes".
boolean
blockBuild
If there are some questions of block level detected from your project,FireLine plugin will make build fail when you select "Yes".
boolean
configuration
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<fireline>
<args>
<!-- 序号对应的规则种类,用加号+相连
1:代码规范类
2:内存类
3:日志类
4:安全类
5:空指针
6:多线程
-->
<scanTypes>1+2+4+5+6</scanTypes>
<!--以上写法过滤了日志类的所有规则-->
<!--以下为过滤掉指定的单条规则,请加QQ群298228528获取规则名称-->
<filterRules>
<!--<filterRule ruleName="LogOnOffRule" />
<filterRule ruleName="LogBlockRule" />
<filterRule ruleName="LogAssignmentRule" />-->
</filterRules>
<!--过滤掉你不想检查的文件(注意:重复代码检查不支持过滤)-->
<filterFiles>
<!--过滤单个文件-->
<!--<filterFile Name="R.java"/>-->
<!--过滤整个文件夹-->
<!--<filterFile Name="/facebook/"/>-->
</filterFiles>
</args>
</fireline>
以上配置文件去掉了日志类的规则,所以火线扫描过程中就不会执行日志类规则的检查。
String
reportPath
String
reportFileName
String
buildWithParameter
可通过配置使用build with parameter插件,在项目构建时灵活使用火线扫描。
例如:在项目配置中设置参数化构建参数。配置boolean类型参数fireline。
则在此输入框中填写${fireline}即可
String
jdk
JDK to be used for this FireLine analysis.
Tips:
JDK1.7 or 1.8 is compatible with FireLine.
String
jvm
合理设置JVM参数可以有效提高扫描效率,建议JVM最低配置如下:
"-Xms1g -Xmx1g -XX:MaxPermSize=512m"
String
$class: 'FitnesseBuilder'
options
java.util.Map<java.lang.String, java.lang.String>
$class: 'FixResultBuilder'
defaultResultName
String
success
String
unstable
String
failure
String
aborted
String
flywayrunner
installationName
String
flywayCommand
String
url
String
locations
String
commandLineArgs
String
credentialsId
String
$class: 'FogbugzLinkBuilder'
frugalTesting
userId
String
testId
String
runTag
String
getJtl
boolean
serverUrl
(optional)
String
$class: 'FtpRenameBuilder'
ftpServer
String
ftpPort
if you don't specify the port, the default port is 21.
int
ftpUser
String
ftpPassword
class hudson.util.Secret
ftpPath
Specify the path to your artifact.
String
artifactName
(optional)
String
newArtifactName
(optional)
String
remoteDirectory
(optional)
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder won't be created if does not exist.
String
$class: 'FuzzBuildStep'
configurationFilePath
The file path where the test configuration file (*.set or *.testplan) for this job can be found, relative to the project's workspace.
A test configuration file defines what kind of testing is to be done, and can be created using Defensics. Configure a test suite in Defensics and save the settings file in File -> Save Settings.
String
configurationOverrides
(optional)
Additional test configuration settings that override the settings saved in the test configuration file. This can be useful if, for example, the test target address needs to be set dynamically.
The available settings are the same as the Defensics command line settings. Each setting should follow the format '--setting-name value'. Multiple settings are separated with spaces.
Example for HTTP Server Test Suite:
--uri https://example.com --http-status-filter "1xx 2xx 3xx"
String
defensicsInstance
(optional)
String
saveResultPackage
(optional)
boolean
$class: 'FxCopBuilder'
toolName
String
files
Assembly file(s) to analyze.
You can specify multiple analyze assemblies by separating them with new-line or space.
Command Line Argument: /file:[ file/directory ]
String
outputXML
FxCop project or XML report output file.
Command Line Argument: /out:[ output file path ]
String
ruleSet
Rule set to be used for the analysis.
Command Line Argument: /ruleset:=[ Rule set file path ]
String
ignoreGeneratedCode
Suppress analysis results against generated code.
Command Line Argument: /ignoregeneratedcode
boolean
forceOutput
Write output XML and project files even in the case where no violations occurred.
Command Line Argument: /forceoutput
boolean
cmdLineArgs
String
failBuild
boolean
$class: 'GCloudSDKBuilder'
command
String
$class: 'GCloudSDKWithAuthBuilder'
credentialsId
String
command
String
$class: 'GatekeeperCommit'
commitUsername
String
$class: 'GatekeeperMerge'
commitUsername
String
releaseFilePath
String
releaseFileContentTemplate
String
$class: 'GatekeeperPush'
gcrImageVulnerabilityScanner
imageName
(optional)
String
genexusb
gxInstallationId
String
kbPath
String
kbVersion
String
kbEnvironment
String
kbDbCredentialsId
String
forceRebuild
boolean
$class: 'GenerateChangeScriptBuilder'
in
Specify path to input folder for generating SQL change script. This folder should contain result of previously executed "Run Compare" build step.
Folder location must be specified as:
String
out
Path to the file that should be used to store SQL change script.
File location must be specified as:
String
$class: 'GenerateCreateScriptBuilder'
outputFile
Path to the file that should be used to store create SQL script.
File location must be specified as:
String
inputFileOrFolder
Specify input folder/file for generating create SQL script. It should depend on input type you have selected.
Folder/file location must be specified as:
String
$class: 'GenerateJenkinsReportBuilder'
Generate a HTML report based on a previous schema compare build step. This report is accessible via build detail within build history in Jenkins.
Warning: You can include only one Generate Jenkins HTML comparison report step per project.
inputFolder
Specify path to input folder containing output from "Run Compare" build step.
Folder location must be specified as:
String
$class: 'GenerateStandaloneReportBuilder'
inputFolder
Specify path to input folder containing output from "Run Compare" build step.
Folder location must be specified as:
String
outputFolder
Specify path to folder where standalone report will be exported.
Folder location must be specified as:
String
ghostInspector
apiKey
String
suiteId
String
startUrl
String
params
String
gitAutomerger
checkoutFromRemote
(optional)
boolean
detailConflictReport
(optional)
boolean
limitAuthorsInDetailReport
(optional)
int
limitCommitsInDetailReport
(optional)
int
logLevel
(optional)
TRACE
, DEBUG
, INFO
, WARN
, ERROR
mergeRules
(optional)
path
String
resolution
KEEP_OLDER
, KEEP_NEWER
, MERGE_OLDER_TOP
, MERGE_NEWER_TOP
releaseBranchPattern
(optional)
String
remoteName
(optional)
String
gitbisect
jobToRun
String
goodStartCommit
String
badEndCommit
String
searchIdentifier
String
revisionParameterName
String
retryCount
int
continuesBuild
boolean
minSuccessfulIterations
int
overrideGitCommand
boolean
gitCommand
String
gitHubPRStatus
statusMessage
content
String
$class: 'GitHubSetCommitStatusBuilder'
contextSource
(optional)
$class: 'DefaultCommitContextSource'
$class: 'ManuallyEnteredCommitContextSource'
context
String
statusMessage
(optional)
content
String
$class: 'GitStatusWrapperBuilder'
The gitStatusWrapper
builder wraps set of job builders and handles PENDING/SUCCESS/FAILURE git statuses automatically
Check documentation here
buildSteps
hudson.tasks.BuildStep
)account
(optional)
The GitHub account that owns the repos that contains the commit to notify
Default: If SCM used, plugin will attempt to get details from SCM execution
Check documentation here
String
credentialsId
(optional)
The GitHub credentials, username/password or username/accessToken
String
description
(optional)
String
failureDescription
(optional)
The notification description for a failure, it will be displayed by GitHub
Default: value set to description
This field can also be given a regular expression to evaluate on the entire build log. To have the expression evaluated, wrap it with "/". Example: "/^buildVersion=(.*)$/"
Check documentation here
String
gitApiUrl
(optional)
If you are a user of GitHub Enterprise use this field to set your custom API endpoint
Default: https://api.github.com
String
gitHubContext
(optional)
The git status context key. Keys are used by GitHub to differentiate between notifications
Default: gitStatusWrapper
Check documentation here
String
repo
(optional)
The GitHub repository that contains the commit to validate, must be owned by the user specified in the account field
Default: If SCM used, plugin will attempt to get details from SCM execution
Check documentation here
String
sha
(optional)
The SHA that identifies the commit to notify
Default: If SCM used, plugin will attempt to get details from SCM execution
Check documentation here
String
successDescription
(optional)
The notification description for a success, it will be displayed by GitHub
Default: value set to description
This field can also be given a regular expression to evaluate on the entire build log. To have the expression evaluated, wrap it with "/". Example: "/^buildVersion=(.*)$/"
Check documentation here
String
targetUrl
(optional)
Use this field to specify a custom target URL for the notification
Default: Jenkins build URL
Check documentation here
String
$class: 'GitToIspwPublish'
app
(optional)
String
branchMapping
(optional)
String
connectionId
(optional)
String
credentialsId
(optional)
String
ispwConfigPath
(optional)
String
runtimeConfig
(optional)
String
stream
(optional)
String
$class: 'GnatmakeBuilder'
gnatName
String
switches
String
fileNames
String
modeSwitches
String
gprbuild
installationName
(optional)
String
names
(optional)
String
proj
(optional)
-P
switch. If not specified, GPRbuild uses the project file default.gpr if there is one in the current working directory. Otherwise, if there is only one project file in the current working directory, GPRbuild uses this project file.
String
switches
(optional)
String
gradle
buildFile
(optional)
String
gradleName
(optional)
String
makeExecutable
(optional)
boolean
passAllAsProjectProperties
(optional)
boolean
passAllAsSystemProperties
(optional)
boolean
projectProperties
(optional)
String
rootBuildScriptDir
(optional)
String
switches
(optional)
String
systemProperties
(optional)
String
tasks
(optional)
String
useWorkspaceAsHome
(optional)
Gradle will write to $HOME/.gradle by default for GRADLE_USER_HOME. For a multi-executor agent in Jenkins, setting the environment variable localized files to the workspace avoid collisions accessing gradle cache.
boolean
useWrapper
(optional)
boolean
wrapperLocation
(optional)
String
gradleForesight
projectId
String
credentialId
String
thundraAgentVersion
(optional)
String
thundraGradlePluginVersion
(optional)
String
$class: 'Groovy'
Executes a groovy script.
scriptSource
$class: 'FileScriptSource'
scriptFile
String
$class: 'StringScriptSource'
command
String
groovyName
Groovy installation which will execute the script. Specify the name of the Groovy installation as specified in the Global Jenkins configuration.
String
parameters
Parameters for the Groovy executable.
String
scriptParameters
These parameters will be passed to the script.
String
properties
Instead of passing properties using the -D parameter you can define them here.
String
javaOpts
Direct access to JAVA_OPTS. Properties allows only -D properties, while sometimes also other properties like -XX need to be setup. It can be done here. This line is appended at the end of JAVA_OPTS string.
String
classPath
Specify script classpath here. Each line is one class path item.
String
$class: 'GroovyRemoteBuilder'
remoteName
String
script
String
examRun_Groovy
examName
String
script
(optional)
String
startElement
(optional)
String
examModel
(optional)
String
modelConfiguration
(optional)
String
javaOpts
(optional)
String
timeout
(optional)
int
useStartElement
(optional)
boolean
$class: 'GsshCommandBuilder'
disable
boolean
serverInfo
String
shell
String
$class: 'GsshFtpDownloadBuilder'
disable
boolean
serverInfo
String
remoteFile
String
localFolder
String
fileName
String
$class: 'GsshFtpUploadBuilder'
disable
boolean
serverInfo
String
localFilePath
String
remoteLocation
String
fileName
String
$class: 'GsshShellBuilder'
disable
boolean
serverInfo
String
shell
String
$class: 'HOTPlayer'
project
String
bundle
class com.arkea.jenkins.openstack.heat.orchestration.template.Bundle
habitat
task
(optional)
String
directory
(optional)
String
artifact
(optional)
String
channel
(optional)
String
origin
(optional)
String
bldrUrl
(optional)
String
authToken
(optional)
String
lastBuildFile
(optional)
String
format
(optional)
String
searchString
(optional)
String
command
(optional)
String
binary
(optional)
String
path
(optional)
String
docker
(optional)
boolean
healthAnalyzer
products
$class: 'HealthAnalyzerLrStep'
checkLrInstallation
boolean
checkOsVersion
boolean
checkFiles
filesList
field
String
nodePoolHold
duration
String
reason
String
$class: 'HttpRequest'
url
String
acceptType
(optional)
NOT_SET
, TEXT_HTML
, TEXT_PLAIN
, APPLICATION_FORM
, APPLICATION_JSON
, APPLICATION_JSON_UTF8
, APPLICATION_TAR
, APPLICATION_ZIP
, APPLICATION_OCTETSTREAM
authentication
(optional)
String
consoleLogResponseBody
(optional)
boolean
contentType
(optional)
NOT_SET
, TEXT_HTML
, TEXT_PLAIN
, APPLICATION_FORM
, APPLICATION_JSON
, APPLICATION_JSON_UTF8
, APPLICATION_TAR
, APPLICATION_ZIP
, APPLICATION_OCTETSTREAM
customHeaders
(optional)
name
String
value
String
maskValue
boolean
httpMode
(optional)
GET
, HEAD
, POST
, PUT
, DELETE
, OPTIONS
, PATCH
httpProxy
(optional)
String
ignoreSslErrors
(optional)
boolean
multipartName
(optional)
String
outputFile
(optional)
String
passBuildParameters
(optional)
boolean
proxyAuthentication
(optional)
String
quiet
(optional)
boolean
requestBody
(optional)
String
timeout
(optional)
int
uploadFile
(optional)
String
useSystemProperties
(optional)
boolean
validResponseCodes
(optional)
String
validResponseContent
(optional)
String
wrapAsMultipart
(optional)
boolean
hugo
baseUrl
(optional)
String
buildFuture
(optional)
boolean
destination
(optional)
String
environment
(optional)
String
hugoHome
(optional)
String
verbose
(optional)
boolean
$class: 'HyperBuilder'
image
String
commands
String
ipythonBuilder
code
Eg: print(" Hello Jenkins, from Machine Learning Plugin ...... ! ")
String
filePath
Eg: /home/alice/iris/ml.py
String
parserType
String
task
Eg: Training
String
kernelName
String
$class: 'ITest'
workspace
Required.
(1) Provide the full path to the iTest workspace containing projects, or
(2) Leave blank to indicate that the current job's workspace is also an iTest workspace (must contain an .iTestWorkspace file as created by iTest)
String
projects
Required. Specify the name of the iTest project to export in an ITAR file (required to use iTestRT). Separate names of multiple projects with comma.
Note: The project must exist within the specified iTest workspace.
String
testcases
Required. Specify path to test case or test suite to run: must include extension (path/name.fftc or path/name.ffts). Separate multiple with a comma.
Accepted Formats:
project://projectname/path/to/testcase
/full/path/to/testcase
Examples:
project://system_test/regression_test.fftc
${WORKSPACE}/system_test/regression_test.fftc
String
testbed
Specify the URI of the testbed or topology to use for execution. Must include file extension. Overrides the testbed specified in the test case file.
Accepted Formats:
/path/to/topology.tbml
Examples:
${WORKSPACE}/system_test/topologies/demo.tbml
String
params
Specify a parameter value in the format parameter=value. Separate multiple parameter/value pairs with a comma.
Note: If you specify both --param and --paramfile in an iTestRT command, then the --param argument takes precedence over the values in the parameter file.
String
paramFile
Specify URI of a parameter file in an iTest readable format.
Note: If you specify both --param and --paramfile in an iTestRT command, then the --param argument take precedence over the values in the parameter file.
String
testReportRequired
Check this to generate test report in HTML format.
A link to the report will be provided on the project page, and the report will be available in the iTest workspace specified in the project configuration page.
boolean
dbCustomTag
This option enables you to define and assign a value to a custom tag.
Example: Create a tag that holds the build number so that you compare test execution results between builds.
For tests run against build 54322, use: --tag buildNumber=54322
Tip: Use a custom tag to identify executions or groups of executions on the iTest Team Server Test Execution page.
String
$class: 'ImportFiles'
url
String
cloudTestServerID
String
files
String
excludes
String
mode
String
additionalOptions
String
importPackages
importConfigs
(optional)
$class: 'ExportPackageAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ExportPackageConfig'
filePath
String
exportPath
String
createNewPath
boolean
credentialsId
String
timeout
String
$class: 'ExportProjectAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ExportProjectConfig'
filePath
String
exportPath
String
createNewPath
boolean
credentialsId
String
timeout
String
$class: 'ImportPackageAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ImportPackageConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ImportPackageDirConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ImportProjectArchiveConfig'
tmsPath
String
importPath
String
importConfigPath
String
replaceFiles
boolean
$class: 'ImportProjectAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ImportProjectConfig'
tmsPath
String
importPath
String
importMissingPackages
boolean
credentialsId
String
timeout
String
$class: 'ImportProjectDirConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
importProjects
importConfigs
(optional)
$class: 'ExportPackageAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ExportPackageConfig'
filePath
String
exportPath
String
createNewPath
boolean
credentialsId
String
timeout
String
$class: 'ExportProjectAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ExportProjectConfig'
filePath
String
exportPath
String
createNewPath
boolean
credentialsId
String
timeout
String
$class: 'ImportPackageAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ImportPackageConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ImportPackageDirConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'ImportProjectArchiveConfig'
tmsPath
String
importPath
String
importConfigPath
String
replaceFiles
boolean
$class: 'ImportProjectAttributeConfig'
filePath
String
credentialsId
String
timeout
String
$class: 'ImportProjectConfig'
tmsPath
String
importPath
String
importMissingPackages
boolean
credentialsId
String
timeout
String
$class: 'ImportProjectDirConfig'
tmsPath
String
importPath
String
credentialsId
String
timeout
String
$class: 'InfluxDBPublisher'
userCredentialsID
String
dbUrl
String
dbName
String
content
String
influxDbQuery
checkName
String
influxQuery
String
expectedThreshold
double
markUnstable
(optional)
boolean
retryCount
(optional)
int
retryInterval
(optional)
int
showResults
(optional)
boolean
insightAppSec
region
String
insightCredentialsId
String
appId
String
scanConfigId
String
buildAdvanceIndicator
String
vulnerabilityQuery
vulnerability.severity='HIGH'
String
maxScanPendingDuration
0d 5h 30m
String
maxScanExecutionDuration
0d 5h 30m
String
enableScanResults
boolean
snInstallApp
credentialsId
(optional)
String
apiVersion
(optional)
String
appScope
(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.
String
appSysId
(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.
String
appVersion
(optional)
String
baseAppAutoUpgrade
(optional)
boolean
baseAppVersion
(optional)
String
url
(optional)
String
$class: 'InstallBuilder'
apkFile
String
uninstallFirst
boolean
failOnInstallFailure
boolean
snInstanceScan
credentialsId
(optional)
String
apiVersion
(optional)
String
comboSysId
(optional)
String
requestBody
(optional)
String
scanType
(optional)
String
suiteSysId
(optional)
String
targetRecordSysId
(optional)
String
targetTable
(optional)
String
url
(optional)
String
$class: 'IqPolicyEvaluatorBuildStep'
iqStage
String
iqApplication
manualApplication
applicationId
String
selectedApplication
applicationId
String
iqScanPatterns
**/target/*.war
or **/target/*.ear
. If unspecified, the scan will default to the patterns **/*.jar, **/*.war, **/*.ear, **/*.zip, **/*.tar.gz
.
scanPattern
String
iqModuleExcludes
**/nexus-iq/module.xml
) to be ignored, e.g. **/my-module/target/**, **/another-module/target/**
. If unspecified all modules will contribute dependency information (if any) to the scan.
moduleExclude
String
failBuildOnNetworkError
boolean
jobCredentialsId
- none -
, otherwise select different credentials.
String
enableDebugLogging
boolean
advancedProperties
key1=value1
key2=value2
String
iqInstanceId
(optional)
String
$class: 'IspwRestApiRequest'
connectionId
(optional)
String
consoleLogResponseBody
(optional)
boolean
credentialsId
(optional)
String
ispwAction
(optional)
String
ispwRequestBody
(optional)
String
skipWaitingForSet
(optional)
boolean
$class: 'IssueFieldUpdateStep'
issueSelector
(optional)
$class: 'DefaultIssueSelector'
$class: 'ExplicitIssueSelector'
issueKeys
String
$class: 'JqlIssueSelector'
jql
String
$class: 'P4JobIssueSelector'
fieldId
(optional)
String
fieldValue
(optional)
String
$class: 'IssueUpdatesBuilder'
restAPIUrl
String
userName
String
password
String
jql
String
workflowActionName
String
comment
String
customFieldId
String
customFieldValue
String
resettingFixedVersions
boolean
createNonExistingFixedVersions
boolean
fixedVersions
String
failIfJqlFails
boolean
failIfNoIssuesReturned
boolean
failIfNoJiraConnection
boolean
$class: 'JBossBuilder'
operation
value
START_AND_WAIT
, START
, SHUTDOWN
, CHECK_DEPLOY
properties
String
stopOnFailure
boolean
serverName
String
$class: 'JIRATicketEditor'
jiraCredentialsID
String
newTicketsTemplates
performDuplicateCheck
boolean
parentJQL
String
title
String
type
String
priority
String
description
String
envVarName
String
fieldValues
fieldHumanReadableName
String
valueToSet
String
modifyTicketsTemplates
jqlFilter
String
commitRegEx
String
ticketSource
String
modifications
$class: 'AddCommentModification'
commentBody
String
$class: 'ModifyArrayFieldModification'
fieldHumanReadableName
String
modificationType
String
modificationValue
String
$class: 'PerformTransitionModification'
transitionName
String
comment
String
$class: 'SetFieldModification'
fieldHumanReadableName
String
valueToSet
String
$class: 'JIRAVersionEditor'
jiraCredentialsID
String
versionModifiactions
versionName
String
replaceDescription
boolean
descriptionText
String
releaseState
String
failOnJQL
boolean
failQuery
String
$class: 'JSLintBuilder'
includePattern
The files to include in an Ant-style filter. See javadoc
Example: lib/**/*.js
This would grab files including lib/foo.js and lib/foo/bar/baz.js
Example: lib/*.js
This would include lib/foo.js but not lib/foo/bar.js
String
excludePattern
The files to exclude in an Ant-style filter. See javadoc
Example: lib/**/ModuleImportProgressDialog.js
This would omit any file named ModuleImportProgressDialog.js
String
logfile
The file to output to in a Checkstyle XML format
Example: target/jslint.xml
String
arguments
The arguments to pass to JSLint. You can use any arguments that JSLint supports! Be sure, though, to prefix each argument with -D
Example: -Dadsafe=true, -Dcontinue=true
This would activate adsafe and continue
Example: -Dpredef=foo,bar,baz
This would be like having /*global foo,bar,baz*/ at the top of every JavaScript file JSLint runs on.
Example: -Dpredef=foo,bar,baz, -Dmaxlen=80
This would be like having /*global foo,bar,baz*/ at the top of every JavaScript file JSLint runs on. It also sets the maximum length of a line to 80 chars.
The default options we use are:
var defaultOptions = { bitwise: true, eqeqeq: false, immed: false, newcap: false, nomen: false, onevar: false, plusplus: false, regexp: false, rhino: true, undef: true, white: false, forin: true, sub: true, browser: true, laxbreak: true, predef: [ 'Ext', 'jQuery', 'window', '$', 'ActiveXObject', 'SWFObject' ] };
String
$class: 'JabberBuilder'
builderName
String
venafiCodeSignWithJarSigner
tppName
String
certLabel
String
extraArgs
(optional)
This plugin invokes Jarsigner under the hood. Here you can specify extra custom CLI arguments to pass to Jarsigner.
These arguments will be appended to the Jarsigner CLI invocation, and take precedence over any arguments implicitly passed by this plugin.
argument
String
file
(optional)
The path to the file to be signed.
Either a path or a glob must be given.
String
glob
(optional)
A glob that specifies the files to be signed.
Either a path or a glob must be given.
String
timestampingServers
(optional)
Specifies one or more timestamping authority servers to use during signing. Specifying this is strongly recommended, because it allows signed files to be usable even after the original signing certificate has expired.
If you specify more than one server, then a random one will be used.
Tip: here are some public timestamping authorities that you can use:
address
String
venafiClientToolsDir
(optional)
Specify the path to the directory in which Venafi CodeSign Protect client tools are installed. If not specified, it's autodetected as follows:
String
venafiVerifyWithJarSigner
tppName
String
certLabel
String
file
(optional)
The path to the file to be verified.
Either a path or a glob must be given.
String
glob
(optional)
A glob that specifies the files to be verified.
Either a path or a glob must be given.
String
venafiClientToolsDir
(optional)
Specify the path to the directory in which Venafi CodeSign Protect client tools are installed. If not specified, it's autodetected as follows:
String
$class: 'JbpmUrlResourceBuilder'
url
String
processId
String
SoapUIPro
pathToTestrunner
String
pathToProjectFile
String
environment
(optional)
String
projectPassword
(optional)
String
testCase
(optional)
String
testCaseTags
(optional)
String
testSuite
(optional)
String
testSuiteTags
(optional)
String
$class: 'JigomergeBuilder'
source
String
username
String
password
String
oneByOne
boolean
eager
boolean
validationScript
String
dryRun
boolean
verbose
boolean
ignoreMergePatterns
String
commitCommentPrefix
String
$class: 'JiraEnvironmentVariableBuilder'
Typical usage:
issue in (${JIRA_ISSUES})
issueSelector
$class: 'DefaultIssueSelector'
$class: 'ExplicitIssueSelector'
issueKeys
String
$class: 'JqlIssueSelector'
jql
String
$class: 'P4JobIssueSelector'
$class: 'JiraExtBuildStep'
issueStrategy
$class: 'FirstWordOfCommitStrategy'
$class: 'FirstWordOfUpstreamCommitStrategy'
$class: 'MentionedInCommitStrategy'
$class: 'SingleTicketStrategy'
issueKey
String
extensions
$class: 'AddComment'
postCommentForEveryCommit
boolean
commentText
String
$class: 'AddFixVersion'
fixVersion
The Fix Version to append. Must exist.
String
$class: 'AddLabel'
labelName
String
$class: 'AddLabelToField'
fieldName
String
fieldValue
String
$class: 'Transition'
transitionName
String
$class: 'UpdateField'
fieldName
String
fieldValue
String
$class: 'JiraIssueUpdateBuilder'
jqlSearch
Example:
or (e.g., combined with a Jira Issue Parameter, selecting one issue from a JQL result set):project = JENKINS and fixVersion = "$RELEASE_VERSION" and status not in (Resolved, Closed)
issue = $ISSUE_ID
String
workflowActionName
String
comment
String
$class: 'JiraReleaseVersionUpdaterBuilder'
jiraProjectKey
Specify the project key. A project key is the all capitals part before the issue number in Jira.
(EXAMPLE-100)
String
jiraRelease
String
jiraDescription
String
$class: 'JiraVersionCreatorBuilder'
jiraVersion
String
jiraProjectKey
Specify the project key. A project key is the all capitals part before the issue number in Jira.
(EXAMPLE-100)
String
$class: 'JobConfigRebrander'
$class: 'JobDeleteBuilder'
target
String
$class: 'JobStrongAuthSimpleBuilder'
jobUsers
String
useGlobalUsers
boolean
jobMinAuthUserNum
int
useJobExpireTime
boolean
jobExpireTimeInHours
int
$class: 'JobcopyBuilder'
fromJobName
String
toJobName
String
overwrite
boolean
jobcopyOperationList
$class: 'DisableOperation'
$class: 'EnableOperation'
$class: 'ReplaceOperation'
fromStr
String
expandFromStr
boolean
toStr
String
expandToStr
boolean
additionalFilesetList
includeFile
String
excludeFile
String
overwrite
boolean
jobcopyOperationList
$class: 'DisableOperation'
$class: 'EnableOperation'
$class: 'ReplaceOperation'
fromStr
String
expandFromStr
boolean
toStr
String
expandToStr
boolean
$class: 'KanboardTaskFetcher'
projectIdentifier
String
taskReference
String
taskAttachments
(optional)
String
taskLinks
(optional)
String
$class: 'KarafBuildStepBuilder'
useCustomKaraf
boolean
karafHome
String
flags
specify the port to connect to
-h [host]specify the host to connect to
-u [user]specify the user name
-p [password]specify the password (optional, if not provided, the password is prompted)
-vraise verbosity
-lset client logging level. Set to 0 for ERROR logging and up to 4 for TRACE
-r [attempts]retry connection establishment (up to attempts times)
-d [delay]intra-retry delay (defaults to 2 seconds)
-f [file]read commands from the specified file
-k [keyFile]specify the private keyFile location when using key login, need have BouncyCastle registered as security provider using this flag
-t [timeout]define the client idle timeout
String
option
$class: 'KarafCommandFileOption'
file
String
$class: 'KarafCommandScriptOption'
script
(optional)
String
unlockMacOSKeychain
keychainId
(optional)
String
keychainName
(optional)
String
keychainPath
(optional)
String
keychainPwd
(optional)
class hudson.util.Secret
$class: 'KlocworkBuildSpecBuilder'
buildSpecConfig
buildCommand
String
tool
String
output
String
additionalOpts
String
ignoreErrors
boolean
$class: 'KlocworkCiBuilder'
ciConfig
buildSpec
String
projectDir
String
cleanupProject
boolean
reportFile
String
additionalOpts
String
incrementalAnalysis
This feature allows for quick, incremental analyses of changed source files to enable pre/post-checkin/commit-like behavior . The goal is that only changed files are analyzed by the Klocwork kwciagent tool to replicate the local analysis developers would perform by using our supported IDE plugins or the command line utility. To enable this behavior, the plugin takes a list of the changed files from the SCM; this enables the system to analyze only the changed files when the workspace isn’t kept. Leave this cleared to analyze the whole project, or, if the workspace is kept, to perform a standard incremental analysis.
The diff file list is the file that contains the changed source files for Klocwork to analyze. All analyzed files must exist in the build specification generated by kwinject.
Note: All files to be analyzed must exist in the build specification.
If using Git, provide the previous commit that Git should perform a "diff" against. The change list between the current commit and the specified previous commit will be added to the diff file list for Klocwork to process by automatically calling "git diff <previous_commit>" during the build. Note: If you are using Git jenkins plugin to obtain source files for you pipeline job be sure to use 'Pipeline script from SCM' and specify the previous commit with the environment variable, 'GIT_PREVIOUS_COMMIT'. Also be aware that the first build in the job won't be able to access GIT_PREVIOUS_COMMIT and the first build will run full CI analysis.
If you are not using Git, or want to manually generate the change list by using Git, select this option. You will need to generate the diff file list by using a custom build-step (or similar). List one changed source file on each line of the file.
boolean
differentialAnalysisConfig
diffType
String
gitPreviousCommit
String
diffFileList
String
$class: 'KlocworkServerAnalysisBuilder'
serverConfig
buildSpec
String
tablesDir
String
incrementalAnalysis
boolean
ignoreCompileErrors
boolean
importConfig
String
additionalOpts
String
disableKwdeploy
boolean
duplicateFrom
(optional)
String
enabledCreateProject
(optional)
boolean
$class: 'KlocworkServerLoadBuilder'
serverConfig
(optional)
tablesDir
(optional)
String
buildName
(optional)
String
additionalOpts
(optional)
String
reportConfig
(optional)
displayChart
(optional)
boolean
chartHeight
(optional)
String
chartWidth
(optional)
String
query
(optional)
String
$class: 'KlocworkXSyncBuilder'
syncConfig
dryRun
boolean
lastSync
String
projectRegexp
String
statusAnalyze
boolean
statusIgnore
boolean
statusNotAProblem
boolean
statusFix
boolean
statusFixInNextRelease
boolean
statusFixInLaterRelease
boolean
statusDefer
boolean
statusFilter
boolean
additionalOpts
String
$class: 'KmapJenkinsBuilder'
username
String
password
String
kmapClient
String
categories
String
teams
String
users
String
sendNotifications
boolean
publishOptional
teams
String
users
String
sendNotifications
boolean
filePath
String
appName
String
bundle
String
version
String
description
String
iconPath
String
$class: 'KojiBuilder'
kojiBuild
String
kojiTarget
String
kojiPackage
String
kojiOptions
String
kojiTask
String
kojiScratchBuild
boolean
kojiScmUrl
String
cfyKubernetes
allowNodeRedefinition
(optional)
boolean
apiKeyCredentialsId
(optional)
The ID of the credentials entry that contains the API key.
This parameter is optional; the API key may also be provided through "API options", however this method is preferred.
If provided, then this credentials entry must either be of type "text" or "file". In the latter case, the file is read as-is and the resultant string is used as the API credentials.
String
apiKeyFile
(optional)
Path to file, relative to the Jenkins workspace, containing the API key.
This parameter is optional, as the API key may be provided by other means.
String
caCert
(optional)
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
definition
(optional)
java.util.Map<java.lang.String, java.lang.Object>
definitionAsString
(optional)
String
definitionFile
(optional)
String
deploymentId
(optional)
ID to assign to the created Cloudify deployment. If not provided, one will be randomly generated. You can obtain the deployment ID from the "environment data" output file.
String
echoEnvData
(optional)
If checked, then the created environment's data will be printed to the job's log.
boolean
echoInputs
(optional)
boolean
envDataLocation
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
String
gcpCredentialsFile
(optional)
A YAML/JSON file containing GCP service account details, to use for authentication against GCP.
This parameter is optional, and is only relevant for authenticating against GCP.
If provided, it should follow the same layout as described in the "GCP Credentials ID" parameter.
String
gcpCredentialsId
(optional)
The ID of the credentials to be used for authentication against GCP.
This parameter is optional, and is only relevant for authenticating against GCP.
If provided, it should be the ID of either a string-type or file-type credentials entry, with the standard GCP service account YAML/JSON syntax:
{ "type": "...", "project_id": "...", "private_key_id": "...", "private_key": "...", "client_email": "...", "client_id": "...", "auth_uri": "...", "token_uri": "...", "auth_provider_x509_cert_url": "...", "client_x509_cert_url": "..." }
String
k8sDebug
(optional)
boolean
k8sMaster
(optional)
String
namespace
(optional)
namespace
value in the options
field, if exists.
String
options
(optional)
java.util.Map<java.lang.String, java.lang.Object>
optionsAsString
(optional)
String
optionsFile
(optional)
String
skipSslVerification
(optional)
boolean
sslCertFile
(optional)
String
sslKeyFile
(optional)
String
tenant
(optional)
String
validateStatus
(optional)
boolean
$class: 'KubernetesDeploy'
context
configs
(optional)
The path patterns for the Kubernetes configurations you want to deploy, in the form of Ant glob syntax.
String
credentialsType
(optional)
Choose how to get the kubeconfig file to authenticate with the Kubernetes cluster management endpoint.
3 options are supported:
~/.kube/config
file through an SSH connection to the master node.See also: Configure kubectl
String
deleteResource
(optional)
Whether to delete the resource, if it is true, delete all resources in the config file.
boolean
dockerCredentials
(optional)
url
https://index.docker.io/v1/
).
String
credentialsId
String
enableConfigSubstitution
(optional)
Substitute variables (in the form $VARIABLE
or ${VARIABLE}
) in the configuration with values from Jenkins environment variables.
This allows you to use dynamic values produced during the build in your Kubernetes configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.
boolean
kubeConfig
(optional)
path
(optional)
kubeconfig
file path relative to the current Jenkins workspace.
String
kubeconfigId
(optional)
String
secretName
(optional)
imagePullSecrets
entry. Environment variable substitution are supported for the name input, so you can use available environment variables to construct the name dynamically, e.g., some-secret-$BUILD_NUMBER
. The name should be in the pattern [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*
, i.e., dot (.) concatenated sequences of hyphen (-) separated alphanumeric words. (See Kubernetes Names)
If left blank, the plugin will generate a name based on the build name.
The secret name will be exposed with the environment variable $KUBERNETES_SECRET_NAME
. You can use this in your Kubernetes configuration to reference the updated secret when the "Enable Variable Substitution in Config" option is enabled.
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: nginx
spec:
replicas: 1
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: some.private.registry.domain/nginx
ports:
- containerPort: 80
imagePullSecrets:
- name: $KUBERNETES_SECRET_NAME
Note that once the secret is created, it will only be updated by the plugin. You have to manually delete it when it is not used anymore. If this is a problem, you may use fixed name so every time the job runs, the secret gets updated and no new secret is created.
String
secretNamespace
(optional)
String
ssh
(optional)
sshCredentialsId
(optional)
String
sshServer
(optional)
<host>[:<port>]
) of the Kubernetes master node. If port is omitted, the default SSH port 22 will be used.
String
textCredentials
(optional)
certificateAuthorityData
(optional)
clusters.cluster.certificate-authority-data
value in the kubeconfig
file.
String
clientCertificateData
(optional)
users.user.client-certificate-data
value in the kubeconfig
file.
String
clientKeyData
(optional)
users.user.client-key-data
value in the kubeconfig
file.
String
serverUrl
(optional)
clusters.cluster.server
address in the kubeconfig
. Generally, it should start with https://
.
String
kubernetesEngineDeploy
cluster
(optional)
String
clusterName
(optional)
String
credentialsId
(optional)
String
location
(optional)
String
manifestPattern
(optional)
String
namespace
(optional)
String
projectId
(optional)
String
verboseLogging
(optional)
boolean
verifyDeployments
(optional)
boolean
verifyServices
(optional)
boolean
verifyTimeoutInMinutes
(optional)
int
zone
(optional)
String
loadcompletetest
project
(optional)
String
test
(optional)
String
actionOnErrors
(optional)
String
actionOnWarnings
(optional)
String
executorVersion
(optional)
String
generateMHT
(optional)
boolean
generatePDF
(optional)
boolean
timeout
(optional)
String
useTimeout
(optional)
boolean
leanIXMicroserviceIntelligence
apitoken
(optional)
class hudson.util.Secret
dependencymanager
(optional)
String
deploymentstage
(optional)
String
deploymentversion
(optional)
String
hostname
(optional)
String
jobresultchoice
(optional)
String
lxmanifestpath
(optional)
String
useleanixconnector
(optional)
boolean
eventSourceLambda
lambdaEventSourceBuildStepVariables
awsRegion
String
functionName
String
eventSourceArn
String
awsAccessKeyId
(optional)
String
awsSecretKey
(optional)
String
functionAlias
(optional)
String
useInstanceCredentials
(optional)
boolean
invokeLambda
lambdaInvokeBuildStepVariables
awsRegion
String
functionName
String
synchronous
boolean
awsAccessKeyId
(optional)
String
awsSecretKey
(optional)
String
jsonParameters
(optional)
envVarName
String
jsonPath
(optional)
String
payload
(optional)
String
useInstanceCredentials
(optional)
boolean
publishLambda
lambdaPublishBuildStepVariables
awsRegion
String
functionARN
String
functionAlias
String
versionDescription
String
awsAccessKeyId
(optional)
String
awsSecretKey
(optional)
String
useInstanceCredentials
(optional)
boolean
deployLambda
lambdaUploadBuildStepVariables
awsRegion
String
functionName
String
updateMode
String
alias
(optional)
String
artifactLocation
(optional)
String
awsAccessKeyId
(optional)
String
awsSecretKey
(optional)
String
createAlias
(optional)
boolean
deadLetterQueueArn
(optional)
String
description
(optional)
String
enableDeadLetterQueue
(optional)
boolean
environmentConfiguration
(optional)
environment
key
String
value
String
configureEnvironment
(optional)
boolean
kmsArn
(optional)
String
handler
(optional)
String
memorySize
(optional)
String
publish
(optional)
boolean
role
(optional)
String
runtime
(optional)
String
securityGroups
(optional)
String
subnets
(optional)
String
timeout
(optional)
String
useInstanceCredentials
(optional)
boolean
$class: 'LeapworkJenkinsBridgeBuilder'
leapworkHostname
String
leapworkPort
String
leapworkAccessKey
String
leapworkSchNames
String
leapworkSchIds
String
leapworkDelay
(optional)
String
leapworkDoneStatusAs
(optional)
String
leapworkReport
(optional)
String
leapworkScheduleVariables
(optional)
String
leapworkWritePassedFlowKeyFrames
(optional)
boolean
$class: 'LeiningenBuilder'
task
String
subdirPath
String
checkETLicense
Check ECU-TEST license.
Pipelines usage:checkETLicense(String toolName) : void
checkETLicense('ECU-TEST')
toolName
String
installation
(optional)
name
String
home
String
properties
? extends hudson.tools.ToolProperty<?>
timeout
(optional)
String
lighthouseReport
file
String
name
(optional)
String
dotnetListPackage
dotnet list package
command provides a convenient option to list all NuGet package references for a specific project or a solution. You first need to build the project in order to have the assets needed for this command to process.
config
(optional)
String
deprecated
(optional)
boolean
framework
(optional)
String
frameworks
(optional)
String
frameworksString
(optional)
String
highestMinor
(optional)
boolean
highestPatch
(optional)
boolean
includePrerelease
(optional)
boolean
includeTransitive
(optional)
boolean
outdated
(optional)
boolean
project
(optional)
String
sdk
(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.
String
showSdkInfo
(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.
boolean
source
(optional)
String
sources
(optional)
String
sourcesString
(optional)
String
specificSdkVersion
(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.
boolean
verbosity
(optional)
String
workDirectory
(optional)
String
$class: 'LoadImpactTestRunTask'
apiTokenId
String
loadTestId
int
criteriaDelayValue
int
criteriaDelayUnit
String
criteriaDelayQueueSize
int
abortAtFailure
boolean
thresholds
metric
String
operator
String
value
int
result
String
pollInterval
int
logHttp
boolean
logJson
boolean
$class: 'LoadNinjaBuilder'
apiKey
String
scenarioId
String
oeb
errorPassCriteria
String
odb
durationPassCriteria
String
$class: 'LoadPluginBuilder'
url
String
username
String
password
String
file
String
greet
testId
String
credentialsId
String
$class: 'LoadtestBuilder'
loadtestBuilderModel
environmentShortName
String
authToken
String
presetName
String
loadtestScenario
String
loadtestThresholdParameters
metricType
String
evaluationDirection
String
numericValue
double
dotnetNuGetLocals
dotnet nuget locals
command clears or lists local NuGet resources in the http-request cache, temporary cache, or machine-wide global packages folder.
cacheLocation
(optional)
all
: Indicates that the specified operation is applied to all cache types: http-request cache, global packages cache, and the temporary cache. global-packages
: Indicates that the specified operation is applied only to the global packages cache. The other cache locations aren't affected. http-cache
: Indicates that the specified operation is applied only to the http-request cache. The other cache locations aren't affected. temp
: Indicates that the specified operation is applied only to the temporary cache. The other cache locations aren't affected. String
forceEnglishOutput
(optional)
boolean
operation
(optional)
clear
: The contents of the cache directories are deleted recursively. The executing user/group must have permission to the files in the cache directories. If not, an error is displayed indicating the files/folders that weren't cleared. list
: Displays the path to the specified cache location.String
sdk
(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.
String
showSdkInfo
(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.
boolean
specificSdkVersion
(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.
boolean
workDirectory
(optional)
String
$class: 'LoginBuilder'
credentialsId
String
hubUrl
String
mabl
restApiKeyId
String
environmentId
String
applicationId
String
apiBaseUrl
(optional)
String
appBaseUrl
(optional)
String
continueOnMablError
(optional)
boolean
continueOnPlanFailure
(optional)
boolean
disableSslVerification
(optional)
boolean
labels
(optional)
String
mablBranch
(optional)
String
$class: 'MailCommandBuilder'
POP3 mail server address | Set POP3 mail server's hostname or ip address. |
POP3 mail server port | Set POP3 mail server's port. Default value is 110. |
POP3 User Name | Set POP3 mail server's user account. |
POP3 Password | Set POP3 mail server's password. |
address
String
port
String
username
String
password
String
$class: 'MakeAppTouchTestable'
url
String
cloudTestServerID
String
inputType
String
projectFile
String
target
String
launchURL
String
backupModifiedFiles
boolean
additionalOptions
String
javaOptions
String
$class: 'ManageInstance'
cloud
String
workspace
String
operations
? extends com.elasticbox.jenkins.builders.Operation
$class: 'MatlabBuilder'
matlabRoot
(optional)
Note: If the job runs on a remote agent, you must specify the full path to MATLAB root folder on the remote agent.
String
testRunTypeList
(optional)
$class: 'RunTestsAutomaticallyOption'
taCoberturaChkBx
(optional)
boolean
taJunitChkBx
(optional)
boolean
taModelCoverageChkBx
(optional)
boolean
taPDFReportChkBx
(optional)
boolean
taSTMResultsChkBx
(optional)
boolean
tatapChkBx
(optional)
boolean
$class: 'RunTestsWithCustomCommandOption'
customMatlabCommand
(optional)
String
maven
targets
String
name
String
pom
String
properties
# comment name1=value1 name2=value2These are passed to Maven like
"-Dname1=value1 -Dname2=value2"
String
jvmOptions
String
usePrivateRepository
boolean
settings
settings.xml
file contains elements used to define values which configure Maven execution in various ways, like the pom.xml
, but should not be bundled to any specific project, or distributed to an audience. These include values such as the local repository location, alternate remote repository servers, and authentication information.
settings.xml
file per default may live:
$M2_HOME/conf/settings.xml
${user.home}/.m2/settings.xml
see also: settings.xml
reference
standard
$HOME/.m2/settings.xml
) as set on build node.
filePath
settings.xml
file. Such a file is checked out from SCM as part of the job or a well known location.
path
String
$class: 'MvnSettingsProvider'
settingsConfigId
String
globalSettings
standard
$HOME/.m2/settings.xml
) as set on build node.
$class: 'FilePathGlobalSettingsProvider'
settings.xml
file from job workspace. Such a file is checked out from SCM as part of the job or a well known location.
path
String
$class: 'MvnGlobalSettingsProvider'
settingsConfigId
String
injectBuildVariables
MY_VAR=${MY_VAR}
).
boolean
$class: 'Maven3Builder'
mavenName
String
rootPom
String
goals
String
mavenOpts
String
useWrapper
boolean
$class: 'MavenDeploymentDownloader'
projectName
String
filePattern
.*
)
String
permaLink
String
targetDir
String
stripVersion
boolean
stripVersionPattern
String
failIfNoArtifact
boolean
cleanTargetDir
boolean
$class: 'MavenSealightsBuildStep'
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
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) |
String
includeResources
boolean
buildStepMode
$class: 'DisableSealightsView'
targets
String
$class: 'InvokeMavenCommandView'
targets
String
$class: 'OffView'
$class: 'PrepareSealightsView'
additionalMavenArguments
String
name
String
pom
String
properties
# comment name1=value1 name2=value2These are passed to Maven like "-Dname1=value1 -Dname2=value2"
String
jvmOptions
String
usePrivateRepository
boolean
settings
settings.xml
file contains elements used to define values which configure Maven execution in various ways, like the pom.xml
, but should not be bundled to any specific project, or distributed to an audience. These include values such as the local repository location, alternate remote repository servers, and authentication information.
settings.xml
file per default may live:
$M2_HOME/conf/settings.xml
${user.home}/.m2/settings.xml
see also: settings.xml
reference
standard
$HOME/.m2/settings.xml
) as set on build node.
filePath
settings.xml
file. Such a file is checked out from SCM as part of the job or a well known location.
path
String
$class: 'MvnSettingsProvider'
settingsConfigId
String
globalSettings
standard
$HOME/.m2/settings.xml
) as set on build node.
$class: 'FilePathGlobalSettingsProvider'
settings.xml
file from job workspace. Such a file is checked out from SCM as part of the job or a well known location.
path
String
$class: 'MvnGlobalSettingsProvider'
settingsConfigId
String
mavenSnapshotCheck
check
(optional)
boolean
$class: 'MdtoolSolutionBuilder'
installationName
String
solutionPath
String
target
value
String
configuration
value
String
project
value
String
runtime
value
String
measure
VMs
(optional)
int
clazzFolders
(optional)
String
createDefaultConstructor
(optional)
boolean
displayLogs
(optional)
boolean
displayRCALogs
(optional)
boolean
displayRTSLogs
(optional)
boolean
excludeLog4j
(optional)
boolean
excludes
(optional)
String
executeBeforeClassInMeasurement
(optional)
boolean
executeParallel
(optional)
boolean
executeRCA
(optional)
boolean
generateCoverageSelection
(optional)
boolean
includes
(optional)
String
iterations
(optional)
int
kiekerWaitTime
(optional)
int
measureJMH
(optional)
boolean
measurementMode
(optional)
LEVELWISE
, COMPLETE
, UNTIL_STRUCTURE_CHANGE
, UNTIL_SOURCE_CHANGE
nightlyBuild
(optional)
boolean
onlyMeasureWorkload
(optional)
boolean
pl
(optional)
String
properties
(optional)
String
redirectSubprocessOutputToFile
(optional)
boolean
redirectToNull
(optional)
boolean
removeSnapshots
(optional)
boolean
repetitions
(optional)
int
showStart
(optional)
boolean
significanceLevel
(optional)
double
testClazzFolders
(optional)
String
testExecutor
(optional)
String
testGoal
(optional)
String
testTransformer
(optional)
String
timeout
(optional)
int
updateSnapshotDependencies
(optional)
boolean
useAggregation
(optional)
boolean
useAlternativeBuildfile
(optional)
boolean
useGC
(optional)
boolean
useSourceInstrumentation
(optional)
boolean
versionDiff
(optional)
int
warmup
(optional)
int
redmineMetricsReport
settings
(optional)
url
String
apiKey
Specify Redmine API Key which can be found in Redmine's [My Account] -> API access key
If can't find "API access key", Redmine admin needs to enable a setting. "Administration > Settings > Authentication > Enable REST web service".
String
projectName
Specify Redmine Project's Identifier which you want to generate report for, use Identifier not Name in the Redmine project setting page.
String
customQueryId
int
sprintSize
Specify the time span(day). e.g.: if you want to generate report on a weekly basis you should specify 7.
int
$class: 'MicroDocsChecker'
microDocsReportFile
String
microDocsProjectName
String
microDocsGroupName
String
microDocsEnvironments
String
microDocsSourceFolder
String
microDocsFailBuild
boolean
microDocsPublish
boolean
microDocsNotifyPullRequest
boolean
minio
bucket
String
includes
String
credentialsId
(optional)
String
excludes
(optional)
String
host
(optional)
String
targetFolder
(optional)
String
minioDelete
bucket
String
files
String
credentialsId
(optional)
String
failOnNonExisting
(optional)
boolean
host
(optional)
String
minioDownload
bucket
String
file
String
credentialsId
(optional)
String
excludes
(optional)
String
failOnNonExisting
(optional)
boolean
host
(optional)
String
targetFolder
(optional)
String
$class: 'MobileStudioTestBuilder'
mobileStudioRunnerPath
String
testPath
String
msgServer
(optional)
String
deviceId
(optional)
String
projectRoot
(optional)
String
testAsUnit
(optional)
boolean
$class: 'MockLoadBuilder'
mock-artifact-*.txt
. There will be a JUnit test report with the file name mock-junit.xml
. Approximately 5% of the time, the build will "fail" its tests and thus no artifacts will be generated.
averageDuration
long
$class: 'ModelBuilder'
pushGuardSettings
minBufferSize
String
hubUrls
String
$class: 'MonitorRemoteJobBuilder'
hostName
String
jobName
String
timeBefore
String
userName
String
password
String
useSSL
boolean
$class: 'MonkeyBuilder'
filename
String
packageId
String
eventCount
int
throttleMs
int
seed
String
categories
String
extraParameters
String
moveComponents
nexusInstanceId
String
destination
String
search
(optional)
java.util.Map<java.lang.String, java.lang.String>
tagName
(optional)
String
msbuild
msBuildName
String
msBuildFile
Give the .proj or .sln file from the module root (SCM root directory or workspace directory) that MSBuild will use to build.
You can use build variables through the syntax ${var}.
String
cmdLineArgs
This is a whitespace separated-list of command-line arguments you can specify. These can be the same as if you were to run MSBuild from the command line.
String
buildVariablesAsProperties
If set to true, Jenkins build variables will be passed to MSBuild as /p:name=value pairs.
Beware : Sensitive build variables such as passwords will not be added.
boolean
continueOnBuildFailure
If set to true, Job will continue despite MSBuild build failure.
boolean
unstableIfWarnings
If set to true and warnings on compilation, the build will be unstable.
boolean
doNotUseChcpCommand
boolean
$class: 'MsBuildSQRunnerBegin'
additionalArguments
(optional)
String
msBuildScannerInstallationName
(optional)
String
projectKey
(optional)
String
projectName
(optional)
String
projectVersion
(optional)
String
sonarInstallationName
(optional)
String
$class: 'MsBuildSQRunnerEnd'
$class: 'MsTestBuilder'
msTestName
String
testFiles
Specify the path to your MSTest compiled assemblies.
You can specify multiple test assemblies by separating them with new-line.
You can use either relative path to the workspace or full path. Spaces in the path are allowed.
You can use Ant-style filters. i.e - foo/*, foo/**/bar.dll, foo/*.dll
Command Line Argument: /testcontainer
String
categories
Optional field, if you do not enter all test will run. If entered specify the test categories to run. You can use logical operators like:
Cateogry Filter | Result |
Priority1 | Any test with category Priority1 |
Priority1&SpeedTest | Test that have both Priority1 and SpeedTest categories |
Priority1|SpeedTest | Tests that have either Priority1 or SpeedTest categories |
Priority1&!SpeedTest | Test that have Priority1 category and also do not have SpeedTest category. |
Command Line Argument: /category
String
resultFile
Specify name of the result file to create. The result file will be delete before each run and will be created relative to the workspace directory.
Command Line Argument: /resultsfile
String
cmdLineArgs
String
continueOnFail
Specify if the build should fail if a test fail (unchecked) or continue even if a test failed (checked).
boolean
$class: 'MultiJobBuilder'
phaseName
String
phaseJobs
jobName
String
jobAlias
String
jobProperties
String
currParams
boolean
configs
$class: 'BooleanParameters'
configs
name
String
value
boolean
$class: 'CurrentBuildParameters'
$class: 'FileBuildParameters'
propertiesFile
String
encoding
String
failTriggerOnMissing
boolean
useMatrixChild
boolean
combinationFilter
String
onlyExactRuns
boolean
textParamValueOnNewLine
boolean
$class: 'GeneratorCurrentParameters'
$class: 'GitRevisionBuildParameters'
combineQueuedCommits
boolean
$class: 'MatrixSubsetBuildParameters'
filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggered job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String
$class: 'NodeLabelBuildParameter'
name
String
nodeLabel
String
$class: 'NodeParameters'
$class: 'PredefinedBuildParameters'
properties
String
textParamValueOnNewLine
boolean
$class: 'PredefinedGeneratorParameters'
properties
String
$class: 'SubversionRevisionBuildParameters'
includeUpstreamParameters
boolean
killPhaseOnJobResultCondition
FAILURE
, NEVER
, UNSTABLE
disableJob
boolean
enableRetryStrategy
boolean
parsingRulesPath
String
maxRetries
int
enableCondition
boolean
abortAllJob
boolean
condition
String
buildOnlyIfSCMChanges
boolean
applyConditionOnlyIfNoSCMChanges
boolean
aggregatedTestResults
boolean
continuationCondition
ALWAYS
, SUCCESSFUL
, COMPLETED
, UNSTABLE
, FAILURE
executionType
PARALLEL
, SEQUENTIALLY
quietPeriodGroovy
String
mavenForesight
projectId
String
credentialId
String
thundraAgentVersion
(optional)
String
$class: 'MystBuilder'
mystAction
String
config
String
mystWorkspace
String
properties
String
mystInstallationName
String
NCScanBuilder
ncScanType
String
ncWebsiteId
String
ncProfileId
String
ncDoNotFail
(optional)
boolean
credentialsId
(optional)
String
ncApiToken
(optional)
Object
ncConfirmed
(optional)
boolean
ncIgnoreFalsePositive
(optional)
boolean
ncIgnoreRiskAccepted
(optional)
boolean
ncServerURL
(optional)
String
ncSeverity
(optional)
String
ncStopScan
(optional)
boolean
$class: 'NISConnection'
viewUrl
String
address
String
port
int
prozent
int
npm
command
String
workspaceSubdirectory
(optional)
String
apiKey
validateDnsUrlConnection
boolean
apiUrl
(optional)
String
group
(optional)
String
binaryName
(optional)
String
description
(optional)
String
waitForResults
(optional)
boolean
waitMinutes
(optional)
int
breakBuildOnScore
(optional)
boolean
scoreThreshold
(optional)
int
apiKey
(optional)
String
useBuildEndpoint
(optional)
boolean
artifactsDir
(optional)
String
debug
(optional)
boolean
password
(optional)
String
proxyEnabled
(optional)
boolean
showStatusMessages
(optional)
boolean
stopTestsForStatusMessage
(optional)
String
username
(optional)
String
validateDnsUrlConnectionEnabled
(optional)
boolean
$class: 'NSiqBuilder'
srcDir
String
fileFilter
String
$class: 'NantBuilder'
nantBuildFile
String
nantName
String
targets
String
properties
String
$class: 'NeoBuildAction'
executable
/opt/NeoLoad 6.5/bin/NeoLoadCmd
, C:\Program Files\NeoLoad 6.5\bin\NeoLoadCmd.exe
or /Applications/NeoLoad 6.5/bin/NeoLoadCmd
.
String
projectType
String
reportType
String
localProjectFile
/home/ajohnson/neoload_projects/JenkinsExample/JenkinsExample.nlp
, C:\neoload_projects\JenkinsExample\JenkinsExample.nlp
or /Users/ajohnson/neoload_projects/JenkinsExample/JenkinsExample.nlp
or C:\neoload_projects\JenkinsExample\JenkinsExample.yaml
.
String
sharedProjectName
MyProjectName
.
String
scenarioName
String
htmlReport
${WORKSPACE}/neoload-report/report.html
.
String
xmlReport
${WORKSPACE}/neoload-report/report.xml
.
String
pdfReport
${WORKSPACE}/neoload-report/report.pdf
.
String
junitReport
${WORKSPACE}/neoload-report/junit-sla-results.xml
.
String
scanAllBuilds
boolean
displayTheGUI
boolean
testResultName
$Date{hh:mm - dd MMM yyyy}
is replaced by the current date by NeoLoad and the value ${BUILD_NUMBER}
is replaced by the current build number by Jenkins.
$Date{hh:mm - dd MMM yyyy} (build $${BUILD_NUMBER})
.
String
testDescription
String
licenseType
String
licenseVUCount
String
licenseVUSAPCount
String
licenseDuration
String
customCommandLineOptions
String
publishTestResults
boolean
sharedProjectServer
uniqueID
String
url
String
loginUser
String
loginPassword
class hudson.util.Secret
label
String
licenseServer
uniqueID
String
url
String
loginUser
String
loginPassword
class hudson.util.Secret
label
String
collabPath
String
licenseID
String
showTrendAverageResponse
boolean
showTrendErrorRate
boolean
graphOptionsInfo
name
String
curve
path
String
statistic
String
maxTrends
int
$class: 'NerrvanaPlugin'
settingsXmlString
String
loglevel
String
$class: 'NetStormBuilder'
URLConnectionString
String
username
String
password
String
project
String
subProject
String
scenario
String
testMode
String
baselineType
String
pollInterval
String
protocol
String
repoIp
String
repoPort
String
repoPath
String
repoUsername
String
repoPassword
String
profile
String
script
String
page
String
advanceSett
String
urlHeader
String
hiddenBox
String
gitPull
String
generateReport
boolean
doNotWaitForTestCompletion
boolean
totalusers
String
rampUpSec
String
rampupmin
String
rampuphour
String
duration
String
serverhost
String
sla
String
testName
String
scriptPath
String
rampupDuration
String
emailid
String
emailidCC
String
emailidBcc
String
testsuite
String
dataDir
String
checkRuleFileUpload
String
neuvector
repository
String
registrySelection
String
nameOfVulnerabilityToExemptFour
(optional)
String
nameOfVulnerabilityToExemptOne
(optional)
String
nameOfVulnerabilityToExemptThree
(optional)
String
nameOfVulnerabilityToExemptTwo
(optional)
String
nameOfVulnerabilityToFailFour
(optional)
String
nameOfVulnerabilityToFailOne
(optional)
String
nameOfVulnerabilityToFailThree
(optional)
String
nameOfVulnerabilityToFailTwo
(optional)
String
numberOfHighSeverityToFail
(optional)
String
numberOfMediumSeverityToFail
(optional)
String
scanLayers
(optional)
boolean
standaloneScanner
(optional)
boolean
tag
(optional)
String
$class: 'NexusArtifactUploader'
nexusVersion
String
protocol
String
nexusUrl
String
groupId
String
version
String
repository
String
credentialsId
String
artifacts
artifactId
String
type
String
classifier
String
file
String
$class: 'NexusPublisherBuildStep'
nexusInstanceId
String
nexusRepositoryId
String
packages
$class: 'MavenPackage'
mavenCoordinate
groupId
String
artifactId
String
version
String
packaging
String
mavenAssetList
filePath
String
classifier
String
extension
String
tagName
(optional)
String
nirmata
builder
Delete App in Environment
Deletes the specified application from the specified environment.
Deploy App in Environment
Deploys the specified application from catalog to specified application.
Update App in Catalog
Updates the specified application in specified catalog.
Update App in Environment
Updates the specified application in specified environment.
deleteAppInEnvironment
endpoint
String
apikey
String
environment
String
application
String
timeout
int
deployAppInEnvironment
endpoint
String
apikey
String
environment
String
application
String
timeout
int
catalog
String
directories
String
includescheck
boolean
includes
String
excludescheck
boolean
excludes
String
deployType
String
updateAppInCatalog
endpoint
String
apikey
String
catalog
String
timeout
int
directories
String
includescheck
boolean
includes
String
excludescheck
boolean
excludes
String
updateAppInEnvironment
endpoint
String
apikey
String
environment
String
application
String
timeout
int
directories
String
includescheck
boolean
includes
String
excludescheck
boolean
excludes
String
nodejsci
command
String
nodeJSInstallationName
String
cacheLocationStrategy
(optional)
default
executor
workspace
configId
(optional)
String
$class: 'NopmdCheckPublisher'
filesetList
pattern
String
excludePattern
String
$class: 'NotifyEventsBuilder'
token
String
title
String
message
String
priority
String
level
String
attachBuildLog
boolean
attachment
String
$class: 'NouvolaBuilder'
planID
String
apiKey
String
credsPass
String
waitTime
String
returnURL
String
listenTimeOut
String
$class: 'NucleiBuilder'
targetUrl
String
additionalFlags
(optional)
nuclei --help
or visit:String
nucleiVersion
(optional)
String
reportingConfiguration
(optional)
String
$class: 'NvEmulationBuilder'
serverName
String
includeClientIPs
String
excludeServerIPs
String
reportFiles
String
thresholdsFile
String
useProxyCheckbox
envVariable
String
steps
hudson.tasks.BuildStep
)profileNames
(optional)
profileName
String
$class: 'OOBuildStep'
ooServer
String
basepath
Default path: /Library
E.g.: Library/Tutorials/subflows/ Library/Templates
String
selectedFlow
String
args
name
String
value
String
retVariableToCheck
String
comparisonOrdinal
int
valueToCompareWith
String
desiredResultType
String
stepExecutionTimeout
xxx ms
. The plugin will wait for this amount of time, then it will finish the Jenkins job and it will automatically put the build in the fail/unstable state.
String
runName
String
ostorlabScan
waitForResults
boolean
riskThreshold
HIGH
, MEDIUM
, LOW
, POTENTIALLY
, HARDENING
filePath
(optional)
String
title
(optional)
String
plan
(optional)
String
platform
(optional)
String
waitMinutes
(optional)
int
breakBuildOnScore
(optional)
boolean
scoreThreshold
(optional)
HIGH
, MEDIUM
, LOW
, POTENTIALLY
, HARDENING
waitingForResults
(optional)
boolean
$class: 'Oak9Builder'
orgId
(optional)
String
projectId
(optional)
String
credentialsId
(optional)
String
maxSeverity
(optional)
int
baseUrl
(optional)
String
$class: 'OctoperfBuilder'
credentialsId
(optional)
String
workspaceId
(optional)
String
projectId
(optional)
String
scenarioId
(optional)
String
stopConditions
(optional)
? extends org.jenkinsci.plugins.octoperf.conditions.TestStopCondition
octopusPack
toolId
String
packageId
String
packageFormat
String
sourcePath
String
additionalArgs
(optional)
String
includePaths
(optional)
String
outputPath
(optional)
String
overwriteExisting
(optional)
boolean
packageVersion
(optional)
String
verboseLogging
(optional)
boolean
octopusPushBuildInformation
serverId
String
spaceId
String
toolId
String
packageId
String
packageVersion
String
commentParser
String
overwriteMode
FailIfExists
, OverwriteExisting
, IgnoreIfExists
additionalArgs
(optional)
String
gitBranch
(optional)
String
gitCommit
(optional)
String
gitUrl
(optional)
String
verboseLogging
(optional)
boolean
octopusPushPackage
serverId
String
toolId
String
packagePaths
String
overwriteMode
FailIfExists
, OverwriteExisting
, IgnoreIfExists
additionalArgs
(optional)
String
spaceId
(optional)
String
verboseLogging
(optional)
boolean
OneSky
projectId
(optional)
String
resourcesPath
(optional)
String
$class: 'OntrackDSLStep'
ontrackScriptLocation
value
String
scriptPath
String
scriptText
String
sandbox
boolean
injectEnvironment
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
ignoreFailure
boolean
$class: 'OpenShiftBuildVerifier'
apiURL
String
bldCfg
String
namespace
String
authToken
String
verbose
String
checkForTriggeredDeployments
String
waitTime
String
waitUnit
String
$class: 'OpenShiftBuilder'
apiURL
String
bldCfg
String
namespace
String
env
name
String
value
String
authToken
String
verbose
String
commitID
String
buildName
String
showBuildLogs
String
checkForTriggeredDeployments
String
waitTime
String
waitUnit
String
$class: 'OpenShiftCreator'
apiURL
String
namespace
String
authToken
String
verbose
String
jsonyaml
String
$class: 'OpenShiftDeleterJsonYaml'
apiURL
String
namespace
String
authToken
String
verbose
String
jsonyaml
String
$class: 'OpenShiftDeleterLabels'
apiURL
String
namespace
String
authToken
String
verbose
String
types
String
keys
String
values
String
$class: 'OpenShiftDeleterList'
apiURL
String
namespace
String
authToken
String
verbose
String
types
String
keys
String
$class: 'OpenShiftDeployer'
apiURL
String
depCfg
String
namespace
String
authToken
String
verbose
String
waitTime
String
waitUnit
String
$class: 'OpenShiftDeploymentVerifier'
apiURL
String
depCfg
String
namespace
String
replicaCount
String
authToken
String
verbose
String
verifyReplicaCount
String
waitTime
String
waitUnit
String
$class: 'OpenShiftExec'
apiURL
String
namespace
String
authToken
String
verbose
String
pod
String
container
String
command
String
arguments
value
String
waitTime
String
waitUnit
String
$class: 'OpenShiftImageTagger'
apiURL
String
testTag
String
prodTag
String
namespace
String
authToken
String
verbose
String
testStream
String
prodStream
String
destinationNamespace
String
destinationAuthToken
String
alias
String
$class: 'OpenShiftScaler'
apiURL
String
depCfg
String
namespace
String
replicaCount
String
authToken
String
verbose
String
verifyReplicaCount
String
waitTime
String
waitUnit
String
$class: 'OpenShiftServiceVerifier'
apiURL
String
svcName
String
namespace
String
authToken
String
verbose
String
$class: 'OrchestratorBuilder'
serverUrl
String
userName
String
password
String
tenant
String
workflowName
String
waitExec
boolean
inputParams
name
String
type
String
value
String
cfyOutputsToInputs
This step maps outputs and capabilities, of an environment created by Cloudify, into inputs of another deployment.
This step takes two inputs:
The format of the mapping JSON is as follows:
{ "outputs": { "<output_name>": "<input_name>", "<output_name>": "<input_name>", ... }, "capabilities": { "<capability_name>": "<input_name>", "<capability_name>": "<input_name>", ... } }
At the end, a file will be generated, containing a JSON compatible with Cloudify's standard "Deployment Inputs" structure, namely:
{ "<input_name>": "<intput_value>", "<input_name>": "<intput_value>", ...
For example, if the "outputs file" is as follows:
{ "outputs": { "endpoint": "10.0.0.130", "username": "centos" }, "capabilities": { "public_key": "/tmp/public_key" } }
And the mapping is as follows:
{ "outputs": { "username": "app_username" }, "capabilities": { "public_key": "app_data" } }
Then the resultant inputs file will be as follows:
{ "app_username": "centos", "app_data": "/tmp/public_key" }
credentialsId
(optional)
String
inputsLocation
(optional)
Path to the inputs file to be created.
String
mapping
(optional)
A JSON containing mapping between outputs/capabilities and inputs. For information about the structure, refer to the tooltip of this build step.
String
mappingLocation
(optional)
A JSON containing mapping between outputs/capabilities and inputs. For information about the structure, refer to the tooltip of this build step.
String
outputsLocation
(optional)
Location of the outputs JSON file, containing outputs and capabilities of another deployment. The file must be in the following format:
{ "outputs": { "<output_name>": "<output_value>", "<output_name>": "<output_value>", ... }, "capabilities": { "<capability_name>": "<capability_value>", "<capability_name>": "<capability_value>", ... } }
String
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
oversecuredUpload
apkPath
String
integrationId
String
dotnetPack
dotnet pack
command builds the project and creates NuGet packages. The result of this command is a NuGet package (that is, a .nupkg file).
configuration
(optional)
Debug
, but you can override the build configuration settings in your project.
String
force
(optional)
boolean
includeSource
(optional)
src
folder within the symbols package.
boolean
includeSymbols
(optional)
boolean
noBuild
(optional)
boolean
noDependencies
(optional)
boolean
noRestore
(optional)
boolean
nologo
(optional)
boolean
option
(optional)
String
options
(optional)
String
optionsString
(optional)
String
outputDirectory
(optional)
String
project
(optional)
String
properties
(optional)
java.util.Map<java.lang.String, java.lang.String>
propertiesString
(optional)
String
runtime
(optional)
String
sdk
(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.
String
showSdkInfo
(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.
boolean
shutDownBuildServers
(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).
boolean
specificSdkVersion
(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.
boolean
unstableIfWarnings
(optional)
boolean
verbosity
(optional)
String
versionSuffix
(optional)
$(VersionSuffix)
MSBuild property in the project.
String
workDirectory
(optional)
String
uTesterPageCountTask
initialUrl
String
urlsWhiteList
String
pageCount
int
rulesList
rule
String
complianceMinimum
float
allowSimultaneousLogins
boolean
loginFlowJson
String
useRunner
boolean
fetchResponseTimeout
int
$class: 'ParallelTestExecutor'
This builder can be used with any test job that (1) produce JUnit-compatible XML files, and (2) accept a test-exclusion list in a file. This builder looks at the test execution time from the last time, and divide tests into multiple units of roughly equal size. Each unit is then converted into the exclusion list (by excluding all but the tests that assigned to that unit), and the test job is triggered for each unit, with the exclusion file placed inside the workspace at your specified location.
Optionally, if your test job supports it, you may provide a test-inclusion file name. If defined, the plugin will generate inclusion lists for all parallel units but one which will still use exclusion list. This avoids new test cases from being included in all units on their first run. If you don't use an inclusion file, when a new test is added, the first build afterward will be executed in all the sub-builds, because it's not in the exclusion list on any of the units.
You are responsible for configuring the build script in the test job to honor the exclusion and inclusion file. A standard technique is to write the build script to always refer to a fixed exclusion list file, and check in an empty file by that name to your SCM. You can then specify that file as the "exclusion file name" in the configuration of this builder, and the builder will overwrite the empty file from SCM by the generated one.
Similarly, you are responsible for checking "Execute concurrent builds if necessary" on the test job to allow the concurrent execution.
At the end of the executions of the test job, the specified report directories are brought back into this job's workspace, then the standard JUnit test report collector will tally them.
parallelism
count
size
int
time
This value counts just the time spent on executing tests, and not including other time such as checking out the code, building the test, etc. For example, if your test job spends 50 minutes in tests and 60 minutes total from start to finish, then you have 10 minutes "fixed" overhead regardless of the number of tests it executes. If you use this mode and set the value to "10 minutes", then you'll have 5 parallel sub-tasks that all ends in roughly 20 minutes (20 mins = 10 mins tests time + 10 mins overhead.)
"N minutes per a sub-task" is a goal, not a hard constraint. So a sub-task can take longer (for example if you have a single test that takes more than N minutes.)
mins
int
testJob
String
patternFile
String
testReportFiles
The path is relative to the workspace of the test job. For Maven builds, this value is normally "**/target/surefire-reports/".
String
archiveTestResults
boolean
parameters
$class: 'BooleanParameters'
configs
name
String
value
boolean
$class: 'CurrentBuildParameters'
$class: 'FileBuildParameters'
propertiesFile
String
encoding
String
failTriggerOnMissing
boolean
useMatrixChild
boolean
combinationFilter
String
onlyExactRuns
boolean
textParamValueOnNewLine
boolean
$class: 'GeneratorCurrentParameters'
$class: 'GitRevisionBuildParameters'
combineQueuedCommits
boolean
$class: 'MatrixSubsetBuildParameters'
filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggered job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String
$class: 'NodeLabelBuildParameter'
name
String
nodeLabel
String
$class: 'NodeParameters'
$class: 'PredefinedBuildParameters'
properties
String
textParamValueOnNewLine
boolean
$class: 'PredefinedGeneratorParameters'
properties
String
$class: 'SubversionRevisionBuildParameters'
includeUpstreamParameters
boolean
estimateTestsFromFiles
boolean
includesPatternFile
(optional)
String
$class: 'ParameterPoolBuilder'
projects
String
name
String
values
String
preferError
boolean
$class: 'PartialReleaseMgrSuccessfulBuilder'
pcBuild
serverAndPort
String
pcServerName
String
credentialsId
String
almDomain
String
almProject
String
testId
String
testInstanceId
String
autoTestInstanceID
String
timeslotDurationHours
String
timeslotDurationMinutes
String
postRunAction
COLLATE
, COLLATE_AND_ANALYZE
, DO_NOTHING
vudsMode
boolean
statusBySLA
boolean
description
String
addRunToTrendReport
String
trendReportId
String
HTTPSProtocol
boolean
proxyOutURL
String
credentialsProxyId
String
retry
String
retryDelay
String
retryOccurrences
String
authenticateWithToken
boolean
pcGitBuild
description
String
pcServerName
String
httpsProtocol
boolean
credentialsId
String
almDomain
String
almProject
String
serverAndPort
String
proxyOutURL
String
credentialsProxyId
String
subjectTestPlan
String
uploadScriptMode
RUNTIME_FILES
, ALL_FILES
removeScriptFromPC
YES
, NO
importTests
Note:
Parameter | Description | Required |
---|---|---|
controller |
Defines the Controller to be used during the test run (it must be an available host in the LoadRunner Enterprise project). If not specified, a Controller will be chosen from the different controllers available in the LoadRunner Enterprise project.
From Performance Center 12.62 and plugin version 1.1.1, the option to provision a Controller as a Docker image is available by specifying the value "Elastic" and providing a value for the 'controller_elastic_configuration' parameter (see 'controller_elastic_configuration' table below).
|
No |
lg_amount | Number of load generators to allocate to the test (every group in the test will be run by the same load generators). | Not required if each group defined in the 'group' parameter defines the load generators it will be using via the 'lg_name' parameter (see 'group' table below). |
group | Lists all groups or scripts defined in the test. The parameter to be used in each group are specified in the 'group' table below. | Yes |
scheduler | Defines the duration of a test, and determines whether virtual users are started simultaneously or gradually. See the 'scheduler' table below. | No |
lg_elastic_configuration | Defines the image to be used in order to provision load generators. See the 'lg_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if a load generator is defined to be provisioned from a Docker image. |
controller_elastic_configuration | Defines the image to be used in order to provision the Controller. See the 'controller_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if the Controller is defined to be provisioned from a Docker image. |
Parameter | Description | Required |
---|---|---|
group_name | Name of the group (it must be a unique name if several groups are defined). | Yes |
vusers | Number of virtual users to allocate to the group for running the script. | Yes |
script_id | ID of the script in the LoadRunner Enterprise project. | Not required if the 'script_path' parameter is specified. |
script_path | Path and name of the script to be added to the group, separated by double backslashes (\\). For example "MyMainFolder\\MySubFolder\\MyScriptName'. Do not include the LoadRunner Enterprise root folder (named "Subject"). | Not required if 'script_id' parameter is specified |
lg_name | List of load generators to allocate to the group for running the script. The supported values are:
|
No |
command_line | The command line applied to the group. | No |
rts | Object defining the runtime settings of the script. See the 'rts' table below. | No |
Parameter | Description | Required |
---|---|---|
pacing | Can be used to define the number of iterations the script will run and the required delay between iterations (see the 'pacing' table below). | No |
thinktime | Can be used to define think time (see the 'thinktime' table below). | No |
java_vm | Can be used when defining Java environment runtime settings (see the 'java_vm' table below). | No |
jmeter | Can be used to define JMeter environment runtime settings (see the 'jmeter' table below). | No |
Parameter | Description | Required |
---|---|---|
number_of_iterations | Specifies the number of iterations to run; this must be a positive number. | Yes |
type | Possible values for type attribute are:
|
No |
delay | Non-negative number (less than 'delay_at_range_to_seconds' when specified). | Depends on the value provided for the 'type' parameter. |
delay_random_range | Non-negative number. It will be added to the value given to the 'delay' parameter (the value will be randomly chosen between the value given to 'delay' parameter and the same value to which is added the value of this parameter). | Depends on the value provided for the 'type' parameter. |
Parameter | Description | Required |
---|---|---|
type | The ThinkTime Type attribute is one of:
|
No |
min_percentage | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
max_percentage | This must be a positive number (it must be larger than the value provided for the 'min_percentage' parameter). | Depends on the value provided for the 'type' parameter. |
limit_seconds | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
multiply_factor | The recorded think time is multiplied by this factor at runtime. | Depends on the value provided for the 'type' parameter. |
Parameter | Description | Required |
---|---|---|
jdk_home | The JDK installation path. | No |
java_vm_parameters | List the Java command line parameters. These parameters can be any JVM argument. The common arguments are the debug flag (-verbose) or memory settings (-ms, -mx). In additional, you can also pass properties to Java applications in the form of a -D flag. | No |
use_xboot | Boolean: Instructs VuGen to add the Classpath before the Xbootclasspath (prepend the string). | No |
enable_classloader_per_vuser | Boolean: Loads each Virtual User using a dedicated class loader (runs Vusers as threads). | No |
java_env_class_paths | A list of classpath entries. Use a double backslash (\\) for folder separators. | No |
Parameter | Description | Required |
---|---|---|
start_measurements | Boolean value to enable JMX measurements during performance test execution. | No |
jmeter_home_path | Path to JMeter home. If not defined, the path from the %JMETER_HOME% environment variable is used. | No |
jmeter_min_port | This number must be lower than the value provided in the 'jmeter_max_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
jmeter_max_port | This number must be higher than the value provided in the 'jmeter_min_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
jmeter_additional_properties | JMeter additional properties file. Use double slash (\\) for folder separator. | No |
Parameter | Description | Required |
---|---|---|
rampup | Time, in seconds, to gradually start all virtual users. Additional virtual users are added every 15 seconds until the time specified in the parameter ends. If no value is specified, all virtual users are started simultaneously at the beginning of the test. | No |
duration | Time, in seconds, that it will take to run the test after all virtual users are started. After this time, the test run ends. If not specified, the test will run until completion. | No |
Parameter | Description | Required |
---|---|---|
image_id | This number can be retrieved from:
|
Yes if one of the load generator is defined to be provisioned from Docker image. |
memory_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
cpu_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
Parameter | Description | Required |
---|---|---|
image_id | This number can be retrieved from:
|
Yes if the Controller is defined to be provisioned from Docker image. |
memory_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
cpu_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
##################################################
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
Duration: '300'
##################################################
##################################################
controller: "mycontroller"
lg_amount: 3
group:
- group_name: "JavaVuser_LR_Information_pacing_immediately_thinktime_ignore"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "immediately"
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
use_xboot: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "ignore"
- group_name: "JavaHTTP_BigXML_pacing_fixed_delay_thinktime_replay"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed delay"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
thinktime:
type: "replay"
limit_seconds: 30
- group_name: "JavaVuser_LR_Information_immediately_pacing_random_delay_thinktime_modify"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "random delay"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "modify"
limit_seconds: 30
multiply_factor: 2
- group_name: "JavaHTTP_BigXML_pacing_fixed_interval_thinktime_random"
vusers: 50
#script_id: 392
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed interval"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "random"
limit_seconds: 30
min_percentage: 2
max_percentage: 3
- group_name: "JavaHTTP_BigXML_pacing_random_interval"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
- group_name: "Mtours_pacing_random_interval"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
jmeter_home_path: "c:\\jmeter"
jmeter_min_port: 2001
jmeter_max_port: 3001
jmeter_additional_properties: "jmeter_additional_properties"
- group_name: "Mtours_pacing_random_interval_Jmeter_default_port"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
scheduler:
rampup: 120
duration: 600
##################################################
YES
, NO
authenticateWithToken
boolean
pcRunBuild
serverAndPort
String
pcServerName
String
credentialsId
String
almDomain
String
almProject
String
testToRun
String
testId
String
testContentToCreate
The content of the field must either be:
Note:
Parameter | Description | Required |
---|---|---|
test_name | The test name. | Yes |
test_folder_path | The location of the test in the Test Management folder tree of the LoadRunner Enterprise project. The folders should be separated by double backslashes (\\). For example, "MyMainFolder\\MySubfolder\\MySubSubFolder". Do not include the LoadRunner Enterprise root folder (named "Subject") | Yes |
test_content | The content of the test that requires additional parameters specified in the 'test_content' table below. | Yes |
Parameter | Description | Required |
---|---|---|
controller |
Defines the Controller to be used during the test run (it must be an available host in the LoadRunner Enterprise project). If not specified, a Controller will be chosen from the different controllers available in the LoadRunner Enterprise project.
From Performance Center 12.62 and plugin version 1.1.1, the option to provision a Controller as a Docker image is available by specifying the value "Elastic" and providing a value for the 'controller_elastic_configuration' parameter (see 'controller_elastic_configuration' table below).
|
No |
lg_amount | Number of load generators to allocate to the test (every group in the test will be run by the same load generators). | Not required if each group defined in the 'group' parameter defines the load generators it will be using via the 'lg_name' parameter (see 'group' table below). |
group | Lists all groups or scripts defined in the test. The parameter to be used in each group are specified in the 'group' table below. | Yes |
scheduler | Defines the duration of a test, and determines whether virtual users are started simultaneously or gradually. See the 'scheduler' table below. | No |
lg_elastic_configuration | Defines the image to be used in order to provision load generators. See the 'lg_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if a load generator is defined to be provisioned from a Docker image. |
controller_elastic_configuration | Defines the image to be used in order to provision the Controller. See the 'controller_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if the Controller is defined to be provisioned from a Docker image. |
Parameter | Description | Required |
---|---|---|
group_name | Name of the group (it must be a unique name if several groups are defined). | Yes |
vusers | Number of virtual users to allocate to the group for running the script. | Yes |
script_id | ID of the script in the LoadRunner Enterprise project. | Not required if the 'script_path' parameter is specified. |
script_path | Path and name of the script to be added to the group, separated by double backslashes (\\). For example "MyMainFolder\\MySubFolder\\MyScriptName'. Do not include the LoadRunner Enterprise root folder (named "Subject"). | Not required if 'script_id' parameter is specified |
lg_name | List of load generators to allocate to the group for running the script. The supported values are:
|
No |
command_line | The command line applied to the group. | No |
rts | Object defining the runtime settings of the script. See the 'rts' table below. | No |
Parameter | Description | Required |
---|---|---|
pacing | Can be used to define the number of iterations the script will run and the required delay between iterations (see the 'pacing' table below). | No |
thinktime | Can be used to define think time (see the 'thinktime' table below). | No |
java_vm | Can be used when defining Java environment runtime settings (see the 'java_vm' table below). | No |
jmeter | Can be used to define JMeter environment runtime settings (see the 'jmeter' table below). | No |
Parameter | Description | Required |
---|---|---|
number_of_iterations | Specifies the number of iterations to run; this must be a positive number. | Yes |
type | Possible values for type attribute are:
|
No |
delay | Non-negative number (less than 'delay_at_range_to_seconds' when specified). | Depends on the value provided for the 'type' parameter. |
delay_random_range | Non-negative number. It will be added to the value given to the 'delay' parameter (the value will be randomly chosen between the value given to 'delay' parameter and the same value to which is added the value of this parameter). | Depends on the value provided for the 'type' parameter. |
Parameter | Description | Required |
---|---|---|
type | The ThinkTime Type attribute is one of:
|
No |
min_percentage | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
max_percentage | This must be a positive number (it must be larger than the value provided for the 'min_percentage' parameter). | Depends on the value provided for the 'type' parameter. |
limit_seconds | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
multiply_factor | The recorded think time is multiplied by this factor at runtime. | Depends on the value provided for the 'type' parameter. |
Parameter | Description | Required |
---|---|---|
jdk_home | The JDK installation path. | No |
java_vm_parameters | List the Java command line parameters. These parameters can be any JVM argument. The common arguments are the debug flag (-verbose) or memory settings (-ms, -mx). In additional, you can also pass properties to Java applications in the form of a -D flag. | No |
use_xboot | Boolean: Instructs VuGen to add the Classpath before the Xbootclasspath (prepend the string). | No |
enable_classloader_per_vuser | Boolean: Loads each Virtual User using a dedicated class loader (runs Vusers as threads). | No |
java_env_class_paths | A list of classpath entries. Use a double backslash (\\) for folder separators. | No |
Parameter | Description | Required |
---|---|---|
start_measurements | Boolean value to enable JMX measurements during performance test execution. | No |
jmeter_home_path | Path to JMeter home. If not defined, the path from the %JMETER_HOME% environment variable is used. | No |
jmeter_min_port | This number must be lower than the value provided in the 'jmeter_max_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
jmeter_max_port | This number must be higher than the value provided in the 'jmeter_min_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
jmeter_additional_properties | JMeter additional properties file. Use double slash (\\) for folder separator. | No |
Parameter | Description | Required |
---|---|---|
rampup | Time, in seconds, to gradually start all virtual users. Additional virtual users are added every 15 seconds until the time specified in the parameter ends. If no value is specified, all virtual users are started simultaneously at the beginning of the test. | No |
duration | Time, in seconds, that it will take to run the test after all virtual users are started. After this time, the test run ends. If not specified, the test will run until completion. | No |
Parameter | Description | Required |
---|---|---|
image_id | This number can be retrieved from:
|
Yes if one of the load generator is defined to be provisioned from Docker image. |
memory_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
cpu_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
Parameter | Description | Required |
---|---|---|
image_id | This number can be retrieved from:
|
Yes if the Controller is defined to be provisioned from Docker image. |
memory_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
cpu_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
##################################################
test_name: mytestname
test_folder_path: "Tests\\mytests"
test_content:
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
duration: '300'
##################################################
##################################################
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
duration: '300'
##################################################
##################################################
controller: "mycontroller"
lg_amount: 3
group:
- group_name: "JavaVuser_LR_Information_pacing_immediately_thinktime_ignore"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "immediately"
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
use_xboot: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "ignore"
- group_name: "JavaHTTP_BigXML_pacing_fixed_delay_thinktime_replay"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed delay"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
thinktime:
type: "replay"
limit_seconds: 30
- group_name: "JavaVuser_LR_Information_immediately_pacing_random_delay_thinktime_modify"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "random delay"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "modify"
limit_seconds: 30
multiply_factor: 2
- group_name: "JavaHTTP_BigXML_pacing_fixed_interval_thinktime_random"
vusers: 50
#script_id: 392
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed interval"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "random"
limit_seconds: 30
min_percentage: 2
max_percentage: 3
- group_name: "JavaHTTP_BigXML_pacing_random_interval"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
- group_name: "Mtours_pacing_random_interval"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
jmeter_home_path: "c:\\jmeter"
jmeter_min_port: 2001
jmeter_max_port: 3001
jmeter_additional_properties: "jmeter_additional_properties"
- group_name: "Mtours_pacing_random_interval_Jmeter_default_port"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
scheduler:
rampup: 120
duration: 600
##################################################
String
testInstanceId
String
autoTestInstanceID
String
timeslotDurationHours
String
timeslotDurationMinutes
String
postRunAction
COLLATE
, COLLATE_AND_ANALYZE
, DO_NOTHING
vudsMode
boolean
statusBySLA
boolean
description
String
addRunToTrendReport
String
trendReportId
String
HTTPSProtocol
boolean
proxyOutURL
String
credentialsProxyId
String
retry
String
retryDelay
String
retryOccurrences
String
authenticateWithToken
boolean
activateDTConfiguration
dynatraceProfile
String
configuration
String
createMemoryDump
dynatraceProfile
String
agent
String
host
String
autoPostProcess
(optional)
boolean
capturePrimitives
(optional)
boolean
captureStrings
(optional)
boolean
dogc
(optional)
boolean
lockSession
(optional)
boolean
type
(optional)
String
startSession
dynatraceProfile
String
testCase
String
lockSession
(optional)
boolean
recordingOption
(optional)
String
stopSession
dynatraceProfile
String
createThreadDump
dynatraceProfile
String
agent
String
host
String
lockSession
(optional)
boolean
$class: 'PerformanceAnalysisBuilder'
testjob
Specify the data set name that contains the mainframe job that you want to run the performance benchmarking for, for example, TEST.POC.JCLLIB(TESTJOB).
The maximum length is 44 characters.
Ensure that the job is included in the monitoring scope of the CA MAT Performance Benchmarking plugin by Broadcom.
String
blazeMeterTest
credentialsId
(optional)
String
workspaceId
(optional)
String
testId
(optional)
String
abortJob
(optional)
boolean
additionalTestFiles
(optional)
String
getJtl
(optional)
boolean
getJunit
(optional)
boolean
jobApiKey
(optional)
String
jtlPath
(optional)
String
junitPath
(optional)
String
mainTestFile
(optional)
String
notes
(optional)
String
reportLinkName
(optional)
String
serverUrl
(optional)
String
sessionProperties
(optional)
String
bzt
params
String
alwaysUseVirtualenv
(optional)
boolean
bztVersion
(optional)
String
generatePerformanceTrend
(optional)
boolean
printDebugOutput
(optional)
boolean
useBztExitCode
(optional)
boolean
useSystemSitePackages
(optional)
boolean
virtualEnvCommand
(optional)
String
workingDirectory
(optional)
String
workspace
(optional)
String
$class: 'PhingBuilder'
name
String
buildFile
If your build requires a custom -buildfile, specify it here. By default Phing will use the build.xml in the module directory, this option can be used to use build files with a different name or in somewhere outside the top directory.
And you can use environment variables such like ''$WORKSPACE''.
String
targets
String
properties
# comment name1=value1 name2=value2These are passed to Phing like "-Dname1=value1 -Dname2=value2"
String
useModuleRoot
boolean
options
String
$class: 'PipelineGenerationStep'
project
Name of the project. It is used as an identifier in the corresponding pipelines, folders and jobs being generated.
String
projectScmType
Type of the SCM. Currently only svn
and git
are supported.
String
projectScmUrl
URL to the project SCM. Without any branch indication.
For example:
svn
, URL to the root of the project, without trunk
or branches
. git
, URL of the remote.String
projectScmCredentials
ID or UUID of the Jenkins credentials to use when connecting to the project SCM.
String
branch
SCM branch.
String
seedProject
Project name useable for folders, job names, etc.
String
seedBranch
Branch name useable for folders, job names, etc.
String
disableDslScript
If checked, the pipeline generation disallows the direct execution of a DSL Groovy script. Only DSL libraries, configured through a seed.properties file are allowed. By default, both modes are allowed.
boolean
scriptDirectory
Path to the directory which contains the pipeline script. Defaults to seed
if not filled.
String
plot
group
String
style
String
csvFileName
String
csvSeries
(optional)
file
String
url
String
inclusionFlag
String
exclusionValues
String
displayTableFlag
boolean
description
(optional)
String
exclZero
(optional)
boolean
keepRecords
(optional)
boolean
logarithmic
(optional)
boolean
numBuilds
(optional)
String
propertiesSeries
(optional)
file
String
label
String
title
(optional)
String
useDescr
(optional)
boolean
xmlSeries
(optional)
file
String
xpath
String
nodeType
String
url
String
yaxis
(optional)
String
yaxisMaximum
(optional)
String
yaxisMinimum
(optional)
String
$class: 'PolarisBuildStep'
createChangeSetFile
(optional)
Creates a file at $CHANGE_SET_FILE_PATH (by default, the workspace directory) containing a list of files generated from the Jenkins-provided scm changeset.
Used for Incremental analysis (--incremental) as the file containing the list of changed files for analysis.
buildStatusOnSkip
(optional)
The action to take when static analysis is skipped because the changeset contained no files to analyze. Defaults to "Mark the build as Unstable".
SUCCESS
, FAILURE
, UNSTABLE
changeSetExclusionPatterns
(optional)
Specify a comma separated list of filename patterns that you would like to explicitly excluded from the Jenkins-provided SCM changeset.
The pattern is applied to determine which files will be populated in the changeset file, stored at $CHANGE_SET_FILE_PATH.
If blank, will exclude none.
Examples:
File Name | Pattern | Will be excluded |
---|---|---|
test.java | *.java | Yes |
test.java | *.jpg | No |
test.java | test.* | Yes |
test.java | test.???? | Yes |
test.java | test.????? | No |
String
changeSetInclusionPatterns
(optional)
Specify a comma separated list of filename patterns that you would like to explicitly included Jenkins-provided SCM changeset.
The pattern is applied to determine which files will be populated in the changeset file, stored at $CHANGE_SET_FILE_PATH.
If blank, will include all. Examples:
File Name | Pattern | Will be included |
---|---|---|
test.java | *.java | Yes |
test.java | *.jpg | No |
test.java | test.* | Yes |
test.java | test.???? | Yes |
test.java | test.????? | No |
String
polarisArguments
(optional)
The command line arguments to pass to the CLI
String
polarisCliName
(optional)
The CLI installation to execute
String
waitForIssues
(optional)
Check this box to wait for CLI jobs to complete and set the build status based on issues discovered
buildStatusForIssues
(optional)
The build status to set the project to if there are issues
SUCCESS
, FAILURE
, UNSTABLE
jobTimeoutInMinutes
(optional)
The maximum number of minutes to wait for jobs started by the Polaris CLI to complete when the Polaris CLI is executed without -w (nonblocking mode). Must be a positive integer, defaults to 30 minutes.
int
fortiCWPScanner
imageName
String
block
(optional)
boolean
portshift_vulnerability_scanner
accessKey
String
secretKey
String
imageName
String
imageTag
String
url
String
scannerIp
String
$class: 'PowerShell'
command
String
stopOnError
Stops script when some step fails. Similar to Shell set -e. Translates to $ErrorActionPreference Stop or Continue. See documentation.
boolean
useProfile
Runs script with default profile or no profile. See documentation.
boolean
unstableReturn
(optional)
int
$class: 'PowerShellBuildStep'
buildStepId
String
defineArgs
boolean
buildStepArgs
arg
String
$class: 'PreflightBuilder'
clientId
String
clientSecret
String
testId
String
groupId
String
environmentId
String
platforms
win-chrome
.win-chrome,win-firefox
win
chrome, ie, edge, firefox
String
sizes
1440x900
.1920x1080, 1440x900
1920x1080, 1440x900, 1024x768, 480x640
String
captureScreenshots
boolean
waitResults
boolean
$class: 'PrereqBuilder'
projects
String
warningOnly
boolean
probelyScan
targetId
ID of the target you want Probely to scan.
String
authToken
(optional)
Raw Probely API authentication key.
Please use the credentialsId field instead, unless you understand the security implications of using this mechanism. Passing the API authentication token directly is not advised, unless it is properly secured using a secret storage mechanism, such as HashiCorp Vault.
String
credentialsId
(optional)
Credential identifier for the Probely API authentication key.
String
failThreshold
(optional)
Mark the build as failed if a vulnerability with the following severity level is found.
String
stopIfFailed
(optional)
If the build fails because the target is vulnerable, stop scanning for more vulnerabilities.
boolean
waitForScan
(optional)
Wait for the scan to complete before proceeding to the next step in the pipeline.
Since a scan can take a long time, the plugin will return as soon as the scan starts. This is enabled by default to make the build faster.
Please note that disabling this option implies that the build step always finishes successfully, even if vulnerabilities are found later on.
Enabling this option allows the plugin to mark the build as failed if it finds any vulnerabilities.
boolean
$class: 'ProjectGenerationStep'
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
$class: 'ProjectPrerequisitesInstaller'
protecodesc
credentialsId
(optional)
String
protecodeScGroup
(optional)
Group ID can be found from the BDBA service by looking at the URL when browsing an individual group: https://protecode-sc.mydomain.com/group/1234/
or with Groups API https://protecode-sc.mydomain.com/api/groups/
.
String
convertToSummary
(optional)
protecodesc.xml
.
boolean
customHeader
(optional)
String
directoryToScan
(optional)
String
dontZipFiles
(optional)
boolean
endAfterSendingFiles
(optional)
boolean
failIfVulns
(optional)
boolean
includeSubdirectories
(optional)
boolean
pattern
(optional)
String
protecodeScanName
(optional)
String
scanOnlyArtifacts
(optional)
boolean
scanTimeout
(optional)
int
$class: 'ProxyBuilder'
projectName
String
dotnetPublish
dotnet publish
compiles the application, reads through its dependencies specified in the project file, and publishes the resulting set of files to a directory. The output includes the following assets:
dotnet publish
command's output is ready for deployment to a hosting system (for example, a server, PC, Mac, laptop) for execution. It's the only officially supported way to prepare the application for deployment. Depending on the type of deployment that the project specifies, the hosting system may or may not have the .NET Core shared runtime installed on it. For more information, see Publish .NET Core apps with the .NET Core CLI .
configuration
(optional)
Debug
, but you can override the build configuration settings in your project.
String
force
(optional)
boolean
framework
(optional)
String
manifest
(optional)
String
manifests
(optional)
String
manifestsString
(optional)
dotnet store command
.
String
noBuild
(optional)
boolean
noDependencies
(optional)
boolean
noRestore
(optional)
boolean
nologo
(optional)
boolean
option
(optional)
String
options
(optional)
String
optionsString
(optional)
String
outputDirectory
(optional)
dotnet publish
commands result in nested output folders. For example, if the project folder is myproject, and the publish output folder is myproject/publish, and you run dotnet publish
twice, the second run puts content files such as .config and .json files in myproject/publish/publish. To avoid nesting publish folders, specify a publish folder that is not directly under the project folder, or exclude the publish folder from the project.
PublishDir
property instead of this option. String
project
(optional)
String
properties
(optional)
java.util.Map<java.lang.String, java.lang.String>
propertiesString
(optional)
dotnet publish
:
PublishProfile=Properties\PublishProfiles\profile.pubxml
: Use a .pubxml to set publish-related properties. See Visual Studio publish profiles (.pubxml) for ASP.NET Core app deployment for more information. PublishReadyToRun=true
: Compiles application assemblies as ReadyToRun (R2R) format. R2R is a form of ahead-of-time (AOT) compilation. For more information, see ReadyToRun images.PublishSingleFile=true
: Packages the app into a platform-specific single-file executable. The executable is self-extracting and contains all dependencies (including native) that are required to run the app. When the app is first run, the application is extracted to a directory based on the app name and build identifier. Startup is faster when the application is run again. The application doesn't need to extract itself a second time unless a new version is used.PublishTrimmed=true
: Trims unused libraries to reduce the deployment size of an app when publishing a self-contained executable. For more information, see Trim self-contained deployments and executables .PublishProfile
, in a publish profile rather than here.
String
runtime
(optional)
String
sdk
(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.
String
selfContained
(optional)
boolean
showSdkInfo
(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.
boolean
shutDownBuildServers
(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).
boolean
specificSdkVersion
(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.
boolean
unstableIfWarnings
(optional)
boolean
verbosity
(optional)
String
versionSuffix
(optional)
*
) in the version field of the project file.
String
workDirectory
(optional)
String
snPublishApp
credentialsId
(optional)
String
apiVersion
(optional)
String
appScope
(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.
String
appSysId
(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.
String
appVersion
(optional)
String
devNotes
(optional)
String
incrementBy
(optional)
int
isAppCustomization
(optional)
boolean
obtainVersionAutomatically
(optional)
boolean
url
(optional)
String
artifactVersion
name
(optional)
String
description
(optional)
String
type
(optional)
String
groupId
(optional)
String
artifactId
(optional)
String
stage
(optional)
String
flow
(optional)
String
stageDescription
(optional)
String
version
(optional)
String
$class: 'PublishBuilder'
packageid
String
nugetFeedUrl
String
nugetFeedApiKey
class hudson.util.Secret
packageVersion
String
sqlChangeAutomationVersionOption
value
Latest
, Specific
specificVersion
String
$class: 'PublishStepBuilder'
packageId
String
nugetFeedUrl
String
nugetFeedUrlApi
class hudson.util.Secret
packageVersion
String
$class: 'PullRequestCommenter'
comment
String
dotnetNuGetPush
dotnet nuget push
command pushes a package to the server and publishes it. The push command uses server and credential details found in the system's NuGet config file or chain of config files. For more information on config files, see Configuring NuGet Behavior. NuGet's default configuration is obtained by loading %AppData%\NuGet\NuGet.config (Windows) or $HOME/.local/share (Linux/macOS), then loading any nuget.config or .nuget\nuget.config starting from the root of drive and ending in the current directory.
dotnet pack
.
apiKeyId
(optional)
String
disableBuffering
(optional)
boolean
forceEnglishOutput
(optional)
boolean
noServiceEndpoint
(optional)
boolean
noSymbols
(optional)
boolean
root
(optional)
String
sdk
(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.
String
showSdkInfo
(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.
boolean
skipDuplicate
(optional)
boolean
source
(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
).
DefaultPushSource
config value is set in the NuGet config file.
String
specificSdkVersion
(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.
boolean
symbolApiKeyId
(optional)
String
symbolSource
(optional)
String
timeout
(optional)
int
workDirectory
(optional)
String
artifactVersion
variableName
String
name
(optional)
String
stage
(optional)
String
version
(optional)
String
$class: 'PushBuilder'
remoteImageStrategy
DO_NOT_USE
, GENERATE_GIT
, FIXED
hubUrls
String
organization
String
overwriteOrganization
boolean
remoteImageName
String
dateFormat
y|Y | Year |
M | Month |
w | Week in year |
W | Week in month |
D | Day in year |
d | Day in month |
F | Day of week in month |
E | Day name in week |
u | Day number of week (1 = Monday, ..., 7 = Sunday) |
H | Hour in day (0-23) |
k | Hour in day (1-24) |
K | Hour in am/pm (0-11) |
h | Hour in am/pm (1-12) |
String
appendDate
boolean
incrementVersion
boolean
$class: 'Python'
Runs a Python script (defaults to python interpreter) for building the project. The script will be run with the workspace as the current directory.
command
String
$class: 'PythonBuilder'
pythonName
String
nature
String
command
String
ignoreExitCode
boolean
qualityCloudsScan
credentialsId
String
instanceUrl
String
issuesCountThreshold
int
techDebtThreshold
int
qcThreshold
int
highSeverityThreshold
int
$class: 'QFTestConfigBuilder'
The QF-Test build step. Invokes QF-Test binary during your Jenkins job. If not listed in your PATH variable, the location of the QF-Test binary can be specified explicitly.
The actual test configuration is set via pairs of arguments and suite file fields. The Advanced Test result control button allows to adjust the mapping between the QF-Test result and the Jenkins build result.
All report files that are produced will be stored in an output directory relative to your workspace, whose structure is as follows:
<LOGDIR> ├── html (HTML report directory) ├── junit (junit report directory) └── qrz (QF-Test runlogs)The resulting runlogs are automatically declared as Jenkins build artificats and should appear as such on the Jenkins build page. The junit and html reports can be processed further by the junit respectively the publishHTML plugin.
suitefield
suitename
String
customParam
String
customPath
(optional)
String
onTestError
(optional)
String
onTestException
(optional)
String
onTestFailure
(optional)
String
onTestWarning
(optional)
String
reportDirectory
(optional)
String
reportGenArgs
(optional)
String
$class: 'QualityCenter'
qcClientInstallationName
String
qcQTPAddinInstallationName
String
qcServerURL
qcbin
folder of the Quality Center Web application.
String
qcLogin
String
qcPass
String
qcDomain
String
qcProject
String
qcTSFolder
String
qcTSName
String
qcTSLogFile
Name of the report that will be generated.
If several test sets are run in one build step, one report will be generated per test set. As such, you must ensure that the name will be unique by including the test set name in it (through the ${TS_NAME}
variable). If it's not the case, then the name will be automatically post fixed with an underscore followed by the test set name.
You can use all standard environment variables plus:
${QC_DOMAIN}
for the current Quality Center domain;${QC_PROJECT}
for the current Quality Center project;${TS_FOLDER}
for the current TestSet folder;${TS_NAME}
for the TestSet name.String
qcTimeOut
int
runMode
String
runHost
String
acrQuickTask
azureCredentialsId
String
resourceGroupName
String
registryName
String
architecture
(optional)
String
buildArgs
(optional)
docker build --build-arg
.
key
String
value
String
secrecy
boolean
dockerfile
(optional)
String
gitPath
(optional)
String
gitRefspec
(optional)
String
gitRepo
(optional)
https://PAT@github.com/user/repo.git
for private repo.
String
imageNames
(optional)
image
String
local
(optional)
String
noCache
(optional)
no-cache
flag when build as docker build --no-cache
boolean
os
(optional)
String
sourceType
(optional)
String
tarball
(optional)
http://remoteserver/myapp.tar.gz
String
timeout
(optional)
int
variant
(optional)
String
$class: 'R'
Runs an R script (defaults to RScript interpreter) for building the project. The script will be run with the workspace as the current directory.
command
String
$class: 'RAD'
activateProjectWorkspaceVar
WORKSPACE
environment variable through the PROJECT_WORKSPACE
one.
WORKSPACE
variable during this build step as it doesn't refer to the workspace of the project: It is internally used by RAD.
boolean
buildFile
build.xml
one in the project's workspace. The base directory is the workspace.
String
deleteRadWorkspaceContent
.metadata
folder.
boolean
deleteRadWorkspaceMetadata
.metadata
folder of RAD's workspace has to be removed before RAD is actually run.
boolean
properties
# comment name1=value1 name2=value2These are passed to RAD like "-Dname1=value1 -Dname2=value2"
String
radInstallationName
String
radWorkspace
String
targets
String
$class: 'RPDCreateInstance'
pack
String
instanceName
String
customProfile
String
$class: 'RPDDeployInstance'
instanceName
String
pack
String
environment
String
route
String
customProfile
String
useCustomProfile
boolean
$class: 'RTCGitBuilder'
serverURI
The Jazz Repository connection URI for the Rational Team Concert (RTC) server
String
credentialsId
Credentials to use for the build user. A user name and password credential for the Jazz Repository should be configured.
String
annotateChangeLog
Optionally hyperlink bug numbers that appear in git commit descriptions as links to Rational Team Concert Work Items.
boolean
buildDefinition
(optional)
The ID of the Hudson/Jenkins build definition within the Rational Team Concert (RTC) server. The build definition should not have any Source Control option.
String
jenkinsRootURI
(optional)
String
jenkinsRootURIOverride
(optional)
Optionally specify the HTTP address of the Jenkins installation, such as http://yourhost.yourdomain/jenkins/. This is necessary because the Rational Team Concert Git plugin cannot reliably detect such a URL from within itself.
boolean
timeout
(optional)
The timeout period in seconds for Jazz repository requests made during the build.
int
trackBuildWorkItem
(optional)
Specify an Id of a Work Item in Rational Team Concert. The Work Item will be updated with the execution status of the Jenkins build.
String
useBuildDefinition
(optional)
boolean
useTrackBuildWorkItem
(optional)
boolean
useWorkItems
(optional)
boolean
workItemUpdateType
(optional)
String
rabbitMQPublisher
rabbitName
String
exchange
String
data
String
conversion
(optional)
boolean
routingKey
(optional)
String
toJson
(optional)
boolean
$class: 'RadarGunBuilder'
radarGunInstance
$class: 'RadarGunCustomInstallation'
home
String
$class: 'RadarGunInstallationWrapper'
radarGunName
String
scenarioSource
$class: 'FileScenarioSource'
scenarioPath
String
$class: 'TextScenarioSource'
scenario
String
nodeSource
$class: 'FileNodeConfigSource'
nodeListPath
String
$class: 'TextNodeConfigSource'
nodes
String
scriptSource
$class: 'BuildInScriptSource'
$class: 'FileScriptSource'
mainPath
String
workerPath
String
$class: 'TextScriptSource'
mainScript
String
workerScript
String
remoteLoginProgram
String
remoteLogin
String
workspacePath
String
pluginPath
String
pluginConfigPath
String
reporterPath
String
$class: 'Rake'
rakeInstallation
String
rakeFile
String
tasks
String
rakeLibDir
String
rakeWorkingDir
String
silent
boolean
bundleExec
boolean
$class: 'RallyBuild'
preRallyState
stateName
String
issueString
String
updateOnce
boolean
preComment
preCommentText
String
preReady
preReadyState
boolean
changeReady
issueReady
boolean
createComment
commentText
String
changeRallyState
issueRallyState
String
changeDefectRallyState
defectRallyState
String
rancherRedeploy
credential
String
workload
since endpoint part has bean set in Credential, you only need specify path from "/p/" or "/project", eg:
/project/c-h4hxd:p-c9j8z/workloads/deployment:default:busybox
or /p/c-h4hxd:p-dwqfr/workload/deployment:jenkins:jenkins
String
images
nginx;nginx:1.0;myteam/myproject:v2.0;docker.io/team/image:v1.0.${BUILD_NUMBER}
this plugin will update all images in this workload by match the name part exactly, and simply set version part as you specified. so you may need Jenkins variables to dynamic generate new version number.String
alwaysPull
boolean
rancher
environmentId
String
endpoint
String
credentialId
String
service
String
image
String
confirm
boolean
startFirst
boolean
ports
String
environments
String
timeout
int
ranorex
cmdLineArgs
(optional)
Flag | Function |
---|---|
config | cfg:<config parameter name>=<value> | Set values for configuration parameters. |
reportlevel | rl: Debug|Info|Warn|Error|Success|Failure|<any integer> | Sets the minimum report level that log messages need to have in order to be included in the log file. Specify 'None' to completely disable reporting. These levels correspond to the following integer values: Debug=10,Info=20,Warn=30,Error=40,Success=110,Failure=120 |
testcase | tc:<name or guid of test case> | Runs this test case only. |
testsuite | ts:<path to test suite file> | Runs the test cases defined by the test suite (rxtst) file. By default the rxtst file with the same name as the <TestSuiteExe> is used or the first rxtst file in the same folder as <TestSuiteExe>. |
module | mo:<module name or guid> | Runs the module with the specified name or guid. Assemblies loaded by <TestSuiteExe> and assemblies referenced in the rxtst file are searched. |
testcaseparam | tcpa:<name or guid of test case>:<parameter name>=<value> | Creates or overrides values for testcase parameters specified in the test suite. |
runlabel | rul:<custom value> | Sets a custom runlabel for the test run. |
testcasedatarange | tcdr:<name or guid of test case>=<data range> | Sets the data range for a testcase. |
String
rxGlobalParameter
(optional)
String
rxJUnitReport
(optional)
boolean
rxReportDirectory
(optional)
String
rxReportExtension
(optional)
String
rxReportFile
(optional)
String
rxRunConfiguration
(optional)
String
rxTestRail
(optional)
boolean
rxTestRailPassword
(optional)
String
rxTestRailRID
(optional)
String
rxTestRailRunName
(optional)
String
rxTestRailUser
(optional)
String
rxTestSuiteFilePath
(optional)
String
rxZippedReport
(optional)
boolean
rxZippedReportDirectory
(optional)
String
rxZippedReportFile
(optional)
String
$class: 'RapidDeployJobPlanRunner'
serverUrl
String
authenticationToken
String
jobPlan
String
asynchronousJob
boolean
showIndividualLogs
boolean
showFullLog
boolean
$class: 'RapidDeployJobRunner'
serverUrl
String
authenticationToken
String
project
String
target
String
packageName
String
asynchronousJob
boolean
showFullLog
boolean
$class: 'RapidDeployPackageBuilder'
serverUrl
String
authenticationToken
String
project
String
enableCustomPackageName
boolean
packageName
String
archiveExtension
String
$class: 'RawCliBuilder'
changeLogFile
(optional)
String
changeLogParameters
(optional)
String
commandArguments
(optional)
String
contexts
(optional)
String
credentialsId
(optional)
String
installationName
(optional)
String
labels
(optional)
String
liquibasePropertiesPath
(optional)
String
password
(optional)
String
resourceDirectories
(optional)
String
url
(optional)
String
username
(optional)
String
$class: 'RebaseBuilder'
You can rebase from the latest revision in the upstream branch, but you can also do safer rebase by choosing the permalink. For example, if you specify "last stable", then Jenkins will look for the last stable build, then rebase with the corresponding Subversion revision. Thus you know that you are rebasing to the known good state.
If you don't want Jenkins to automatically rebase, you can still use the "Rebase From Upstream" link from the left to manually initiate the rebase.
permalink
String
stopBuildIfMergeFails
boolean
setUnstableIfMergeFails
boolean
$class: 'RebootIOSDevice'
url
String
cloudTestServerID
String
additionalOptions
String
$class: 'ReconfigureBox'
id
String
cloud
String
workspace
String
box
String
instance
String
variables
String
buildStep
String
buildStepVariables
String
$class: 'ReinstallBox'
cloud
String
workspace
String
box
String
instance
String
buildStep
String
$class: 'ReleaseMarker'
releaseName
String
services
(optional)
name
String
scopedTo
(optional)
applications
name
String
applications
(optional)
name
String
releaseEndTimestamp
(optional)
String
releaseStartTimestamp
(optional)
String
androidApkMove
apkFilesPattern
(optional)
String
applicationId
(optional)
String
filesPattern
(optional)
String
fromVersionCode
(optional)
boolean
googleCredentialsId
(optional)
String
inAppUpdatePriority
(optional)
String
releaseName
(optional)
String
rolloutPercent
(optional)
double
rolloutPercentage
(optional)
String
trackName
(optional)
String
versionCodes
(optional)
String
addRelizaRelease
artId
(optional)
String
artType
(optional)
String
envSuffix
(optional)
String
projectId
(optional)
String
status
(optional)
String
uri
(optional)
String
useCommitList
(optional)
String
version
(optional)
String
$class: 'RemoteBuildConfiguration'
abortTriggeredJob
(optional)
boolean
auth2
(optional)
BearerTokenAuth
token
(optional)
class hudson.util.Secret
CredentialsAuth
credentials
(optional)
String
NoneAuth
NullAuth
TokenAuth
apiToken
(optional)
class hudson.util.Secret
userName
(optional)
String
blockBuildUntilComplete
(optional)
boolean
disabled
(optional)
boolean
enhancedLogging
(optional)
boolean
httpGetReadTimeout
(optional)
int
httpPostReadTimeout
(optional)
int
job
(optional)
String
loadParamsFromFile
(optional)
boolean
maxConn
(optional)
int
overrideTrustAllCertificates
(optional)
boolean
parameterFile
(optional)
String
parameters
(optional)
String
pollInterval
(optional)
int
preventRemoteBuildQueue
(optional)
boolean
remoteJenkinsName
(optional)
String
remoteJenkinsUrl
(optional)
String
shouldNotFailBuild
(optional)
boolean
token
(optional)
String
trustAllCertificates
(optional)
It is possible to override/rewrite the 'Trust all certificate'-setting for each Job separately. Setting this checkbox to 'true' will result in accepting all certificates for the given Job.
This is unsafe and should only be used for testing or if you trust the host.
boolean
useCrumbCache
(optional)
boolean
useJobInfoCache
(optional)
boolean
crxReplicate
packageIds
(optional)
String
baseUrls
(optional)
username[:password]@
between the scheme and the hostname.
String
credentialsId
(optional)
/$username/keys/$fingerprint
.
String
ignoreErrors
(optional)
boolean
requestTimeout
(optional)
long
serviceTimeout
(optional)
long
waitDelay
(optional)
long
acmRepoSync
url
String
credentialsId
String
force
(optional)
boolean
$class: 'ReqtifyGenerateReport'
reportArgumentList
String
nameReport
(optional)
String
modelReport
(optional)
String
templateReport
(optional)
String
$class: 'RetrieveArtifactsBuildStep'
names
(optional)
name
(optional)
String
stage
(optional)
String
variableName
(optional)
String
publishReview
downloadOnly
boolean
installRBTools
boolean
$class: 'ReviewboardApplyPatch'
$class: 'ReviewboardPollingBuilder'
reviewbotJobName
String
checkBackPeriod
String
reviewbotRepoId
String
restrictByUser
boolean
disableAdvanceNotice
boolean
$class: 'RigorBuilder'
credentialsId
Please select a credential of Kind Rigor API Key here.
Note: Your Rigor Optimization API key can be found on the API Credentials settings page in the Rigor Optimization application. The API key must have User or higher level permissions.
String
performanceTestIds
List 1 or more test IDs (as a comma separated list) of Rigor Optimization Performance Tests to be run during this step. You can locate the performance test ID by hovering over the Info (i) icon on any performance test in the View Results page of your Rigor Optimization account.
If Fail build based on results is checked below, this step will wait until all tests complete before proceeding. If unchecked, this step will launch these tests, but not wait for them to complete.
String
failOnSnapshotError
If checked, the build will be marked as failed if there are any errors running your configured performance tests. If unchecked, any errors creating tests will be treated as warnings and not fail the build.
boolean
failOnResults
If checked, the build will wait for your configured tests to complete (may take 30 seconds to a few minutes) and pass/fail based on the results configured below. If unchecked, your configured tests will run, but the build will not wait for the tests to complete nor fail this step based on any results (useful for historical change logging of your site in the Rigor Optimization application).
boolean
performanceScore
Optional
Fail the build if any test reports an overall performance score lower than this value (1-100)
String
criticalNumber
Optional
Fail the build if any test has more than this # of critical first party content defects found.
Note: You can customize when critical defects occur by customizing your Defect Check Policy. Learn more in this article.
String
foundDefectIds
Optional
Fail the build if any of the listed defect IDs (comma separated) are found for any first party content items in any configured test.
Note: You can locate any defect ID at the top of any defect detail page in your results, or in the Knowledge Base. See Example.
String
enforcePerformanceBudgets
Optional
Fail the build if any test exceeds its performance budgets
boolean
totalContentSize
String
totalFoundItems
String
testTimeoutSeconds
Timeout in seconds to wait for all configured performance tests to complete. Defaults to 300 seconds (5 minutes).
This value is only used if Fail build based on test results is enabled.
String
snRollbackApp
credentialsId
(optional)
String
apiVersion
(optional)
String
appScope
(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.
String
appSysId
(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.
String
rollbackAppVersion
(optional)
String
url
(optional)
String
$class: 'RollbackBuilder'
changeLogFile
(optional)
String
changeLogParameters
(optional)
String
contexts
(optional)
String
credentialsId
(optional)
String
installationName
(optional)
String
labels
(optional)
String
liquibasePropertiesPath
(optional)
String
numberOfChangesetsToRollback
(optional)
String
password
(optional)
String
resourceDirectories
(optional)
String
rollbackLastHours
(optional)
String
rollbackToDate
(optional)
String
rollbackToTag
(optional)
String
rollbackType
(optional)
String
url
(optional)
String
username
(optional)
String
snRollbackPlugin
credentialsId
(optional)
String
apiVersion
(optional)
String
pluginId
(optional)
String
url
(optional)
String
$class: 'RqmBuilder'
collectionStrategy
$class: 'RqmTestSuiteExectionRecordCollectionStrategy'
executionRecordName
String
planName
String
projectName
String
iterativeTestCaseBuilders
hudson.tasks.BuildStep
)preBuildSteps
hudson.tasks.BuildStep
)postBuildSteps
hudson.tasks.BuildStep
)credentialId
String
$class: 'RubyMotionBuilder'
platform
String
rakeTask
String
outputStyle
String
outputFileName
String
useBundler
boolean
installCocoaPods
boolean
needClean
boolean
outputResult
boolean
deviceName
String
simulatorVersion
String
envVars
String
$class: 'RunApplicationAction'
applicationName
Application selection is mandatory
Select an existing Application in Calm or the ones provisioned in Nutanix Calm Blueprint Launch Steps.
String
actionName
Application Action selection is mandatory
String
runtimeVariables
Click on Fetch Runtime Variables to fetch all editable variables for the selected Action in JSON format. Modify the key values from the defaults as needed.The values can also reference jenkins environment variables.
String
runFromAlmBuilder
almServerName
String
almCredentialsScope
String
almUserName
String
almPassword
String
almDomain
String
almProject
String
almTestSets
String
almRunResultsMode
String
almTimeout
String
almRunMode
String
almRunHost
String
almClientID
String
almApiKey
String
isSSOEnabled
boolean
isFilterTestsEnabled
(optional)
boolean
filterTestsModel
(optional)
blockedCheckbox
boolean
failedCheckbox
boolean
notCompletedCheckbox
boolean
noRunCheckbox
boolean
passedCheckbox
boolean
testName
(optional)
String
almServerSettingsModel
(optional)
almServerName
String
almServerUrl
String
almCredentials
almUsername
String
almPassword
String
almSSOCredentials
almClientID
String
almApiKeySecret
String
runFromFSBuilder
fsTests
String
fileSystemTestSetModel
fileSystemTestSet
tests
String
parallelRunnerEnvironments
environment
String
environmentType
String
summaryDataLogModel
logVusersStates
boolean
logErrorCount
boolean
logTransactionStatistics
boolean
pollingInterval
String
scriptRTSSetModel
scripts
scriptName
String
additionalAttributes
name
String
value
String
description
String
isParallelRunnerEnabled
(optional)
boolean
uftSettingsModel
(optional)
selectedNode
(optional)
String
numberOfReruns
(optional)
String
cleanupTest
(optional)
String
onCheckFailedTest
(optional)
String
fsTestType
(optional)
String
rerunSettingsModels
(optional)
test
(optional)
String
checked
(optional)
boolean
numberOfReruns
(optional)
int
cleanupTest
(optional)
String
analysisTemplate
(optional)
String
controllerPollingInterval
(optional)
String
displayController
(optional)
String
fsAutActions
(optional)
String
fsDeviceId
(optional)
String
fsDevicesMetrics
(optional)
String
fsExtraApps
(optional)
String
fsInstrumented
(optional)
String
fsJobId
(optional)
String
fsLaunchAppName
(optional)
String
fsManufacturerAndModel
(optional)
String
fsOs
(optional)
String
fsPassword
(optional)
String
fsReportPath
(optional)
String
fsTargetLab
(optional)
String
fsTimeout
(optional)
String
fsUftRunMode
(optional)
String
fsUserName
(optional)
String
ignoreErrorStrings
(optional)
String
mcServerName
(optional)
String
mcTenantId
(optional)
String
perScenarioTimeOut
(optional)
String
proxySettings
(optional)
fsUseAuthentication
boolean
fsProxyAddress
String
fsProxyUserName
String
fsProxyPassword
class hudson.util.Secret
resultFileNames
(optional)
java.util.Map<java.lang.Long, java.lang.String>
useSSL
(optional)
boolean
$class: 'RunInCloudBuilder'
projectId
The Bitbar Cloud project in which to start the new test run.
String
appPath
String
testPath
String
dataPath
String
testRunName
String
scheduler
String
testRunner
String
deviceGroupId
String
language
String
screenshotsDirectory
String
keyValuePairs
String
withAnnotation
String
withoutAnnotation
String
testCasesSelect
String
testCasesValue
String
failBuildIfThisStepFailed
boolean
virusScanTimeout
String
waitForResultsBlock
testRunStateCheckMethod
(optional)
HOOK_URL
, API_CALL
downloadScreenshots
(optional)
boolean
forceFinishAfterBreak
(optional)
boolean
hookURL
(optional)
String
resultsPath
(optional)
String
waitForResultsTimeout
(optional)
int
testTimeout
String
credentialsId
String
cloudUrl
String
cloudUIUrl
String
frameworkId
long
osType
IOS
, ANDROID
, DESKTOP
, UNDEFINED
tpJobRun
projectId
(optional)
String
jobId
(optional)
String
agentId
(optional)
String
waitJobFinishSeconds
(optional)
int
executionParameters
(optional)
String
junitResultsFile
(optional)
String
osfBuilderSuiteForSFCCRunJob
hostname
(optional)
String
ocCredentialsId
(optional)
String
ocVersion
(optional)
String
jobName
(optional)
String
jobArguments
(optional)
name
String
value
String
$class: 'RunLoadRunnerScript'
scriptsPath
String
$class: 'RunMatlabCommandBuilder'
matlabCommand
(optional)
String
$class: 'RunMatlabTestsBuilder'
coberturaArtifact
(optional)
coberturaReportFilePath
String
junitArtifact
(optional)
junitReportFilePath
String
modelCoverageArtifact
(optional)
modelCoverageFilePath
String
pdfReportArtifact
(optional)
pdfReportFilePath
String
selectByFolder
(optional)
testFolderPaths
testFolders
String
selectByTag
(optional)
testTag
String
sourceFolder
(optional)
Specify the location of folders containing source code, relative to the project root folder. The specified folders and their subfolders are added to the top of the MATLAB search path. To generate a coverage report, MATLAB uses only the source code in the specified folders and their subfolders.
Paste the source folder path in the Folder path box. To add more folders, click Add folder.
sourceFolderPaths
srcFolderPath
String
stmResultsArtifact
(optional)
stmResultsFilePath
String
tapArtifact
(optional)
tapReportFilePath
String
$class: 'RunPcTestBuildStep'
almPassword
(optional)
String
almUser
(optional)
String
domain
(optional)
String
failIfTaskFails
(optional)
boolean
outputDir
(optional)
String
pollingInterval
(optional)
int
postRunActionString
(optional)
String
project
(optional)
String
retryCollateAndAnalysisAttempts
(optional)
int
retryCollateAndAnalysisFlag
(optional)
boolean
retryCollateAndAnalysisInterval
(optional)
int
retryCount
(optional)
int
retryInterval
(optional)
int
retryIntervalMultiplier
(optional)
double
testLabPath
(optional)
String
testPlanPath
(optional)
String
timeout
(optional)
int
timeslotDuration
(optional)
int
vudsMode
(optional)
boolean
runPromotion
artifact
(optional)
String
artifactType
(optional)
String
keepTargetResources
(optional)
boolean
keepTargetRunProfiles
(optional)
boolean
plan
(optional)
String
promotion
(optional)
String
task
(optional)
String
workspace
(optional)
String
runTask
environment
(optional)
String
parameters
(optional)
String
task
(optional)
String
workspace
(optional)
String
tpTestRun
junitResultsFile
String
waitTestFinishSeconds
int
projectId
String
testId
String
agentId
String
browser
String
device
String
executionParameters
String
$class: 'RunTestSetBuildStep'
domain
String
project
String
runMode
String
host
String
testSets
String
outputDirPath
String
timeOut
int
snRunTestSuite
credentialsId
(optional)
String
apiVersion
(optional)
String
browserName
(optional)
Valid values:
String
browserVersion
(optional)
String
osName
(optional)
String
osVersion
(optional)
String
responseBodyFormat
(optional)
String
testSuiteName
(optional)
String
testSuiteSysId
(optional)
sys_id
of the test suite to run. This value is located in the Test [sys_atf_test_suite] table.
String
url
(optional)
String
withResults
(optional)
boolean
$class: 'RunUftTestBuildStep'
testPath
String
outputDirPath
String
$class: 'RunscopeBuilder'
triggerEndPoint
String
accessToken
String
timeout
int
s3CopyArtifact
projectName
String
buildSelector
downstream
upstreamProjectName
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).
String
upstreamBuildNumber
String
lastWithArtifacts
lastCompleted
$class: 'MultiJobBuildSelector'
buildParameter
parameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
String
permalink
id
String
$class: 'PromotedBuildSelector'
level
int
latestSavedBuild
specific
buildNumber
String
lastSuccessful
stable
(optional)
boolean
upstream
allowUpstreamDependencies
(optional)
boolean
fallbackToLastSuccessful
(optional)
boolean
upstreamFilterStrategy
(optional)
UseGlobalSetting
, UseOldest
, UseNewest
workspace
filter
String
excludeFilter
String
target
String
flatten
boolean
optional
boolean
$class: 'SASUnitPlugInBuilder'
This is the Jenkins Plug-In for SASUnit the unit testing framework for SAS.
sasunitBatch
String
doxygenBatch
Please enter the relative path to the executable to create the doxygen report
String
sasunitVersion
Please pick a SASUnit installation that shall be used.
To add an installation please go to Jenins->Manage Jenkins->Setting or follow this link.
String
createDoxygenDocu
boolean
$class: 'SBuild'
sbuildVersion
String
targets
String
buildFiles
String
options
String
scmSkip
deleteBuild
(optional)
boolean
skipPattern
(optional)
String
$class: 'SConsBuilderCommand'
sconsName
String
options
String
variables
String
targets
String
rootSconsscriptDirectory
String
commandScript
String
$class: 'SConsBuilderScriptFile'
sconsName
String
options
String
variables
String
targets
String
rootSconsscriptDirectory
String
sconsscript
String
$class: 'SMABuilder'
validateEnabled
boolean
username
String
password
String
securityToken
String
serverType
String
testLevel
String
prTargetBranch
String
$class: 'SQLPlusRunnerBuilder'
credentialsId
String
instance
String
scriptType
String
script
String
scriptContent
SELECT sysdate from dual; show user; |
String
customNLSLang
(optional)
String
customOracleHome
(optional)
String
customSQLPath
(optional)
String
customSQLPlusHome
(optional)
String
customTNSAdmin
(optional)
String
$class: 'SSHBuilder'
siteName
String
command
String
execEachLine
Execute each line in the script individually.
By default, all of the commands are concatenated into a single "command" issued over a single SSH exec channel. Selecting this option causes each line to be executed over it's own SSH exec channel, each of which is part of the same session.
This is useful in certain cases where the commands cannot be concatenated into a single script executed at one time, for example, when issuing commands using the sourceforge.net shell.
If unsure, leave this box unchecked.
boolean
hideCommand
(optional)
boolean
$class: 'SaltAPIBuilder'
authtype
String
clientInterface
hook
post
String
tag
String
batch
function
String
arguments
String
batchSize
String
batchWait
String
target
String
targettype
String
local
function
String
arguments
String
target
String
targettype
String
blockbuild
(optional)
boolean
jobPollTime
(optional)
int
minionTimeout
(optional)
int
subset
function
String
arguments
String
subset
String
target
String
targettype
String
runner
function
String
arguments
String
mods
String
pillarvalue
String
credentialsId
String
servername
(optional)
String
saveEnvVar
(optional)
boolean
saveFile
(optional)
boolean
skipValidation
(optional)
boolean
$class: 'SbtPluginBuilder'
name
String
jvmFlags
String
sbtFlags
String
actions
String
subdirPath
String
$class: 'ScanBuilder'
scanURL
String
apiKey
class hudson.util.Secret
source
String
exclude
String
rule
String
timeout
int
isAbortBuild
boolean
isPrivateScan
boolean
isShowBlockedOnly
boolean
isCreateLog
boolean
vdooScan
baseApi
(optional)
String
failThreshold
(optional)
String
firmwareLocation
(optional)
String
maliciousFiles
(optional)
String
maxHighlightedCVEs
(optional)
String
maxHighlightedExposures
(optional)
String
maxHighlightedIssues
(optional)
String
productId
(optional)
String
vdooToken
(optional)
class hudson.util.Secret
waitForResults
(optional)
boolean
$class: 'ScriptBuildStep'
buildStepId
String
defineArgs
boolean
buildStepArgs
arg
String
tokenized
boolean
$class: 'ScriptBuilder'
scriptFilePath
String
credentialsId
String
hubUrl
String
imageName
String
vmVersion
String
containerWorkingDir
String
mountSettings
sourceContainer
String
sourceFolder
String
targetFolder
String
routeFile
String
noBase
boolean
overwrite
boolean
diagnostic
boolean
$class: 'SealightsCLIBuildStep'
enabled
boolean
failBuildIfStepFail
boolean
commandMode
$class: 'ConfigView'
appName
String
branchName
String
buildName
$class: 'DefaultBuildName'
$class: 'EmptyBuildName'
$class: 'LatestBuildName'
$class: 'ManualBuildName'
insertedBuildName
String
$class: 'UpstreamBuildName'
upstreamProjectName
String
labId
String
buildSessionId
String
additionalArguments
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). |
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). |
String
techOptions
$class: 'DotNetOptions'
namespacesIncluded
String
namespacesExcluded
String
includedFilePatterns
String
excludedFilePatterns
String
$class: 'JavaOptions'
packagesIncluded
String
packagesExcluded
String
$class: 'EndView'
buildSessionId
String
labId
String
additionalArguments
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). |
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). |
appname | Override default app name coming from build session id |
buildname | Override default build name coming from build session id |
branchname | Override default branch name coming from build session id |
String
$class: 'ExternalReportView'
report
String
buildSessionId
String
additionalArguments
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). |
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). |
appname | Override default app name coming from build session id |
buildname | Override default build name coming from build session id |
branchname | Override default branch name coming from build session id |
String
$class: 'PrConfigView'
appName
String
branchName
String
buildName
$class: 'DefaultBuildName'
$class: 'EmptyBuildName'
$class: 'LatestBuildName'
$class: 'ManualBuildName'
insertedBuildName
String
$class: 'UpstreamBuildName'
upstreamProjectName
String
labId
String
buildSessionId
String
additionalArguments
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). |
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). |
String
techOptions
$class: 'DotNetOptions'
namespacesIncluded
String
namespacesExcluded
String
includedFilePatterns
String
excludedFilePatterns
String
$class: 'JavaOptions'
packagesIncluded
String
packagesExcluded
String
latestCommit
String
pullRequestNumber
String
repoUrl
String
targetBranch
String
$class: 'StartView'
testStage
String
buildSessionId
String
labId
String
additionalArguments
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). |
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). |
appname | Override default app name coming from build session id |
buildname | Override default build name coming from build session id |
branchname | Override default branch name coming from build session id |
String
$class: 'UploadReportsView'
reportFiles
String
reportsFolders
String
source
String
buildSessionId
String
labId
String
additionalArguments
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). |
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). |
appname | Override default app name coming from build session id |
buildname | Override default build name coming from build session id |
branchname | Override default branch name coming from build session id |
String
cliRunner
class io.sealights.plugins.sealightsjenkins.buildsteps.cli.CLIRunner
logDestination
CONSOLE
, FILE
logFolder
String
logLevel
OFF
, INFO
, DEBUG
, WARN
, ERROR
logFilename
String
$class: 'SecurityCheckerBuilder'
$class: 'SeleniumAutoExecBuilder'
serverUrl
String
$class: 'SeleniumBuilderBuilder'
scriptFile
String
parallelSettings
threadPoolSize
int
$class: 'SelfServiceBookmarkBuilder'
delphixEngine
String
delphixBookmark
String
delphixOperation
String
delphixContainer
String
loadFromProps
(optional)
boolean
saveToProps
(optional)
boolean
$class: 'SelfServiceContainerBuilder'
delphixEngine
String
delphixEnvironment
String
delphixOperation
String
delphixBookmark
String
loadFromProps
(optional)
boolean
saveToProps
(optional)
boolean
$class: 'SemanticVersioningBuilder'
parser
String
namingStrategy
String
useJenkinsBuildNumber
boolean
envVariable
String
$class: 'SendMessageBuildStep'
message
String
filepath
String
recipients
id
String
sensediaApiDeploy
enviromentName
String
revision
String
sensediaApiJson
apiId
String
sensediaApiQA
revisionNumber
int
destination
boolean
logInterceptor
boolean
resourceOutOfSize
boolean
resourceSize
int
shell
sh
, but this is configurable) for building the project. The script will be run with the workspace as the current directory. Type in the contents of your shell script. If your shell script has no header line like #!/bin/sh
—, then the shell configured system-wide will be used, but you can also use the header line to write script in another language (like #!/bin/perl
) or control the options that shell uses.
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.
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
(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.
boolean
variables
(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.
String
unstableReturn
(optional)
int
$class: 'SideeX'
protocolMenu
The default protocol is "HTTP".
Use "HTTPS (Disable certificate checking)" to disable certificate checking.
Use "HTTPS (Enable certificate checking)" to enable certificate checking.
$class: 'HTTPItem'
baseURL
String
$class: 'HTTPSDisableItem'
baseURL
String
$class: 'HTTPSEnableItem'
baseURL
String
caFilePath
String
stateTime
String
testCaseFilePath
String
sigma
commandLine
(optional)
The command line arguments to execute for Rapid Scan Static which override the default analyze command. This allows for any Rapid Scan Static command line options to be specified.
If this field is empty the default command will be:
'sigma analyze --format jenkins'
String
ignorePolicies
(optional)
Prevents Rapid Scan Static from failing the build based on violated policies.
If selected, then the '--ignore-policies' command line argument will be added to the Rapid Scan Static analyze sub-command.
boolean
sigmaToolName
(optional)
Select the name of the Rapid Scan Static tool installation to execute Rapid Scan Static with this build step.
String
signAndroidApks
androidHome
(optional)
zipalign
tool. You can also set the ANDROID_HOME
environment variable in your Jenkins system or node configuration. E.g., /usr/local/android-sdk
.
String
apksToSign
(optional)
myApp/build/outputs/apk/myApp-unsigned.apk
or **/*-unsigned.apk
or app1/**/*-unsigned.apk, app2/**/*-unsigned.apk
.
String
archiveSignedApks
(optional)
SignApksBuilder-out/myApp-unsigned.apk/myApp-signed.apk
, where myApp-unsigned.apk
is a directory named for the input unsigned APK.
boolean
archiveUnsignedApks
(optional)
boolean
keyAlias
(optional)
Key Store ID
references. If your key store contains only one key entry, which is the most common case, you can leave this field blank.
String
keyStoreId
(optional)
String
signedApkMapping
(optional)
unsignedApkNameDir
unsignedApkSibling
skipZipalign
(optional)
boolean
zipalignPath
(optional)
zipalign
executable this build step should use to align the target APKs. You can also set the ANDROID_ZIPALIGN
environment variable in your Jenkins system or node configuration. E.g., /opt/android-tools/bin/zipalign
String
venafiCodeSignWithSignTool
tppName
String
fileOrGlob
A path or a glob that specifies the file(s) to be signed.
String
appendSignatures
(optional)
boolean
extraArgs
(optional)
This plugin invokes Signtool under the hood. Here you can specify extra custom CLI arguments to pass to Signtool.
These arguments will be appended to the Signtool CLI invocation. If they overlap with any arguments implicitly passed by this plugin, then Signtool will raise an error.
argument
String
sha1
(optional)
The SHA-1 hash of the certificate (inside the TPP) to use for code signing.
Normally you should use 'Signing certificate subject name' instead, but if that name is ambiguous, then use the SHA-1 hash to select a specific signing certificate.
Either a subject name or SHA-1 hash of the signing certificate must be given.
String
signToolPath
(optional)
String
signatureDigestAlgos
(optional)
The digest algorithm(s) to use to creating signatures.
If none specified, 'sha256' is used as the default algorithm. This is very secure, but may not be compatible with older Windows versions. If you need compatibility with older Windows versions, you should specify 'sha1' and 'sha256' (in that order).
When multiple digest algorithms are specified, they are applied in the order specified.
algorithm
String
subjectName
(optional)
The Common Name ("Issued to" or "CN") of the certificate (inside the TPP) to use for code signing.
You can obtain a list of Common Names with 'cspconfig listcertificates' and checking what comes after 'CN='.
Either a subject name or SHA-1 hash of the signing certificate must be given.
String
timestampingServers
(optional)
Specifies one or more timestamping authority servers to use during signing. Specifying this is strongly recommended, because it allows signed files to be usable even after the original signing certificate has expired.
If you specify more than one server, then a random one will be used.
Tip: here are some public timestamping authorities that you can use:
address
String
useMachineConfiguration
(optional)
boolean
venafiClientToolsDir
(optional)
C:\Program Files\Venafi CodeSign Protect
.String
venafiVerifyWithSignTool
tppName
String
fileOrGlob
A path or a glob that specifies the file(s) to be verified.
String
signToolPath
(optional)
String
useMachineConfiguration
(optional)
boolean
venafiClientToolsDir
(optional)
C:\Program Files\Venafi CodeSign Protect
.String
$class: 'SilkPerformerBuilder'
projectLoc
String
workload
String
successCriteria
userType
String
measureCategory
String
measureType
String
measureName
String
valueType
String
operatorType
String
chosenValue
String
SimplifyQA
api
String
token
class hudson.util.Secret
$class: 'SingleConditionalBuilder'
buildStep
hudson.tasks.BuildStep
)condition
$class: 'AlwaysRun'
$class: 'And'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
conditions
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
String
$class: 'Not'
condition
$class: 'AlwaysRun'
$class: 'And'
conditions
$class: 'BatchFileCondition'
command
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.
String
$class: 'BooleanCondition'
token
String
$class: 'CauseCondition'
buildCause
String
exclusiveCause
boolean
$class: 'DayCondition'
useBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean
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
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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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
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}", '')
String
injectProperties
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. String
ontrackLog
boolean
$class: 'Or'
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$class: 'VariableExistsCondition'
variableName
String
$class: 'ShellCondition'
command
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
String
$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
For long running builds, there can be a considerable difference between these two times.
boolean
$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'
skenai
orgId
String
appId
String
$class: 'SkytapBuilder'
action
$class: 'AddConfigurationToProjectStep'
configurationID
String
configurationFile
String
projectID
String
projectName
String
$class: 'AddTemplateToProjectStep'
templateID
String
templateFile
String
projectID
String
projectName
String
$class: 'ChangeConfigurationStateStep'
configurationID
String
configurationFile
String
targetRunState
String
haltOnFailedShutdown
boolean
$class: 'ChangeContainerStateStep'
containerID
String
containerFile
String
targetContainerAction
String
$class: 'ChangeVMContainerHostStatus'
configurationID
String
configurationFile
String
vmID
String
vmName
String
containerHostStatus
String
$class: 'ConnectToVPNTunnelStep'
configurationID
String
configurationFile
String
configurationNetworkName
String
vpnID
String
$class: 'CreateConfigurationStep'
templateID
String
templateFile
String
configName
String
configFile
String
$class: 'CreateContainerStep'
configurationID
String
configurationFile
String
vmID
String
vmName
String
containerRegistryName
String
repositoryName
String
containerName
If no name is provided, the container will be named New_Container_[timestamp]
String
containerCommand
If no command is provided, will default to using the command in the image spec (if applicable).
String
exposeAllPorts
boolean
containerSaveFilename
String
$class: 'CreatePublishURLStep'
configurationID
String
configurationFile
String
urlSaveFilename
String
portalName
String
permissionOption
Don't Publish: The Sharing Portal URL will not be available to the user in any way.
View Only: User can view the VM through the Sharing Portal URL. No mouse or keyboard control is allowed, and desktop resizing is disabled.
Use:User can view the VM through the Sharing Portal URL and interact with it using a mouse or keyboard. Desktop resizing is allowed.
Run, Suspend: User can view the VM through the Sharing Portal URL and interact with it using a mouse or keyboard. Desktop resizing is allowed, and the user can also run the machine if it is in a stopped or suspended state.
String
hasPassword
urlPassword
class hudson.util.Secret
$class: 'CreatePublishedServiceStep'
configurationID
String
configurationFile
String
vmID
String
vmName
String
networkName
String
portNumber
String
publishedServiceFile
String
$class: 'CreateTemplateFromConfigurationStep'
configurationID
String
configurationFile
String
templateName
String
templateDescription
String
templateSaveFilename
String
$class: 'DeleteConfigurationStep'
configurationID
String
configurationFile
String
$class: 'DeleteContainerStep'
containerID
String
containerFile
String
$class: 'GetContainerMetaDataStep'
configurationID
String
configurationFile
String
vmID
String
vmName
String
containerName
String
containerDataFile
String
$class: 'ListPublishedURLForConfigurationStep'
configurationID
String
configurationFile
String
urlName
String
urlFile
String
$class: 'ListVMPublishedServiceStep'
configurationID
String
configurationFile
String
vmID
String
vmName
String
networkName
String
portNumber
String
publishedServiceFile
String
$class: 'MergeTemplateIntoConfigurationStep'
configurationID
String
configurationFile
String
templateID
String
templateFile
String
configFile
String
$class: 'NetworkConnectStep'
sourceNetworkConfigurationID
String
targetNetworkConfigurationID
String
sourceNetworkConfigurationFile
String
targetNetworkConfigurationFile
String
sourceNetworkName
String
targetNetworkName
String
$class: 'SleepBuilder'
time
long
$class: 'SmartFrogBuilder'
smartFrogName
String
deployHost
String
hosts
String
sfUserHome
String
sfUserHome2
String
sfUserHome3
String
sfUserHome4
String
sfOpts
String
builderId
String
useAltIni
boolean
sfIni
String
sfScriptSource
$class: 'FileScriptSource'
scriptName
String
scriptPath
String
$class: 'StringScriptSource'
scriptName
String
scriptContent
String
$class: 'SnapshotBuilder'
xStudioPath
String
xStudioLicensePath
String
vagrantBox
String
overwrite
boolean
preInstallScriptPath
String
postSnapshotScriptPath
String
resourceDirectoryPath
String
dependencies
String
snapshotFilesToDelete
String
installScriptSettings
class org.jenkinsci.plugins.spoontrigger.SnapshotBuilder$InstallScriptSettings
startupFileSettings
class org.jenkinsci.plugins.spoontrigger.SnapshotBuilder$StartupFileSettings
$class: 'SnykStepBuilder'
additionalArguments
(optional)
Additional runtime arguments that will be used to invoke the Snyk CLI. See the Snyk CLI help page for more details.
Use the standalone double-dash --
to pass arguments to the build tool invoked by the Snyk CLI. For example:
-- -Pprofile -Dkey=value
for Maven
projects.-- --configuration runtime
for Gradle
projects.-- -Dkey=value
for SBT
projects.String
failOnError
(optional)
Whether the step should fail if Snyk fails to scan the project due to an error. Errors include scenarios like: failing to download Snyk's binaries, improper Jenkins setup, bad configuration and server errors.
boolean
failOnIssues
(optional)
The "When issues are found" selection specifies if builds should be failed or continued based on issues found by Snyk.
The corresponding CLI option for severity parameter: --severity-threshold
boolean
monitorProjectOnBuild
(optional)
Monitor the project on every build by taking a snapshot of its current dependencies on Snyk.io. Selecting this option will keep you notified about newly disclosed vulnerabilities and remediation options in the project.
boolean
organisation
(optional)
The Snyk organisation in which this project should be tested and monitored. Leave empty to use your default organisation.
The corresponding CLI option for this parameter: --org
String
projectName
(optional)
A custom name for the Snyk project created for this Jenkins project on every build. Leave empty for the project's name to be detected in the manifest file.
The corresponding CLI option for this parameter: --project-name
String
severity
(optional)
String
snykInstallation
(optional)
Ensures that the selected version of Snyk tools are installed. In addition, the Snyk tools will be added at the start of the PATH
environment variable during builds.
If no Snyk installations have been defined in the Jenkins system config, then none of the above steps will take place.
String
snykTokenId
(optional)
This needs to be the ID of an existing "Snyk API Token" credential. The token will be used to authenticate with Snyk.
If you prefer to provide the Snyk API Token another way, such using alternative credential bindings, you'll need to provide a SNYK_TOKEN
build environment variable.
String
targetFile
(optional)
The path to the manifest file to be used by Snyk. Leave empty for Snyk to auto-detect the manifest file in the project's root folder.
The corresponding CLI option for this parameter: --file
String
addALMOctaneSonarQubeListener
pushCoverage
(optional)
boolean
pushVulnerabilities
(optional)
boolean
skipWebhookCreation
(optional)
boolean
sonarServerUrl
(optional)
String
sonarToken
(optional)
String
$class: 'SonarRunnerBuilder'
additionalArguments
(optional)
String
installationName
(optional)
String
javaOpts
(optional)
String
jdk
(optional)
String
project
(optional)
String
properties
(optional)
String
sonarScannerName
(optional)
String
task
(optional)
String
$class: 'SoundsBuildTask'
afterDelayMs
String
soundSource
selectedSound
String
value
INTERNAL
, URL
soundUrl
String
$class: 'SparkNotifyBuilder'
disable
boolean
messageType
String
roomList
rName
String
rId
String
messageContent
(optional)
String
credentialsId
(optional)
String
split
splitTask
String
splitName
String
environmentName
String
workspaceName
String
trafficTypeName
String
splitDefinitions
String
whitelistKey
String
treatmentName
String
splitYAMLFile
String
springBoot
selectedIDs
(optional)
String
artifactId
(optional)
String
autocomplete
(optional)
String
bootVersion
(optional)
String
description
(optional)
String
groupId
(optional)
String
javaVersion
(optional)
String
language
(optional)
String
packaging
(optional)
String
projectName
(optional)
String
type
(optional)
String
sseBuild
almServerName
String
almProject
String
credentialsId
String
clientType
String
almDomain
String
runType
String
almEntityId
String
timeslotDuration
String
cdaDetails
(optional)
deploymentAction
String
deployedEnvironmentName
String
deprovisioningAction
String
description
(optional)
String
environmentConfigurationId
(optional)
String
postRunAction
(optional)
String
stackrox
apiToken
(optional)
String
caCertPEM
(optional)
String
enableTLSVerification
(optional)
boolean
failOnCriticalPluginError
(optional)
boolean
failOnPolicyEvalFailure
(optional)
boolean
imageNames
(optional)
String
portalAddress
(optional)
String
osfBuilderSuiteStandaloneSonarLinter
sourcePatterns
(optional)
sourcePattern
String
excludePatterns
excludePattern
String
reportPath
(optional)
String
$class: 'StartBox'
cloud
String
workspace
String
box
String
instance
String
buildStep
String
startET
Configure and start a preconfigured ECU-TEST installation.
Pipeline usagestartET(String toolName) : void
startET(String toolName, String workspaceDir, String settingsDir, int timeout, boolean debugMode, boolean keepInstance, boolean updateUserLibs) : void
ETInstance.start() : void
ETInstance.start(String workspaceDir, String settingsDir, int timeout, boolean debugMode, boolean keepInstance, boolean updateUserLibs) : void
ETInstance.start(Map<String, Object> settings) : void
startET('ECU-TEST')
def instance = ET.installation('ECU-TEST') startET installation: instance.installation, workspaceDir: 'C:\\Data'
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0') instance.start()
def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0' instance.start workspaceDir: 'C:\\Data', settingsDir: 'C:\\Data', timeout: 120, debugMode: true, keepInstance: false, updateUserLibs: true
toolName
String
debugMode
(optional)
boolean
installation
(optional)
name
String
home
String
properties
? extends hudson.tools.ToolProperty<?>
keepInstance
(optional)
boolean
settingsDir
(optional)
String
timeout
(optional)
String
updateUserLibs
(optional)
boolean
workspaceDir
(optional)
String
$class: 'StartGrid'
url
String
cloudTestServerID
String
name
String
timeOut
int
acmStartPipeline
aioProject
(optional)
String
pipeline
(optional)
String
program
(optional)
String
$class: 'StartRSDB'
url
String
cloudTestServerID
String
name
String
timeOut
int
startTS
Configure and start Tool-Server.
Pipeline usagestartTS(String toolName) : void
startTS(String toolName, String toolLibsIniPath, int tcpPort, int timeout, boolean keepInstance) : void
ETInstance.startTS() : void
ETInstance.startTS(String toolLibsIniPath, int tcpPort, int timeout, boolean keepInstance) : void
ETInstance.startTS(Map<String, Object> settings) : void
startTS('ECU-TEST')
def instance = ET.installation('ECU-TEST') startTS installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0') instance.startTS()
def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0' instance.startTS toolLibsIniPath: C:\\ToolLibs.ini, tcpPort: 5017, timeout: 60, keepInstance: false
toolName
String
installation
(optional)
name
String
home
String
properties
? extends hudson.tools.ToolProperty<?>
keepInstance
(optional)
boolean
tcpPort
(optional)
String
timeout
(optional)
String
toolLibsIni
(optional)
String
$class: 'StartTestEnvironment'
url
String
cloudTestServerID
String
name
String
timeOut
int
$class: 'StopBox'
cloud
String
workspace
String
box
String
instance
String
buildStep
String
stopET
Shutdown ECU-TEST.
Pipelines usage:stopET(String toolName) : void
stopET(String toolName, int timeout) : void
ETInstance.stop() : void
ETInstance.stop(int timeout) : void
ETInstance.stop(Map<String, Object> settings) : void
stopET('ECU-TEST')
def instance = ET.installation('ECU-TEST') stopET installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0') instance.stop()
def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0' instance.stop timeout: 60
toolName
String
installation
(optional)
name
String
home
String
properties
? extends hudson.tools.ToolProperty<?>
timeout
(optional)
String
$class: 'StopGrid'
url
String
cloudTestServerID
String
name
String
$class: 'StopRSDB'
url
String
cloudTestServerID
String
name
String
stopTS
Shutdown Tool-Server.
Pipelines usage:stopTS(String toolName) : void
stopTS(String toolName, int timeout) : void
ETInstance.stopTS() : void
ETInstance.stopTS(int timeout) : void
ETInstance.stopTS(Map<String, Object> settings) : void
stopTS('ECU-TEST')
def instance = ET.installation('ECU-TEST') stopTS installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0') instance.stopTS()
def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0' instance.stopTS timeout: 60
toolName
String
installation
(optional)
name
String
home
String
properties
? extends hudson.tools.ToolProperty<?>
timeout
(optional)
String
$class: 'StopTestEnvironment'
url
String
cloudTestServerID
String
name
String
strobeMeasurement
connectionId
String
credentialsId
String
requestType
String
jobName
String
body
(optional)
String
duration
(optional)
String
emailto
(optional)
String
finalAction
(optional)
String
headers
(optional)
String
hlq
(optional)
String
limit
(optional)
String
method
(optional)
String
profileName
(optional)
String
samples
(optional)
String
tags
(optional)
String
transactionId
(optional)
String
url
(optional)
String
$class: 'StudioToolsBuilder'
name
String
operation
String
projectDir
String
outputArchiveFile
String
extendedClassPath
String
overwriteOutput
boolean
TRAPropertyFIle
String
topazSubmitFreeFormJcl
connectionId
String
credentialsId
String
maxConditionCode
String
jcl
String
topazSubmitJclMembers
connectionId
String
credentialsId
String
maxConditionCode
String
jclMember
String
$class: 'SvChangeModeBuilder'
serverName
String
force
boolean
mode
OFFLINE
, SIMULATING
, STAND_BY
, LEARNING
dataModel
selectionType
BY_NAME
, NONE
, DEFAULT
dataModel
String
performanceModel
selectionType
BY_NAME
, NONE
, OFFLINE
, DEFAULT
performanceModel
String
serviceSelection
selectionType
SERVICE
, PROJECT
, ALL_DEPLOYED
, DEPLOY
service
String
projectPath
String
projectPassword
String
$class: 'SvDeployBuilder'
serverName
String
force
boolean
service
String
projectPath
String
projectPassword
String
firstAgentFallback
boolean
$class: 'SvExportBuilder'
serverName
String
force
boolean
targetDirectory
String
cleanTargetDirectory
boolean
serviceSelection
selectionType
SERVICE
, PROJECT
, ALL_DEPLOYED
, DEPLOY
service
String
projectPath
String
projectPassword
String
switchToStandByFirst
boolean
archive
boolean
$class: 'SvUndeployBuilder'
serverName
String
continueIfNotDeployed
boolean
force
boolean
serviceSelection
selectionType
SERVICE
, PROJECT
, ALL_DEPLOYED
, DEPLOY
service
String
projectPath
String
projectPassword
String
SWEAGLEExport
actionName
String
mdsName
String
args
(optional)
String
exporter
(optional)
String
fileLocation
(optional)
String
format
(optional)
String
mapToVariables
(optional)
String
markFailed
(optional)
boolean
showResults
(optional)
boolean
tag
(optional)
String
SWEAGLESnapshot
actionName
String
mdsName
String
description
(optional)
String
markFailed
(optional)
boolean
showResults
(optional)
boolean
tag
(optional)
String
SWEAGLEUpload
actionName
String
fileLocation
String
format
String
nodePath
String
allowDelete
(optional)
Allow Delete If checked will delete any nodes and MDIs that are not part of the upload. If the nodes are included or inherited the nodes and MDIs at points of inclusion will also be deleted unless "Only Parent" is also checked.
boolean
autoRecognize
(optional)
boolean
description
(optional)
String
filenameNodes
(optional)
Create Filename Nodes If checked, nodes will be created for all matching files names in the file location and file data will be placed under file name node.
boolean
identifierWords
(optional)
Identifier Words To make nodes part of an array uniquely identifiable, a comma separated list of 'identifier words' can be added. If no identifierWords are provided, the behavior will default to the identifierWords listed in the find.identity_attributes_discovery.word_list preference
String
markFailed
(optional)
boolean
onlyParent
(optional)
Only Parent This controls if in case the allowDelete flag is set to true if the deletion of nodes and CDIs will only happen at the node itself, or also at any other place where the node is included or in every child node that is inheriting.
boolean
showResults
(optional)
boolean
subDirectories
(optional)
Search Sub-directories If checked sub-directories will also be searched recursively for matching files.
boolean
tag
(optional)
String
withSnapshot
(optional)
Allow Delete If checked will delete any nodes and MDIs that are not part of the upload. In case the nodes are included or inherited, also the nodes and MDIs at points of inclusion will be deleted
Only Parent If checked will delete any nodes and MDIs that are not part of the upload. In case the nodes are included or inherited, also the nodes and MDIs at points of inclusion will be deleted
Store Snapshot. This controls if automatically a snapshot should be created for each of the impacted config data sets by this data upload.
boolean
SWEAGLEValidate
actionName
String
mdsName
String
errMax
(optional)
int
markFailed
(optional)
boolean
noPending
(optional)
boolean
retryCount
(optional)
int
retryInterval
(optional)
int
showResults
(optional)
boolean
stored
(optional)
boolean
warnMax
(optional)
int
$class: 'SyncBuilder'
packageid
String
serverName
String
dbName
String
serverAuth
value
String
username
String
password
class hudson.util.Secret
encryptConnection
boolean
trustServerCertificate
boolean
options
String
dataOptions
String
filter
String
packageVersion
String
isolationLevel
String
updateScript
boolean
sqlChangeAutomationVersionOption
value
Latest
, Specific
specificVersion
String
$class: 'SyncStepBuilder'
packageId
String
server
String
database
String
authenticationType
String
userName
String
password
class hudson.util.Secret
compareOptions
(optional)
String
filterFile
(optional)
String
transactionIsoLvl
(optional)
String
$class: 'SysdigBuilder'
name
String
bailOnFail
(optional)
boolean
bailOnPluginFail
(optional)
boolean
engineCredentialsId
(optional)
String
engineurl
(optional)
String
engineverify
(optional)
boolean
forceScan
(optional)
boolean
inlineScanExtraParams
(optional)
String
inlineScanning
(optional)
boolean
runAsUser
(optional)
String
$class: 'SystemGroovy'
Executes a system groovy script similarly to hudson_url/script. The script is always executed on master.
Predefined variables:
build
AbstractBuild
.
launcher
Launcher
.
listener
BuildListener
.
out
PrintStream
(listener.logger
).
source
$class: 'FileSystemScriptSource'
scriptFile
String
$class: 'StringSystemScriptSource'
script
script
String
sandbox
boolean
classpath
path
String
bindings
(optional)
Define variable bindings (in the properties file format). Specified variables can be addressed from the script.
String
$class: 'TATestRunRegistrationBuildStep'
This step registers new test run with given category and sets the 'dtTestrunID' build variable.
category
String
platform
String
$class: 'TagBuilder'
changeLogFile
(optional)
String
changeLogParameters
(optional)
String
contexts
(optional)
String
credentialsId
(optional)
String
installationName
(optional)
String
labels
(optional)
String
liquibasePropertiesPath
(optional)
String
password
(optional)
String
resourceDirectories
(optional)
String
tag
(optional)
String
url
(optional)
String
username
(optional)
String
tanaguru
name
String
scenario
String
urlToAudit
String
urlTanaguruWebService
String
performanceUnstableMark
int
performanceFailedMark
int
proxy_uri
String
proxy_username
String
proxy_password
String
$class: 'TattletaleBuilder'
inputDirectory
String
outputDirectory
String
testcompletetest
suite
(optional)
String
accessKeyId
(optional)
String
actionOnErrors
(optional)
String
actionOnWarnings
(optional)
String
commandLineArguments
(optional)
String
credentialsId
(optional)
String
executorType
(optional)
String
executorVersion
(optional)
String
generateMHT
(optional)
boolean
launchConfig
(optional)
project
(optional)
String
routine
(optional)
String
tags
(optional)
String
test
(optional)
String
unit
(optional)
String
value
(optional)
String
launchType
(optional)
String
project
(optional)
String
publishJUnitReports
(optional)
boolean
routine
(optional)
String
sessionScreenResolution
(optional)
String
tags
(optional)
String
test
(optional)
String
timeout
(optional)
String
unit
(optional)
String
useActiveSession
(optional)
boolean
useTCService
(optional)
boolean
useTimeout
(optional)
boolean
userName
(optional)
String
userPassword
(optional)
String
$class: 'TelegramBotBuilder'
message
String
$class: 'TelerikAppBuilder'
applicationId
String
accessToken
class hudson.util.Secret
configuration
String
buildSettingsiOS
mobileProvisionIdentifieriOS
String
codesigningIdentityiOS
String
buildSettingsAndroid
codesigningIdentityAndroid
String
buildSettingsWP
boolean
prismaIaC
assetName
String
templateType
String
templateVersion
String
tags
String
failureCriteriaHigh
String
failureCriteriaLow
String
failureCriteriaMedium
String
failureCriteriaOperator
String
$class: 'TerminateBox'
cloud
String
workspace
String
box
String
instance
String
buildStep
String
delete
boolean
cfyTerraform
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deploymentId
(optional)
ID to assign to the created Cloudify deployment. If not provided, one will be randomly generated. You can obtain the deployment ID from the "environment data" output file.
String
echoEnvData
(optional)
If checked, then the created environment's data will be printed to the job's log.
boolean
echoInputs
(optional)
boolean
envDataLocation
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
String
environmentVariables
(optional)
java.util.Map<java.lang.String, java.lang.String>
environmentVariablesAsString
(optional)
YAML/JSON containing environment variables to pass to the Terraform process. The provided string will be expanded for environment variables (${VAR_NAME}
).
String
environmentVariablesFile
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing environment variables to pass to the Terraform process.
String
executable
(optional)
Path, on Cloudify Manager, of the Terraform executable. If omitted, the value of the terraform_executable
Cloudify secret will be used.
String
pluginsDirectory
(optional)
Path, on Cloudify Manager, of Terraform's plugins directory. If omitted, the value of the terraform_plugins_dir
Cloudify secret will be used.
String
storageDirectory
(optional)
Path, on Cloudify Manager, of Terraform's storage directory. If omitted, the value of the terraform_storage_dir
Cloudify secret will be used.
String
templateUrl
(optional)
URL of the Terraform template. May be a ZIP, tar.gz
, or a Git repository.
String
tenant
(optional)
String
variables
(optional)
java.util.Map<java.lang.String, java.lang.Object>
variablesAsString
(optional)
YAML/JSON containing variables to pass to the Terraform template. The provided string will be expanded for environment variables (${VAR_NAME}
).
String
variablesFile
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
String
dotnetTest
dotnet test
command is used to execute unit tests in a given solution. It builds the solution and runs a test host application for each test project in the solution. The test host executes tests in the given project using a test framework, for example: MSTest, NUnit, or xUnit, and reports the success or failure of each test. If all tests are successful, the test runner returns 0 as an exit code; otherwise if any test fails, it returns 1.
blame
(optional)
TestResults/<Guid>/<Guid>_Sequence.xml
that captures the order of tests that were run before the crash.
boolean
blameCrash
(optional)
--blame
.
VSTEST_DUMP_FORCEPROCDUMP
environment variable to 1
.
boolean
blameCrashCollectAlways
(optional)
boolean
blameCrashDumpType
(optional)
--blame-crash
.
String
blameHang
(optional)
boolean
blameHangDumpType
(optional)
full
, mini
, or none
. When none
is specified, the test host is terminated on timeout, but no dump is collected. Implies --blame-hang
.
String
blameHangTimeout
(optional)
--blame
and --blame-hang
.
int
collect
(optional)
String
configuration
(optional)
Debug
, but you can override the build configuration settings in your project.
String
diag
(optional)
*.host_<date>.txt
for the test host log, and *.datacollector_<date>.txt
for the data collector log.
String
filter
(optional)
String
framework
(optional)
dotnet
or a .NET Framework test host for the test binaries. This option only determines which type of host to use. The actual framework version to be used is determined by the runtimeconfig.json of the test project. When not specified, the TargetFramework assembly attribute is used to determine the type of host. When that attribute is stripped from the .dll, the .NET Framework host is used.
String
listTests
(optional)
boolean
logger
(optional)
dotnet test
doesn't accept abbreviations: instead of "console;v=d
", use "console;verbosity=detailed
".
String
noBuild
(optional)
boolean
noRestore
(optional)
boolean
nologo
(optional)
boolean
option
(optional)
String
options
(optional)
String
optionsString
(optional)
String
outputDirectory
(optional)
./bin/<configuration>/<framework>/
. For projects with multiple target frameworks (via the TargetFrameworks
property), you also need to specify a framework when you specify this option. dotnet test
always runs tests from the output directory. You can use AppDomain.BaseDirectory to consume test assets in the output directory.
String
project
(optional)
String
properties
(optional)
java.util.Map<java.lang.String, java.lang.String>
propertiesString
(optional)
String
resultsDirectory
(optional)
TestResults
in the directory that contains the project file.
String
runSettings
(optional)
java.util.Map<java.lang.String, java.lang.String>
runSettingsString
(optional)
RunSettings
values, specified in in Java properties syntax.
String
runtime
(optional)
String
sdk
(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.
String
settings
(optional)
.runsettings
file to use for running the tests. Note that the TargetPlatform
element (x86|x64) has no effect for dotnet test
. To run tests that target x86, install the x86 version of .NET Core. The bitness of the dotnet.exe that is on the path is what will be used for running tests.
String
showSdkInfo
(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.
boolean
shutDownBuildServers
(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).
boolean
specificSdkVersion
(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.
boolean
testAdapterPath
(optional)
.TestAdapter.dll
are inspected. If not specified, the directory of the test .dll is searched.
String
unstableIfWarnings
(optional)
boolean
verbosity
(optional)
String
workDirectory
(optional)
String
$class: 'TestBuilder'
packageid
String
tempServer
value
String
serverName
String
dbName
String
serverAuth
value
String
username
String
password
class hudson.util.Secret
encryptConnection
boolean
trustServerCertificate
boolean
runTestSet
value
String
runOnlyParams
String
generateTestData
sqlgenPath
String
options
String
dataOptions
String
filter
String
packageVersion
String
sqlChangeAutomationVersionOption
value
Latest
, Specific
specificVersion
String
testSource
value
scaproject
, socartifact
projectPath
String
packageid
String
packageVersion
String
$class: 'TestCompositionRunner'
url
String
cloudTestServerID
String
composition
String
deleteOldResults
maxDaysOfResults
int
additionalOptions
String
thresholds
transactionname
String
thresholdname
String
thresholdvalue
String
thresholdid
String
generatePlotCSV
boolean
testFolder
testFile
String
executionConfig
(optional)
timeout
String
stopOnError
boolean
checkTestFile
boolean
recordWarnings
boolean
failFast
(optional)
boolean
packageConfig
(optional)
runTest
boolean
runTraceAnalysis
boolean
parameters
name
String
value
String
outputParameters
name
String
projectConfig
(optional)
execInCurrentPkgDir
boolean
filterExpression
String
jobExecMode
NO_EXECUTION
, SEQUENTIAL_EXECUTION
, PARALLEL_EXECUTION
, SEPARATE_SEQUENTIAL_EXECUTION
, SEPARATE_PARALLEL_EXECUTION
, NO_TESTCASE_EXECUTION
, TEST_GUIDE_EXECUTION
recursiveScan
(optional)
boolean
scanMode
(optional)
PACKAGES_ONLY
, PROJECTS_ONLY
, PACKAGES_AND_PROJECTS
testConfig
(optional)
tbcFile
String
tcfFile
String
forceReload
boolean
loadOnly
boolean
keepConfig
boolean
constants
name
String
value
String
$class: 'TestLinkBuilder'
testLinkName
String
testProjectName
String
testPlanName
String
platformName
String
buildName
String
customFields
String
testPlanCustomFields
String
executionStatusNotRun
boolean
executionStatusPassed
boolean
executionStatusFailed
boolean
executionStatusBlocked
boolean
singleBuildSteps
hudson.tasks.BuildStep
)beforeIteratingAllTestCasesBuildSteps
hudson.tasks.BuildStep
)iterativeBuildSteps
hudson.tasks.BuildStep
)afterIteratingAllTestCasesBuildSteps
hudson.tasks.BuildStep
)transactional
boolean
failedTestsMarkBuildAsFailure
boolean
failIfNoResults
boolean
failOnNotRun
boolean
resultSeekers
$class: 'JUnitCaseClassNameResultSeeker'
includePattern
String
keyCustomField
String
attachJUnitXML
boolean
includeNotes
boolean
$class: 'JUnitCaseNameResultSeeker'
includePattern
String
keyCustomField
String
attachJUnitXML
boolean
includeNotes
boolean
$class: 'JUnitMethodNameResultSeeker'
includePattern
String
keyCustomField
String
attachJUnitXML
boolean
includeNotes
boolean
$class: 'JUnitSuiteNameResultSeeker'
includePattern
String
keyCustomField
String
attachJUnitXML
boolean
includeNotes
boolean
$class: 'TAPFileNameMultiTestPointsResultSeeker'
includePattern
String
keyCustomField
String
attachTAPStream
boolean
attachYAMLishAttachments
boolean
includeNotes
boolean
compareFullPath
boolean
testpointsAsExecutions
boolean
$class: 'TAPFileNameResultSeeker'
includePattern
String
keyCustomField
String
attachTAPStream
boolean
attachYAMLishAttachments
boolean
includeNotes
boolean
compareFullPath
boolean
$class: 'TestNGClassNameResultSeeker'
includePattern
String
keyCustomField
String
attachTestNGXML
boolean
markSkippedTestAsBlocked
boolean
includeNotes
boolean
$class: 'TestNGMethodNameDataProviderNameResultSeeker'
includePattern
String
keyCustomField
String
attachTestNGXML
boolean
markSkippedTestAsBlocked
boolean
dataProviderNameKeyCustomField
String
includeNotes
boolean
$class: 'TestNGMethodNameResultSeeker'
includePattern
String
keyCustomField
String
attachTestNGXML
boolean
markSkippedTestAsBlocked
boolean
includeNotes
boolean
$class: 'TestNGSuiteNameResultSeeker'
includePattern
String
keyCustomField
String
attachTestNGXML
boolean
markSkippedTestAsBlocked
boolean
includeNotes
boolean
$class: 'TestOdysseyBuilder'
jobId
String
projectId
String
minPassPercentage
String
testPackage
testFile
String
executionConfig
(optional)
timeout
String
stopOnError
boolean
checkTestFile
boolean
recordWarnings
boolean
packageConfig
(optional)
runTest
boolean
runTraceAnalysis
boolean
parameters
name
String
value
String
outputParameters
name
String
testConfig
(optional)
tbcFile
String
tcfFile
String
forceReload
boolean
loadOnly
boolean
keepConfig
boolean
constants
name
String
value
String
testProject
testFile
String
executionConfig
(optional)
timeout
String
stopOnError
boolean
checkTestFile
boolean
recordWarnings
boolean
projectConfig
(optional)
execInCurrentPkgDir
boolean
filterExpression
String
jobExecMode
NO_EXECUTION
, SEQUENTIAL_EXECUTION
, PARALLEL_EXECUTION
, SEPARATE_SEQUENTIAL_EXECUTION
, SEPARATE_PARALLEL_EXECUTION
, NO_TESTCASE_EXECUTION
, TEST_GUIDE_EXECUTION
testConfig
(optional)
tbcFile
String
tcfFile
String
forceReload
boolean
loadOnly
boolean
keepConfig
boolean
constants
name
String
value
String
$class: 'TestRunner'
stack
String
branch
String
testNames
String
undeploy
boolean
apiKey
String
$class: 'TestStepBuilder'
packageId
String
serverType
String
server
String
database
String
authenticationType
String
userName
String
password
class hudson.util.Secret
runTestMode
String
runTests
String
compareOptions
(optional)
String
dgenFile
(optional)
String
filterFile
(optional)
String
generateTestData
(optional)
boolean
transactionIsoLvl
(optional)
String
$class: 'TestStudioAPITestBuilder'
apiRunnerPath
(optional)
String
project
(optional)
String
test
(optional)
String
startFrom
(optional)
String
stopAfter
(optional)
String
variable
(optional)
String
dontSaveContexts
(optional)
boolean
testAsUnit
(optional)
boolean
$class: 'TestStudioTestBuilder'
artOfTestRunnerPath
String
testPath
String
settingsPath
String
dateFormat
Letter | Date or Time Component | Presentation | Examples |
---|---|---|---|
G | Era designator | Text | AD |
y | Year | Year | 1996; 96 |
Y | Week year | Year | 2009; 09 |
M/L | Month in year | Month | July; Jul; 07 |
w | Week in year | Number | 27 |
W | Week in month | Number | 2 |
D | Day in year | Number | 189 |
d | Day in month | Number | 10 |
F | Day of week in month | Number | 2 |
E | Day in week | Text | Tuesday; Tue |
u | Day number of week | Number | 1 |
a | Am/pm marker | Text | PM |
H | Hour in day (0-23) | Number | 0 |
k | Hour in day (1-24) | Number | 24 |
K | Hour in am/pm (0-11) | Number | 0 |
h | Hour in am/pm (1-12) | Number | 12 |
m | Minute in hour | Number | 30 |
s | Second in minute | Number | 55 |
S | Millisecond | Number | 978 |
z | Time zone | General time zone | Pacific Standard Time; PST; GMT-08:00 |
Z | Time zone | RFC 822 time zone | -0800 |
X | Time zone | ISO 8601 time zone | -08; -0800; -08:00 |
Input string | Pattern |
---|---|
2001.07.04 AD at 12:08:56 PDT | yyyy.MM.dd G 'at' HH:mm:ss z |
Wed, Jul 4, '01 | EEE, MMM d, ''yy |
12:08 PM | h:mm a |
12 o'clock PM, Pacific Daylight Time | hh 'o''clock' a, zzzz |
0:08 PM, PDT | K:mm a, z |
02001.July.04 AD 12:08 PM | yyyyy.MMMM.dd GGG hh:mm aaa |
Wed, 4 Jul 2001 12:08:56 -0700 | EEE, d MMM yyyy HH:mm:ss Z |
010704120856-0700 | yyMMddHHmmssZ |
2001-07-04T12:08:56.235-0700 | yyyy-MM-dd'T'HH:mm:ss.SSSZ |
2001-07-04T12:08:56.235-07:00 | yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
2001-W27-3 | YYYY-'W'ww-u |
String
projectRoot
(optional)
String
testAsUnit
(optional)
boolean
outputPath
(optional)
String
$class: 'TestSwarmBuilder'
testswarmServerUrl
String
jobName
String
userName
String
authToken
String
maxRuns
String
chooseBrowsers
String
pollingIntervalInSecs
String
timeOutPeriodInMins
String
minimumPassing
String
testSuiteList
testName
String
testUrl
String
testCacheCracker
boolean
disableTest
boolean
testweaver
projectPath
String
experimentName
String
jUnitReportDirectory
String
acceptInconclusiveWatchers
(optional)
boolean
exportAsCsvDecimalSeparator
(optional)
String
exportAsCsvDirectory
(optional)
String
exportAsCsvNoQuote
(optional)
boolean
exportAsCsvQuote
(optional)
String
exportAsCsvReports
(optional)
String
exportAsCsvSeparator
(optional)
String
htmlReportDirectory
(optional)
String
instrumentView
(optional)
boolean
namespacePattern
(optional)
String
parameterValues
(optional)
String
runScenarioLimit
(optional)
int
runTimeLimit
(optional)
long
silverParameters
(optional)
String
$class: 'TesteinRunBuilder'
targetType
String
targetId
String
downloadReport
boolean
downloadLogs
boolean
$class: 'TesteinUploadStepBuilder'
enableJs
jsFilePath
String
jsonFilePath
String
enableJar
jarFilePath
String
overwrite
boolean
$class: 'TestingBotBuilder'
name
String
$class: 'TestiniumPlugin'
projectId
(optional)
int
planId
(optional)
int
abortOnError
(optional)
boolean
abortOnFailed
(optional)
boolean
failOnTimeout
(optional)
boolean
ignoreInactive
(optional)
boolean
timeoutSeconds
(optional)
int
$class: 'TestopiaBuilder'
testopiaInstallationName
String
testRunId
int
singleBuildSteps
hudson.tasks.BuildStep
)beforeIteratingAllTestCasesBuildSteps
hudson.tasks.BuildStep
)iterativeBuildSteps
hudson.tasks.BuildStep
)afterIteratingAllTestCasesBuildSteps
hudson.tasks.BuildStep
)failedTestsMarkBuildAsFailure
boolean
resultSeekers
$class: 'JUnitCaseClassNameResultSeeker'
includePattern
String
$class: 'JUnitCaseNameResultSeeker'
includePattern
String
$class: 'JUnitMethodNameResultSeeker'
includePattern
String
$class: 'JUnitSuiteNameResultSeeker'
includePattern
String
$class: 'TAPFileNameResultSeeker'
includePattern
String
$class: 'TestNGClassNameResultSeeker'
includePattern
String
markSkippedTestAsBlocked
boolean
$class: 'TestNGMethodNameResultSeeker'
includePattern
String
markSkippedTestAsBlocked
boolean
$class: 'TestNGSuiteNameResultSeeker'
includePattern
String
markSkippedTestAsBlocked
boolean
convertTestsToRun
Framework | Linux shell |
Maven Surefire | mvn clean -Dtest=$testsToRunConverted test |
Maven Failsafe | mvn clean -Dit.test=$testsToRunConverted verify |
Gradle | gradle test $testsToRunConverted |
Protractor | protractor conf.js --grep="$testsToRunConverted" |
Cucumber-JVM over Maven/ BDD Scenario |
mvn clean -Dcucumber.options="$testsToRunConverted" test |
JBehave over Maven | mvn clean -Dfeatures="$testsToRunConverted" test |
Framework | Windows batch command |
Maven Surefire | mvn clean -Dtest=%testsToRunConverted% test |
Maven Failsafe | mvn clean -Dit.test=%testsToRunConverted% verify |
Gradle | gradle test %testsToRunConverted% |
Protractor | protractor conf.js --grep="%testsToRunConverted%" |
Cucumber-JVM over Maven/ BDD Scenario |
mvn clean -Dcucumber.options="%testsToRunConverted%" test |
JBehave over Maven | mvn clean -Dfeatures="%testsToRunConverted%" test |
Framework | Pipeline script |
Maven Surefire | bat 'mvn clean -Dtest=${params.testsToRunConverted} test' |
Maven Failsafe | bat 'mvn clean -Dit.test=${params.testsToRunConverted} verify' |
Gradle | bat 'gradle test ${params.testsToRunConverted}' |
Protractor | bat(/protractor conf.js --grep="${params.testsToRunConverted}"/) |
Cucumber-JVM over Maven/ BDD Scenario |
bat(/mvn clean -Dcucumber.options="${params.testsToRunConverted}" test/) |
JBehave over Maven | bat(/mvn clean -Dfeatures="${testsToRunConverted}" test/) |
framework
String
format
{ "testPattern": "$package.$class#$testName", "testDelimiter": "," }
"replacements": [ { "type": "replaceRegex", "target": "$package|$class|$testName", "regex": "aaa", "replacement": "bbb", "description": "Replaces all the sequence of characters matching the regex with a replacement string." },{ "type": "replaceRegexFirst", "target": "$package|$class|$testName", "regex": "aaa", "replacement": "bbb", "description": "Replaces the first substring that matches the given regex with the given replacement. For example, given regex '@(.*)@.*' , replacement '$1', and test name '@myTag@ my test name' - will replace test name by the content located between @, that is - 'myTag'." },{ "type": "replaceString", "target": "$package|$class|$testName", "string": "xxx", "replacement": "yyy", "description": "Replaces all occurrences of ‘string’ with ‘replacement’." },{ "type": "joinString", "target": "$package|$class|$testName", "prefix": "xxx", "suffix": "yyy", "description": "Add prefix and suffix to the test template." },{ "type": "toLowerCase", "target": "$package|$class|$testName", "description": "Convert test template to lower case." },{ "type": "toUpperCase", "target": "$package|$class|$testName", "description": "Convert test template to upper case." },{ "type": "notLatinAndDigitToOctal", "target": "$package|$class|$testName", "description": "Replaces all non-latin characters and digits ^[a-zA-Z0-9] to their ASCII octal value." }]
String
$class: 'TestsigmaExecutionBuilder'
apiEndPoint
String
apiKey
String
testPlanId
String
maxWaitInMinutes
String
reportsFilePath
String
$class: 'TicsAnalyzer'
ticsPath
C:\Program Files (x86)\TIOBE\TICS\BuildServer
. This directory should contain the TICSQServer
and TICSMaintenance
executables. You can leave this field empty if these executables can be found on the PATH environment variable of the Jenkins slave user.String
ticsConfiguration
C:\Program Files (x86)\TIOBE\TICS\FileServer\cfg
. The TICS configuration directory contains the SERVER.txt
and PROJECTS.txt
configuration files, among others. This setting sets the TICS
environment variable before executing TICSQServer
. You can leave this field empty if this variable is already set on the Jenkins slave.String
projectName
TICSMaintenance
from the command line. Note that you can use Jenkins environment variables such as $JOB_NAME
here.String
branchName
String
branchDirectory
TICSMaintenance -branchdir
. Note that you can use Jenkins variables (such as $WORKSPACE
) here.String
environmentVariables
$WORKSPACE
here. Example:
TICS_M2_OPTS=-s C:\Tools\apache-maven\conf\settings.xml TICS_COVERITY_URL=http://localhost:8080 QACBIN=C:/QAC/common/bin PATH=C:\Tools\bin;$PATH
String
createTmpdir
boolean
tmpdir
C:/temp/$JOB_NAME
.String
extraArguments
String
calc
ABSTRACTINTERPRETATION
boolean
ACCUCHANGERATE
boolean
ACCUFIXRATE
boolean
ACCULINESADDED
boolean
ACCULINESCHANGED
boolean
ACCULINESDELETED
boolean
ALL
boolean
AVGCYCLOMATICCOMPLEXITY
boolean
BUILDRELATIONS
boolean
CHANGEDFILES
boolean
CHANGERATE
boolean
CODINGSTANDARD
boolean
COMPILERWARNING
boolean
DEADCODE
boolean
DUPLICATEDCODE
boolean
ELOC
boolean
FANOUT
boolean
FINALIZE
boolean
FIXRATE
boolean
GLOC
boolean
INCLUDERELATIONS
boolean
INTEGRATIONTESTCOVERAGE
boolean
LINESADDED
boolean
LINESCHANGED
boolean
LINESDELETED
boolean
LOC
boolean
MAXCYCLOMATICCOMPLEXITY
boolean
PREPARE
boolean
SECURITY
boolean
SYSTEMTESTCOVERAGE
boolean
TOTALTESTCOVERAGE
boolean
UNITTESTCOVERAGE
boolean
recalc
ABSTRACTINTERPRETATION
boolean
ACCUCHANGERATE
boolean
ACCUFIXRATE
boolean
ACCULINESADDED
boolean
ACCULINESCHANGED
boolean
ACCULINESDELETED
boolean
ALL
boolean
AVGCYCLOMATICCOMPLEXITY
boolean
BUILDRELATIONS
boolean
CHANGEDFILES
boolean
CHANGERATE
boolean
CODINGSTANDARD
boolean
COMPILERWARNING
boolean
DEADCODE
boolean
DUPLICATEDCODE
boolean
ELOC
boolean
FANOUT
boolean
FINALIZE
boolean
FIXRATE
boolean
GLOC
boolean
INCLUDERELATIONS
boolean
INTEGRATIONTESTCOVERAGE
boolean
LINESADDED
boolean
LINESCHANGED
boolean
LINESDELETED
boolean
LOC
boolean
MAXCYCLOMATICCOMPLEXITY
boolean
PREPARE
boolean
SECURITY
boolean
SYSTEMTESTCOVERAGE
boolean
TOTALTESTCOVERAGE
boolean
UNITTESTCOVERAGE
boolean
runTics
projectName
String
branchName
String
branchDirectory
(optional)
String
calc
(optional)
String
environmentVariables
(optional)
java.util.LinkedHashMap<java.lang.String, java.lang.String>
extraArguments
(optional)
String
recalc
(optional)
String
ticsBin
(optional)
String
ticsConfiguration
(optional)
String
tmpdir
(optional)
String
totaltestUT
connectionId
String
credentialsId
String
projectFolder
String
testSuite
Wild carding of test scenarios/suites names can be done using '*' for any characters and '?' for a single character. 'All_Scenarios' can be used to run all test scenarios or 'All_Suites' can be used to run all test suites.
String
jcl
String
ccClearStats
(optional)
boolean
ccDB2
(optional)
boolean
ccPgmType
(optional)
String
ccRepo
(optional)
String
ccSystem
(optional)
String
ccTestId
(optional)
String
deleteTemp
(optional)
boolean
hlq
(optional)
String
hostPort
(optional)
String
recursive
(optional)
boolean
useStubs
(optional)
boolean
totaltest
environmentId
String
folderPath
String
serverUrl
String
serverCredentialsId
String
connectionId
String
credentialsId
String
sonarVersion
(optional)
String
logLevel
(optional)
String
accountInfo
(optional)
Use the accounting information field to enter an account number and any other accounting information that your installation requires.
The accounting information must be entered, just as it would be on the job card. Currently only 52 characters are allowed for the accounting information.
String
ccThreshold
(optional)
int
clearCodeCoverage
(optional)
boolean
collectCCRepository
(optional)
String
collectCCSystem
(optional)
String
collectCCTestID
(optional)
String
collectCodeCoverage
(optional)
boolean
compareJUnits
(optional)
boolean
contextVariables
(optional)
String
createJUnitReport
(optional)
boolean
createReport
(optional)
boolean
createResult
(optional)
boolean
createSonarReport
(optional)
boolean
customerId
(optional)
String
enterpriseDataHostPort
(optional)
String
enterpriseDataWorkspace
(optional)
String
haltAtFailure
(optional)
boolean
haltPipelineOnFailure
(optional)
boolean
jclPath
(optional)
String
jsonFile
(optional)
Use the JSON file field to enter a JSON file containing the tests to execute.
Note: This field is only used for Total Test CLI version 20.04.01 and later
String
localConfig
(optional)
boolean
localConfigLocation
(optional)
String
programList
(optional)
Use the Test list field to enter a comma separated list of program names to be tested. Will only include test scenarios that have component under test defined as one of these
Note: This field is only used for Total Test CLI version 20.04.01 and later
String
recursive
(optional)
boolean
reportFolder
(optional)
String
selectEnvironmentRadio
(optional)
String
selectProgramsOption
(optional)
boolean
selectProgramsRadio
(optional)
String
siteId
(optional)
String
sourceFolder
(optional)
String
stopIfTestFailsOrThresholdReached
(optional)
boolean
uploadToServer
(optional)
boolean
useEnterpriseData
(optional)
boolean
useScenarios
(optional)
boolean
$class: 'ToxBuilder'
toxIni
String
recreate
boolean
toxenvPattern
String
tptExecute
exePaths
String
executionConfiguration
tptFile
String
configuration
String
id
String
enableTest
(optional)
boolean
reportDir
(optional)
String
testSet
(optional)
String
testdataDir
(optional)
String
timeout
(optional)
long
arguments
(optional)
String
enableJunit
(optional)
boolean
isTptMaster
(optional)
boolean
jUnitLogLevel
(optional)
NONE
, ERROR
, WARNING
, INFO
, ALL
jUnitreport
(optional)
String
slaveJob
(optional)
String
slaveJobCount
(optional)
String
slaveJobTries
(optional)
String
tptBindingName
(optional)
String
tptPort
(optional)
String
tptStartUpWaitTime
(optional)
String
tptAgent
exePaths
String
tptBindingName
(optional)
String
tptPort
(optional)
String
tptStartUpWaitTime
(optional)
String
tricentisCI
newTricentisClientPath
String
newEndpoint
String
configurationFilePath
(optional)
Specify the path to the Tricentis CI test execution configuration XML file. The test configuration file includes more details about which items you would like to execute.
If you use this setting, leave the TestEvents setting of this page empty. Otherwise, this build step fails.
String
endpoint
(optional)
Specify the address of the webservice. This component triggers the test execution.
If you execute your tests via Tosca Remote Service, the endpoint needs to point to the TOSCARemoteExecutionService (e.g. http://servername:8732/TOSCARemoteExecutionService/).
If you execute your tests via Tosca Distributed Execution, the endpoint needs to point to the Manager Service of the Tosca Distribution Server (e.g. http://servername:8732/DistributionServerService/ManagerService.svc).
String
testEvents
(optional)
Input the TestEvents that you want to execute, separated by semicolons. You can identify the TestEvents with their name or their system ID.
This field is optional. It can only be used if you execute your tests via Tosca Distributed Execution.
If you use this setting, leave the Configuration File setting of this page empty. Otherwise, this build step fails.
String
tricentisClientPath
(optional)
Specify the path to the Tricentis CI test execution configuration XML file. The test configuration file includes more details about which items you would like to execute.
If you use this setting, leave the TestEvents setting of this page empty. Otherwise, this build step fails.
String
$class: 'TriggerBuilder'
configs
projects
String
block
buildStepFailureThreshold
String
unstableThreshold
String
failureThreshold
String
configFactories
$class: 'AllNodesBuildParameterFactory'
$class: 'AllNodesForLabelBuildParameterFactory'
name
String
nodeLabel
String
ignoreOfflineNodes
boolean
$class: 'BinaryFileParameterFactory'
This implementation does not interpret the contents of those files, and instead it simply gets passed and placed into the workspace of the triggered project(s) under the name specified here.
This is useful, for example, when you have a portion of the job that can be split into concurrently executable subtasks. In such a situation, you can have an earlier step produce subtask work units by packaging necessary stuff into individual files, then use this mode to execute them all in parallel.
parameterName
String
filePattern
String
noFilesFoundAction
SKIP
, NOPARMS
, FAIL
$class: 'CounterBuildParameterFactory'
from
String
to
String
step
String
paramExpr
String
validationFail
FAIL
, SKIP
, NOPARMS
$class: 'CounterGeneratorParameterFactory'
from
String
to
String
step
String
paramExpr
String
validationFail
FAIL
, SKIP
, NOPARMS
$class: 'FileBuildParameterFactory'
filePattern
String
encoding
String
noFilesFoundAction
SKIP
, NOPARMS
, FAIL
$class: 'FileGeneratorParameterFactory'
filePattern
String
noFilesFoundAction
SKIP
, NOPARMS
, FAIL
$class: 'MultipleBinaryFileParameterFactory'
parametersList
class org.jenkinsci.plugins.parallel_test_executor.MultipleBinaryFileParameterFactory$ParameterBinding
noFilesFoundAction
SKIP
, NOPARMS
, FAIL
$class: 'NodeListBuildParameterFactory'
name
String
nodeListString
String
configs
$class: 'BooleanParameters'
configs
name
String
value
boolean
$class: 'CurrentBuildParameters'
$class: 'FileBuildParameters'
propertiesFile
String
encoding
String
failTriggerOnMissing
boolean
useMatrixChild
boolean
combinationFilter
String
onlyExactRuns
boolean
textParamValueOnNewLine
boolean
$class: 'GeneratorCurrentParameters'
$class: 'GitRevisionBuildParameters'
combineQueuedCommits
boolean
$class: 'MatrixSubsetBuildParameters'
filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggered job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String
$class: 'NodeLabelBuildParameter'
name
String
nodeLabel
String
$class: 'NodeParameters'
$class: 'PredefinedBuildParameters'
properties
String
textParamValueOnNewLine
boolean
$class: 'PredefinedGeneratorParameters'
properties
String
$class: 'SubversionRevisionBuildParameters'
includeUpstreamParameters
boolean
$class: 'TwitterPublisher'
tokenCredentialsID
String
consumerCredentialsID
String
tweetText
String
UiPathAssets
assetsAction
AutoVersion
CurrentVersion
DeleteAssets
DeployAssets
Dynamically
jobsCount
int
user
String
machine
String
ExternalApp
accountForApp
String
applicationId
String
applicationSecret
String
applicationScope
String
identityUrl
String
CustomVersion
version
String
NonProduction
Robot
robotsIds
String
Test
TestProject
testProjectPath
String
environments
String
TestSet
testSet
String
Token
credentialsId
String
accountName
String
Unattended
UserPass
credentialsId
String
orchestratorAddress
String
orchestratorTenant
String
folderName
String
credentials
AutoVersion
CurrentVersion
DeleteAssets
DeployAssets
Dynamically
jobsCount
int
user
String
machine
String
ExternalApp
accountForApp
String
applicationId
String
applicationSecret
String
applicationScope
String
identityUrl
String
CustomVersion
version
String
NonProduction
Robot
robotsIds
String
Test
TestProject
testProjectPath
String
environments
String
TestSet
testSet
String
Token
credentialsId
String
accountName
String
Unattended
UserPass
credentialsId
String
filePath
String
traceLevel
None
, Critical
, Error
, Warning
, Information
, Verbose
UiPathPack
version
AutoVersion
CurrentVersion
DeleteAssets
DeployAssets
Dynamically
jobsCount
int
user
String
machine
String
ExternalApp
accountForApp
String
applicationId
String
applicationSecret
String
applicationScope
String
identityUrl
String
CustomVersion
version
String
NonProduction
Robot
robotsIds
String
Test
TestProject
testProjectPath
String
environments
String
TestSet
testSet
String
Token
credentialsId
String
accountName
String
Unattended
UserPass
credentialsId
String
projectJsonPath
String
outputPath
String
traceLevel
None
, Critical
, Error
, Warning
, Information
, Verbose
credentials
(optional)
AutoVersion
CurrentVersion
DeleteAssets
DeployAssets
Dynamically
jobsCount
int
user
String
machine
String
ExternalApp
accountForApp
String
applicationId
String
applicationSecret
String
applicationScope
String
identityUrl
String
CustomVersion
version
String
NonProduction
Robot
robotsIds
String
Test
TestProject
testProjectPath
String
environments
String
TestSet
testSet
String
Token
credentialsId
String
accountName
String
Unattended
UserPass
credentialsId
String
orchestratorAddress
(optional)
String
orchestratorTenant
(optional)
String
outputType
(optional)
String
runWorkflowAnalysis
(optional)
boolean
useOrchestrator
(optional)
boolean
$class: 'UnicornValidationBuilder'
unicornUrl
String
siteUrl
String
maxErrorsForStable
String
maxWarningsForStable
String
maxErrorsForUnstable
String
maxWarningsForUnstable
String
$class: 'UninstallBuilder'
packageId
String
failOnUninstallFailure
boolean
$class: 'Unity3dBuilder'
For projects that use Unity3d as the build system.
This causes Jenkins to invoke the Unity3d Editor with the given command line arguments.
A non-zero exit code from Unity3d makes Jenkins mark the build as a failure.
unity3dName
String
argLine
-quit -batchmode -executeMethod YourEditorScript.YourBuildMethod [-nographics]
or
-quit -batchmode -buildWindowsPlayer path/to/your/build.exe
or
-quit -batchmode -buildOSXPlayer path/to/your/build.app
If this value isn't set, the globalArgLine is used.
Note: we make little to no attempt to detect conflicting arguments or arguments not suitable to the platform neither at configuration nor at runtime.
If the specified command line contains no -projectpath
argument, the plugin automatically adds one with the proper parameter (the workspace of the project on the target machine). This is to make sure unity builds the proper project. Otherwise unity would reuse the last opened project. You can override it, but this hasn't been thoroughly tested.
If your build agent have multiple executors (which you should probably do), it is highly recommended to make use of a -logFile
argument to avoid letting Unityed write to the standard editor.log concurrently. A recommended practise is to use something like -logFile "$WORKSPACE/unity3d_editor.log"
.
See the official Editor command line arguments documentation.
String
unstableReturnCodes
String
unshelve
shelf
String
resolve
String
tidy
boolean
ignoreEmpty
boolean
tpAppUpdateFile
projectId
(optional)
String
appId
(optional)
String
filePath
(optional)
String
tpAppUpdateURL
projectId
(optional)
String
appId
(optional)
String
applicationUrl
(optional)
String
$class: 'UpdateBox'
cloud
String
workspace
String
box
String
variables
String
tpDataSourceUpdate
projectId
(optional)
String
dataSourceId
(optional)
String
filePath
(optional)
String
azureVMSSUpdateInstances
azureCredentialsId
String
resourceGroup
String
name
String
instanceIds
,
'.
String
$class: 'UpdatePriority'
prefix
String
priority
String
$class: 'UpdateProjectBuilder'
tpProjectParamUpdate
projectId
(optional)
String
parameterId
(optional)
String
parameterValue
(optional)
String
$class: 'UpdateReleaseStage'
releasePrefix
String
stage
String
$class: 'UpdateStatus'
prefix
String
status
String
tpTestPackageUpdate
projectId
(optional)
String
testPackageId
(optional)
String
filePath
(optional)
String
resolveConflicts
(optional)
boolean
updraftPublish
url
String
path
String
$class: 'UploadAppBuildStep'
applicationLocation
String
keystoreInfo
keystoreLocation
String
keystorePassword
String
keyAlias
String
keyPassword
String
extraArguments
touchId
boolean
camera
boolean
allowResign
boolean
uuid
String
uniqueName
String
$class: 'UploadAppBuilder'
mcServerName
String
mcUserName
String
mcPassword
String
mcTenantId
String
proxySettings
fsUseAuthentication
boolean
fsProxyAddress
String
fsProxyUserName
String
fsProxyPassword
class hudson.util.Secret
applicationPaths
mcAppPath
String
uploadCloudifyBlueprint
Use this step to upload a blueprint to Cloudify Manager.
Two paramters are mandatory:
In addition, exactly one of the following parameters is mandatory:
If you provide a blueprint's root directory, then the entire directory contents are packaged into a blueprint archive.
archivePath
(optional)
String
archiveUrl
(optional)
String
blueprintId
(optional)
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
mainFileName
(optional)
String
rootDirectory
(optional)
String
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
$class: 'UploadBuild'
tenantId
String
id
String
name
String
versionName
String
revision
String
requestor
String
status
String
startTime
String
endTime
String
appName
String
appId
String
appExtId
String
debug
boolean
fatal
boolean
upload-pgyer
uKey
String
apiKey
String
scanDir
String
wildcard
String
installType
String
password
String
updateDescription
String
channelShortcut
String
qrcodePath
String
envVarsPath
String
upload-pgyer-v2
apiKey
String
scanDir
String
wildcard
String
buildName
String
buildInstallType
String
buildPassword
String
buildUpdateDescription
String
buildChannelShortcut
String
qrcodePath
String
envVarsPath
String
$class: 'UploadDeployment'
id
String
tenantId
String
name
String
result
String
initiator
String
versionName
String
versionExtId
String
type
String
environmentId
String
environmentName
String
description
String
startTime
String
endTime
String
appName
String
appId
String
appExtId
String
debug
boolean
fatal
boolean
$class: 'UploadJUnitTestResult'
properties
java.util.Map<java.lang.String, java.lang.String>
$class: 'UploadMetricsFile'
tenantId
String
name
String
filePath
String
testSetName
String
environment
String
combineTestSuites
boolean
fatal
boolean
debug
boolean
pluginType
String
dataFormat
String
recordName
String
metricDefinitionId
String
metricsRecordUrl
String
description
String
executionDate
String
buildId
String
buildUrl
String
appId
String
appName
String
appExtId
String
uploadProgetPackage
feedName
String
groupName
A string of no more than fifty characters:
String
packageName
A string of no more than fifty characters:
String
version
String
artifacts
Removing Unwanted Folders
Top level folders can be excluded from the package using a custom addition to the Ant fileset - wrapping unwanted folder names in square brackets ([ ]):
String
caseSensitive
(optional)
org.apache.tools.ant.DirectoryScanner
which by default is case sensitive. For instance, if the job produces *.hpi files, pattern "**/*.HPI" will fail to find them.
boolean
defaultExcludes
(optional)
boolean
dependencies
(optional)
String
description
(optional)
String
excludes
(optional)
String
icon
(optional)
String
metadata
(optional)
If you need to add additional metadata, it's strongly recommended that you prefix these properties with an underscore (_) on the off-chance that a property you add will exist in a future version of the specification.
String
title
(optional)
A string of no more than fifty characters
String
uploadCloudifyBlueprint
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
outputLocation
(optional)
String
tenant
(optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String
wagonLocation
(optional)
String
yamlLocation
(optional)
plugin.yaml
file of the plugin.
String
$class: 'UpmergeBuilder'
commitUsername
String
uTesterUrlListTask
initialUrl
String
urlsWhiteList
String
rulesList
rule
String
complianceMinimum
float
allowSimultaneousLogins
boolean
loginFlowJson
String
useRunner
boolean
fetchResponseTimeout
int
useMango
useSlaveNodes
String
nodeLabel
String
projectId
String
tags
String
testName
String
testStatus
String
assignedTo
String
vb6
projectFile
String
compileConstants
(optional)
String
outDir
(optional)
String
vCommander
action
$class: 'VCommanderRequestNewServiceAction'
payload
String
sync
boolean
timeout
long
polling
long
$class: 'VCommanderRunWorkflowAction'
targetType
String
targetName
String
workflowName
String
sync
boolean
timeout
long
polling
long
$class: 'VCommanderWaitForRequestNewServiceAction'
requestId
String
timeout
long
polling
long
$class: 'VCommanderWaitForRunWorkflowAction'
taskId
String
timeout
long
polling
long
$class: 'VMGRAPI'
vAPIUrl
String
vAPIUser
String
vAPIPassword
String
vAPIInput
String
vJsonInputFile
String
deleteInputFile
boolean
authRequired
boolean
apiType
String
dynamicUserId
boolean
apiUrl
String
requestMethod
String
advConfig
boolean
connTimeout
int
readTimeout
int
$class: 'VMGRLaunch'
vAPIUrl
String
vAPIUser
String
vAPIPassword
String
vSIFName
String
vSIFInputFile
String
credentialInputFile
String
deleteInputFile
boolean
deleteCredentialInputFile
boolean
useUserOnFarm
boolean
authRequired
boolean
vsifType
String
userFarmType
String
dynamicUserId
boolean
advConfig
boolean
connTimeout
int
readTimeout
int
envVarible
boolean
envVaribleFile
String
inaccessibleResolver
String
stoppedResolver
String
failedResolver
String
doneResolver
String
suspendedResolver
String
waitTillSessionEnds
boolean
stepSessionTimeout
int
generateJUnitXML
boolean
extraAttributesForFailures
boolean
staticAttributeList
String
markBuildAsFailedIfAllRunFailed
boolean
failJobIfAllRunFailed
boolean
envSourceInputFile
String
vMGRBuildArchive
boolean
deleteAlsoSessionDirectory
boolean
genericCredentialForSessionDelete
boolean
archiveUser
String
archivePassword
String
famMode
String
famModeLocation
String
noAppendSeed
boolean
markBuildAsPassedIfAllRunPassed
boolean
failJobUnlessAllRunPassed
boolean
userPrivateSSHKey
boolean
attrValues
boolean
attrValuesFile
String
executionType
String
sessionsInputFile
String
deleteSessionInputFile
boolean
envVariableType
String
envVariableText
String
attrVariableType
String
attrVariableText
String
pauseSessionOnBuildInterruption
boolean
envSourceInputFileType
String
executionScript
String
executionShellLocation
String
executionVsifFile
String
defineVaribleFile
String
defineVarible
boolean
defineVariableType
String
defineVariableText
String
$class: 'VSphereBuildStepContainer'
buildStep
$class: 'Clone'
sourceName
String
clone
String
linkedClone
boolean
resourcePool
String
cluster
String
datastore
String
folder
String
powerOn
boolean
timeoutInSeconds
int
customizationSpec
String
$class: 'ConvertToTemplate'
vm
String
force
boolean
$class: 'ConvertToVm'
template
String
resourcePool
String
cluster
String
$class: 'Delete'
vm
String
failOnNoExist
boolean
$class: 'DeleteSnapshot'
vm
String
snapshotName
String
consolidate
boolean
failOnNoExist
boolean
$class: 'Deploy'
template
String
clone
String
linkedClone
boolean
resourcePool
String
cluster
String
datastore
String
folder
String
customizationSpec
String
timeoutInSeconds
int
powerOn
boolean
$class: 'ExposeGuestInfo'
vm
String
envVariablePrefix
String
waitForIp4
boolean
$class: 'PowerOff'
vm
String
evenIfSuspended
boolean
shutdownGracefully
boolean
ignoreIfNotExists
boolean
gracefulShutdownTimeout
(optional)
int
$class: 'PowerOn'
vm
String
timeoutInSeconds
int
$class: 'Reconfigure'
vm
String
reconfigureSteps
$class: 'ReconfigureAnnotation'
annotation
(optional)
String
append
(optional)
boolean
$class: 'ReconfigureCpu'
cpuCores
String
coresPerSocket
String
$class: 'ReconfigureDisk'
diskSize
String
datastore
String
$class: 'ReconfigureMemory'
memorySize
String
$class: 'ReconfigureNetworkAdapters'
deviceAction
ADD
, EDIT
, REMOVE
deviceLabel
String
macAddress
String
standardSwitch
boolean
portGroup
String
distributedSwitch
boolean
distributedPortGroup
String
distributedPortId
String
$class: 'Rename'
oldName
String
newName
String
$class: 'RenameSnapshot'
vm
String
oldName
String
newName
String
newDescription
String
$class: 'RevertToSnapshot'
vm
String
snapshotName
String
$class: 'SuspendVm'
vm
String
$class: 'TakeSnapshot'
vm
String
snapshotName
String
description
String
includeMemory
boolean
serverName
String
$class: 'VaddyPlugin'
host
String
userId
String
authKey
String
crawlId
String
apiServerUrl
String
proxyHost
String
proxyPort
String
$class: 'VagrantDestroyCommand'
vagrantFile
String
vagrantVm
String
$class: 'VagrantProvisionCommand'
vagrantFile
String
vagrantVm
String
provisioners
String
parallel
boolean
$class: 'VagrantSshCommand'
vagrantFile
String
vagrantVm
String
command
String
asRoot
boolean
$class: 'VagrantUpCommand'
vagrantFile
String
vagrantVm
String
destroyOnError
boolean
provider
String
dontKillMe
boolean
$class: 'ValgrindBuilder'
valgrindExecutable
String
workingDirectory
String
includePattern
String
excludePattern
String
outputDirectory
String
outputFileEnding
String
programOptions
String
tool
$class: 'ValgrindToolHelgrind'
historyLevel
String
$class: 'ValgrindToolMemcheck'
showReachable
boolean
undefinedValueErrors
boolean
leakCheckLevel
String
trackOrigins
boolean
valgrindOptions
String
ignoreExitCode
boolean
traceChildren
boolean
childSilentAfterFork
boolean
generateSuppressions
boolean
suppressionFiles
String
removeOldReports
boolean
crxValidate
packageIdFilters
(optional)
**/*.zipThis pattern will only match packages located directly under the Packages folder whose filenames begin with 'acme-':
Packages/acme-*.zipMatching packages will be validated in the order in which the filters are specified. At least one package must match each filter or the step will fail.
String
allowNonCoveredRoots
(optional)
boolean
forbiddenACHandlingModeSet
(optional)
String
forbiddenExtensions
(optional)
.jar .zipThis field supports parameter tokens.
String
forbiddenFilterRootPrefixes
(optional)
/apps/system
/apps/system/config
/apps/systemOfADown/config
String
localDirectory
(optional)
String
pathsDeniedForInclusion
(optional)
/apps/system/rep:policy /etc/map/http/site_root_redirectUse this test to safeguard specific paths or possible paths within unrestricted roots from overly broad workspace filters.
String
validationFilter
(optional)
/etc # define /etc as the filter root -/etc/packages(/.)? # exclude package pathsThis field supports parameter tokens.
String
$class: 'Validator'
stack
String
branch
String
apiKey
String
contentReplace
configs
(optional)
filePath
String
fileEncoding
String
variablesPrefix
String
variablesSuffix
String
emptyValue
String
configs
name
String
value
String
$class: 'VectorCASTCommand'
winCommand
String
unixCommand
String
$class: 'VectorCASTSetup'
environmentSetupWin
String
environmentSetupUnix
String
executePreambleWin
String
executePreambleUnix
String
environmentTeardownWin
String
environmentTeardownUnix
String
optionUseReporting
boolean
optionErrorLevel
String
optionHtmlBuildDesc
String
optionExecutionReport
boolean
optionClean
boolean
waitLoops
long
waitTime
long
manageProjectName
String
jobName
String
nodeLabel
String
$class: 'ViberNotifier'
token
(optional)
String
sender
(optional)
String
message
(optional)
String
$class: 'ViewCloner'
url
String
replacePatternString
String
niewViewName
String
password
String
username
String
$class: 'VirtualenvBuilder'
pythonName
String
home
String
clear
boolean
systemSitePackages
boolean
nature
String
command
String
ignoreExitCode
boolean
visualexpert
installPath
String
projectName
String
doAnalysis
boolean
createReferenceDocument
boolean
createCodeReviewDocument
boolean
$class: 'VsCodeMetricsBuilder'
toolName
String
files
Assembly file(s) to analyze.
You can specify multiple analyze assemblies by separating them with new-line or space.
Command Line Argument: /file:[ assembly file path ]
String
outputXML
Metrics results XML output file.
Command Line Argument: /out:[ output file path ]
String
directory
Location to search for assembly dependencies.
You can specify multiple directories by separating them with new-line or space.
Command Line Argument: /directory:[ directory ]
String
searchGac
Search the Global Assembly Cache for missing references.
Command Line Argument: /searchgac
boolean
platform
Location of framework assemblies, such as mscorlib.dll.
Command Line Argument: /platform:[ directory ]
String
reference
Reference assemblies required for analysis.
You can specify multiple reference assemblies by separating them with new-line or space.
Command Line Argument: /reference:[ assembly file path ]
String
ignoreInvalidTargets
Silently ignore invalid target files.
Command Line Argument: /ignoreinvalidtargets
boolean
ignoreGeneratedCode
Suppress analysis results against generated code.
Command Line Argument: /ignoregeneratedcode
boolean
cmdLineArgs
String
failBuild
boolean
vsTest
cmdLineArgs
(optional)
String
enablecodecoverage
(optional)
Enables data diagnostic adapter CodeCoverage in the test run.
Default settings are used if not specified using settings file.
Command Line Argument: /Enablecodecoverage
boolean
failBuild
(optional)
boolean
framework
(optional)
Target .NET Framework version to be used for test execution.
Valid values are Framework35, Framework40 and Framework45.
Command Line Argument: /Framework: [ framework version ]
String
inIsolation
(optional)
Runs the tests in an isolated process.
This makes vstest.console.exe process less likely to be stopped on an error in the tests, but tests might run slower.
boolean
logger
(optional)
Specify a logger for test results. For example, to log results into a Visual Studio Test Results File (TRX) use /Logger:trx.
Command Line Argument: /Logger:[ uri/friendlyname ]
String
platform
(optional)
Target platform architecture to be used for test execution.
Valid values are x86, x64 and ARM.
String
settings
(optional)
Run tests with additional settings such as data collectors.
Example: Local.RunSettings
Command Line Argument: /Settings:[ file name ]
String
testCaseFilter
(optional)
Run tests that match the given expression.
<Expression> is of the format <property>=<value>[||<Expression>].
Example: TestCategory=Nightly||Name=Namespace.ClassName.MethodName
The TestCaseFilter command line option cannot be used with the Tests command line option.
Command Line Argument: /TestCaseFilter:[ expression ]
String
testFiles
(optional)
Specify the path to your VSTest compiled assemblies.
You can specify multiple test assemblies by separating them with new-line or space.
String
tests
(optional)
Run tests with names that match the provided values.
To provide multiple values, separate them by commas.
Example: TestMethod1,testMethod2
The /Tests command line option cannot be used with the /TestCaseFilter command line option.
Command Line Argument: /Tests:[ test name ]
String
useVs2017Plus
(optional)
This makes adjustments to the arguments for the sake of compatibility with Visual Studio 2017+.
Command Line Argument: /UseVs2017Plus:true
boolean
useVsixExtensions
(optional)
This makes vstest.console.exe process use or skip the VSIX extensions installed (if any) in the test run.
Command Line Argument: /UseVsixExtensions:true
boolean
vsTestName
(optional)
String
$class: 'WASBuildStep'
additionalClasspath
String
appendTrace
boolean
commands
String
javaOptions
String
jobId
String
language
String
profileScriptFiles
String
propertiesFiles
String
runIf
true
.String
scriptFile
String
scriptParameters
String
traceFile
String
wasServerName
String
user
String
password
String
greet
projectId
String
appPath
String
scriptPath
String
groupId
String
timeout
The timeout of this test run.The default value is 60 minutes.
String
frameType
String
caseTimeout
The timeout of each device running in your test.The default value is 10 minutes.
String
targetOsType
String
$class: 'WakeUpIOSDevice'
url
String
cloudTestServerID
String
additionalOptions
String
$class: 'WallarmFastBuilder'
appHost
String
appPort
String
fastPort
String
fastName
String
policyId
int
testRecordId
int
wallarmApiHost
String
testRunName
String
testRunDesc
String
record
boolean
stopOnFirstFail
boolean
failBuild
boolean
withoutSudo
boolean
localDockerNetwork
String
localDockerIp
String
wallarmVersion
String
fileExtensionsToExclude
String
inactivityTimeout
int
testRunRps
int
wallarmApiToken
(optional)
String
$class: 'WarriorPluginBuilder'
configType
String
gitConfigUrl
String
gitConfigCredentials
boolean
gitConfigTagValue
String
gitConfigCloneType
String
gitConfigUname
String
gitConfigPwd
String
gitConfigFile
String
sftpConfigIp
String
sftpConfigUname
String
sftpConfigPwd
String
sftpConfigFile
String
pythonPath
String
uploadExecLog
boolean
uploadServerIp
String
uploadServerUname
String
uploadServerPwd
String
uploadServerType
String
uploadServerDir
String
runFiles
runFile
String
wattspeed
token
class hudson.util.Secret
projects
int
$class: 'WebLoadAnalyticsBuilder'
inputLsFile
String
portfolioFile
String
format
JUNIT
, HTML
, DOC
, ODT
, XLS
, XLSX
, RTF
, PDF
, CSV
, RAW
location
String
reportName
String
compareToSessions
String
compareToPreviousBuilds
int
$class: 'WebLoadConsoleBuilder'
tplFile
String
lsFile
String
executionDuration
long
virtualClients
long
probindClient
long
$class: 'WildflyBuilder'
war
String
host
String
port
String
username
String
password
String
server
String
$class: 'WinBatchBuildStep'
buildStepId
String
defineArgs
boolean
buildStepArgs
arg
String
$class: 'WinDocksBuilder'
ipaddress
String
image
String
winRMClient
hostName
String
credentialsId
String
winRMOperations
invokeCommand
command
String
sendFile
source
String
destination
String
configurationName
String
$class: 'WixToolsetBuilder'
sources
String
markAsUnstable
boolean
compileOnly
boolean
useUiExt
boolean
useUtilExt
boolean
useBalExt
boolean
useComPlusExt
boolean
useDependencyExt
boolean
useDifxAppExt
boolean
useDirectXExt
boolean
useFirewallExt
boolean
useGamingExt
boolean
useIISExt
boolean
useMsmqExt
boolean
useNetfxExt
boolean
usePsExt
boolean
useSqlExt
boolean
useTagExt
boolean
useVsExt
boolean
msiOutput
Enter a name for the generated MSI/EXE package. If left blank, the MSI package is named setup.msi. You can also use the file ending *.exe. But keep in mind, that you have to create a Bootstrapper and activeate the BalExtension to create an Executable.
You can use environment variables like $GIT_BRANCH to define a package name.
String
arch
String
$class: 'WsapBuilder'
wsapLocation
String
envVar
String
credentialsId
String
targetUrl
String
ipAddress
String
port
int
apiKey
String
sastAnalysis
target
String
dastAnalysis
scanMethod
scan
String
apiUrl
String
apiDefinition
String
includeUrls
$class: 'DASTAnalysis'
$class: 'ExcludeEntry'
url
String
$class: 'HeaderEntry'
header
String
value
String
$class: 'IncludeEntry'
url
String
$class: 'LoginProperties'
useLogin
boolean
loginUrl
String
requestJson
String
usernameField
String
passwordField
String
loggedInRegex
String
loggedOutRegex
String
headers
$class: 'DASTAnalysis'
$class: 'ExcludeEntry'
url
String
$class: 'HeaderEntry'
header
String
value
String
$class: 'IncludeEntry'
url
String
$class: 'LoginProperties'
$class: 'SASTAnalysis'
target
String
$class: 'ScanMethod'
scan
String
apiUrl
String
apiDefinition
String
$class: 'UserEntry'
username
String
password
String
users
$class: 'DASTAnalysis'
$class: 'ExcludeEntry'
url
String
$class: 'HeaderEntry'
header
String
value
String
$class: 'IncludeEntry'
url
String
$class: 'LoginProperties'
$class: 'SASTAnalysis'
target
String
$class: 'ScanMethod'
scan
String
apiUrl
String
apiDefinition
String
$class: 'UserEntry'
username
String
password
String
$class: 'SASTAnalysis'
target
String
$class: 'ScanMethod'
scan
String
apiUrl
String
apiDefinition
String
$class: 'UserEntry'
username
String
password
String
excludeUrls
$class: 'DASTAnalysis'
$class: 'ExcludeEntry'
url
String
$class: 'HeaderEntry'
header
String
value
String
$class: 'IncludeEntry'
url
String
$class: 'LoginProperties'
useLogin
boolean
loginUrl
String
requestJson
String
usernameField
String
passwordField
String
loggedInRegex
String
loggedOutRegex
String
headers
$class: 'DASTAnalysis'
$class: 'ExcludeEntry'
url
String
$class: 'HeaderEntry'
header
String
value
String
$class: 'IncludeEntry'
url
String
$class: 'LoginProperties'
$class: 'SASTAnalysis'
target
String
$class: 'ScanMethod'
scan
String
apiUrl
String
apiDefinition
String
$class: 'UserEntry'
username
String
password
String
users
$class: 'DASTAnalysis'
$class: 'ExcludeEntry'
url
String
$class: 'HeaderEntry'
header
String
value
String
$class: 'IncludeEntry'
url
String
$class: 'LoginProperties'
$class: 'SASTAnalysis'
target
String
$class: 'ScanMethod'
scan
String
apiUrl
String
apiDefinition
String
$class: 'UserEntry'
username
String
password
String
$class: 'SASTAnalysis'
target
String
$class: 'ScanMethod'
scan
String
apiUrl
String
apiDefinition
String
$class: 'UserEntry'
username
String
password
String
loginProperties
useLogin
boolean
loginUrl
String
requestJson
String
usernameField
String
passwordField
String
loggedInRegex
String
loggedOutRegex
String
headers
$class: 'DASTAnalysis'
$class: 'ExcludeEntry'
url
String
$class: 'HeaderEntry'
header
String
value
String
$class: 'IncludeEntry'
url
String
$class: 'LoginProperties'
$class: 'SASTAnalysis'
target
String
$class: 'ScanMethod'
scan
String
apiUrl
String
apiDefinition
String
$class: 'UserEntry'
username
String
password
String
users
$class: 'DASTAnalysis'
$class: 'ExcludeEntry'
url
String
$class: 'HeaderEntry'
header
String
value
String
$class: 'IncludeEntry'
url
String
$class: 'LoginProperties'
$class: 'SASTAnalysis'
target
String
$class: 'ScanMethod'
scan
String
apiUrl
String
apiDefinition
String
$class: 'UserEntry'
username
String
password
String
xcodeBuild
allowFailingBuildResults
(optional)
Checking this option will prevent a build step from failing if xcodebuild exits with a non-zero return code.
This can be useful for build steps that run unit tests and also have a post-build task to publish unit test results: the test step will not fail the entire build for a failing unit test, but will instead mark the build unstable in the "publish test" phase.
boolean
appURL
(optional)
String
assetPackManifestURL
(optional)
String
assetPacksBaseURL
(optional)
String
assetPacksInBundle
(optional)
boolean
buildDir
(optional)
The value to use for the BUILD_DIR setting. You only need to supply this value if you want the product of the Xcode build to be in a location other than the one specified in project settings and this job 'SYMROOT' parameter.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/build
String
buildIpa
(optional)
Checking this option will create a .ipa for each .app found in the build directory.
An .ipa is basically a zipped up .app.
This is quite handy for distributing ad-hoc builds to testers as they can just double-click the .ipa and it will import into iTunes.
boolean
bundleID
(optional)
The new bundle ID. Usually something like com.companyname.projectname.
String
bundleIDInfoPlistPath
(optional)
The path to the info.plist file which contains the CFBundleIdentifier of your project.
Usually something like:
String
cfBundleShortVersionStringValue
(optional)
This will set the CFBundleShortVersionString to the specified string.
Supports all macros and also environment and build variables from the Token Macro Plugin.
String
cfBundleVersionValue
(optional)
This will set the CFBundleVersion to the specified string.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example the value ${BUILD_NUMBER} will be replaced with the current build number.
We advice you to generate a unique value for each build if you want for example deploy it into a private store.
In that case, for example, you can use : ${JOB_NAME}-${BUILD_NUMBER}
String
changeBundleID
(optional)
Checking this option will replace the bundle identifier.
You will need to specify which bundle ID (CFBundleIdentifier) to use and where is the Info.plist file located.
This is handy for example when you want to use a different code signing identity in your development projects.
boolean
cleanBeforeBuild
(optional)
This will delete the build directories before invoking the build. This will force the rebuilding of ALL dependencies and can make large projects take a lot longer.
boolean
cleanResultBundlePath
(optional)
This will delete the ResultBundlePath before invoking the build.
If the directory already exists in the location specified by ResultBundlePath, xcodebuild will be an error and should be checked.
boolean
cleanTestReports
(optional)
boolean
compileBitcode
(optional)
boolean
configuration
(optional)
This is the name of the configuration as defined in the Xcode project.
By default there are Debug and Release configurations.
String
copyProvisioningProfile
(optional)
boolean
developmentTeamID
(optional)
String
developmentTeamName
(optional)
String
displayImageURL
(optional)
String
fullSizeImageURL
(optional)
String
generateArchive
(optional)
Checking this option will create an .xcarchive .app found in the build directory.
An .xcarchive is useful for submission to the app store or third party crash reporters.
You must specify a Scheme to perform an archive.
boolean
ignoreTestResults
(optional)
boolean
interpretTargetAsRegEx
(optional)
Build all entries listed under the "Targets:" section of the xcodebuild -list output that match the regexp.
boolean
ipaExportMethod
(optional)
String
ipaName
(optional)
String
ipaOutputDirectory
(optional)
String
keychainId
(optional)
String
keychainName
(optional)
The name of this configured keychain. Each job will specify a keychain configuration by the name.
String
keychainPath
(optional)
The path of the keychain to use to retrieve certificates to sign the package (default : ${HOME}/Library/Keychains/login.keychain).
String
keychainPwd
(optional)
The password of the keychain to use to retrieve certificates to sign the package.
class hudson.util.Secret
logfileOutputDirectory
(optional)
Specify the directory to output the log of xcodebuild.
If you leave it blank, it will be output to "project directory/builds/${BUILD_NUMBER}/log" with other logs.
If an output path is specified, it is output as a xcodebuild.log file in a relative directory under the "build output directory"
String
manualSigning
(optional)
boolean
noConsoleLog
(optional)
boolean
provideApplicationVersion
(optional)
boolean
provisioningProfiles
(optional)
provisioningProfileAppId
String
provisioningProfileUUID
String
resultBundlePath
(optional)
Specify the directory to output the output the test result.
If you leave it blank, it will not output a test result and will not analyze the test results.
If an output path is specified, it is output as a test result in a relative directory under the "ResultBundlePath".
The plug-in analyzes the test result here and outputs a JUnit compatible XML file under the ${WORKSPACE}/test-reports.
String
sdk
(optional)
You only need to supply this value if you want to specify the SDK to build against. If empty, the SDK will be determined by Xcode. If you wish to run OCUnit tests, you will need to use the iPhone Simulator's SDK, for example:
/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator4.1.sdk/
String
signingMethod
(optional)
String
stripSwiftSymbols
(optional)
boolean
symRoot
(optional)
You only need to supply this value if you want to specify the SYMROOT path to use.
If empty, the default SYMROOT path will be used (it could be different depending of your Xcode version).
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/symroot
String
target
(optional)
The target to build. If left empty, this will build all targets in the project.
If you wish to build your binary and the unit test module, it is best to do this as two separate steps each with their own target.
This was, the iPhone Simulator SDK can be specified for the unit tests.
String
thinning
(optional)
String
unlockKeychain
(optional)
boolean
uploadBitcode
(optional)
boolean
uploadSymbols
(optional)
boolean
useLegacyBuildSystem
(optional)
Instead of "New Builld System" which became available from Xcode 9, we build the application using the legacy build system.
There is a possibility that you can handle old projects that cause problems with the new build system.
Also, since new output formats of logs are changed in the new build system, it is also useful when you want to handle logs with legacy third party tools.
boolean
xcodeName
(optional)
String
xcodeProjectFile
(optional)
String
xcodeProjectPath
(optional)
String
xcodeSchema
(optional)
String
xcodeWorkspaceFile
(optional)
String
xcodebuildArguments
(optional)
Extra xcodebuild parameters, added after the command that jenkins generates based on the rest of the config
String
$class: 'XFramiumBuilder'
configFile
String
suiteName
String
testNames
String
tagNames
String
stepTags
String
deviceTags
String
defaultCloud
String
overrideDefaults
boolean
$class: 'XLRVarSetterBuilder'
XLR_releaseId
String
XLR_varName
String
JKS_varName
String
debug
boolean
osfBuilderSuiteXMLLint
xsdsPath
(optional)
String
xmlsPath
(optional)
String
reportPath
(optional)
String
$class: 'XShellBuilder'
commandLine
String
executeFromWorkingDir
boolean
regexToKill
String
timeAllocated
String
$class: 'XrayExportBuilder'
serverInstance
String
issues
String
filter
String
filePath
String
credentialId
String
fields
(optional)
java.util.Map<java.lang.String, java.lang.String>
xrayInstance
(optional)
configID
String
alias
String
hosting
SERVER
, CLOUD
serverAddress
String
credentialId
String
$class: 'XrayImportFeatureBuilder'
serverInstance
String
folderPath
String
projectKey
String
testInfo
String
preconditions
String
credentialId
String
lastModified
(optional)
String
yarn
command
String
workspaceSubdirectory
(optional)
String
$class: 'ZAPBuilder'
startZAPFirst
boolean
zapHost
String
zapPort
String
zaproxy
autoInstall
boolean
toolUsed
String
zapHome
String
jdk
String
timeout
int
zapSettingsDir
String
autoLoadSession
boolean
loadSession
String
sessionFilename
String
removeExternalSites
boolean
internalSites
String
contextName
String
includedURL
String
excludedURL
String
alertFilters
String
authMode
boolean
username
String
password
String
loggedInIndicator
String
loggedOutIndicator
String
authMethod
String
loginURL
String
usernameParameter
String
passwordParameter
String
extraPostData
String
authScript
String
authScriptParams
scriptParameterName
String
scriptParameterValue
String
targetURL
String
spiderScanURL
boolean
spiderScanRecurse
boolean
spiderScanSubtreeOnly
boolean
spiderScanMaxChildrenToCrawl
int
ajaxSpiderURL
boolean
ajaxSpiderInScopeOnly
boolean
activeScanURL
boolean
activeScanRecurse
boolean
activeScanPolicy
String
generateReports
boolean
selectedReportMethod
String
deleteReports
boolean
reportFilename
String
selectedReportFormats
String
selectedExportFormats
String
exportreportTitle
String
exportreportBy
String
exportreportFor
String
exportreportScanDate
String
exportreportReportDate
String
exportreportScanVersion
String
exportreportReportVersion
String
exportreportReportDescription
String
exportreportAlertHigh
boolean
exportreportAlertMedium
boolean
exportreportAlertLow
boolean
exportreportAlertInformational
boolean
exportreportCWEID
boolean
exportreportWASCID
boolean
exportreportDescription
boolean
exportreportOtherInfo
boolean
exportreportSolution
boolean
exportreportReference
boolean
exportreportRequestHeader
boolean
exportreportResponseHeader
boolean
exportreportRequestBody
boolean
exportreportResponseBody
boolean
jiraCreate
boolean
jiraProjectKey
String
jiraAssignee
String
jiraAlertHigh
boolean
jiraAlertMedium
boolean
jiraAlertLow
boolean
jiraFilterIssuesByResourceType
boolean
cmdLinesZAP
cmdLineOption
String
cmdLineValue
String
zAdviserDownload
connectionId
String
credentialsId
String
jcl
String
encryptedDataFile
String
unencryptedDataFile
String
encryptData
(optional)
boolean
uploadData
(optional)
boolean
zAdviserUpload
connectionId
String
uploadDataFile
String
$class: 'ZOSJobSubmitter'
server
String
port
int
credentialsId
String
wait
boolean
waitTime
int
deleteJobFromSpool
boolean
jobLogToConsole
boolean
jobFile
String
MaxCC
String
JESINTERFACELEVEL1
boolean
FTPActiveMode
boolean
$class: 'ZanataCliBuilder'
projFile
String
syncG2zanata
boolean
syncZ2git
boolean
zanataCredentialsId
String
extraPathEntries
(optional)
String
$class: 'ZanataSyncStep'
zanataCredentialsId
String
pullFromZanata
(optional)
boolean
pushToZanata
(optional)
boolean
syncOption
(optional)
String
zanataLocaleIds
(optional)
String
zanataProjectConfigs
(optional)
String
zanataURL
(optional)
String
$class: 'ZapRunner'
host
String
zapInstallDescription
value
String
path
String
repositoryURL
String
sourcePath
String
zulipSend
message
(optional)
String
stream
(optional)
String
topic
(optional)
String
cfyCloudFormation
awsCredentialsId
(optional)
The ID of the credentials to use when accessing AWS. Parameters' expansion is supported when using freestyle jobs.
String
credentialsId
(optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
String
debugOutput
(optional)
boolean
deploymentId
(optional)
ID to assign to the created Cloudify deployment. If not provided, one will be randomly generated. You can obtain the deployment ID from the "environment data" output file.
String
echoEnvData
(optional)
If checked, then the created environment's data will be printed to the job's log.
boolean
echoInputs
(optional)
boolean
envDataLocation
(optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
String
parameters
(optional)
java.util.Map<java.lang.String, java.lang.Object>
parametersAsString
(optional)
String
parametersFile
(optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
String
regionName
(optional)
AWS region to use. If not specified, the value of the aws_region_name
secret is used.
String
stackName
(optional)
Name of the new stack.
String
templateBody
(optional)
String
templateBucketName
(optional)
String
templateFile
(optional)
String
templateResourceName
(optional)
String
templateUrl
(optional)
URL of the Terraform template. May be a ZIP, tar.gz
, or a Git repository.
String
tenant
(optional)
String
$class: 'com.alauda.jenkins.plugins.freestyle.CreateStep'
jsonyaml
String
advancedArguments
(optional)
value
String
clusterName
(optional)
String
credentialsId
(optional)
String
logLevel
(optional)
String
project
(optional)
String
$class: 'com.alauda.jenkins.plugins.freestyle.DeleteStep'
advancedArguments
(optional)
value
String
clusterName
(optional)
String
credentialsId
(optional)
String
ignoreNotFound
(optional)
boolean
logLevel
(optional)
String
project
(optional)
String
selector
(optional)
kind
(optional)
String
labels
(optional)
name
String
value
String
names
(optional)
name
String
$class: 'com.alauda.jenkins.plugins.freestyle.RawStep'
command
String
arguments
String
advancedArguments
(optional)
value
String
clusterName
(optional)
String
credentialsId
(optional)
String
logLevel
(optional)
String
project
(optional)
String
$class: 'com.alauda.jenkins.plugins.freestyle.WatchStep'
advancedArguments
(optional)
value
String
clusterName
(optional)
String
credentialsId
(optional)
String
failPattern
(optional)
String
logLevel
(optional)
String
project
(optional)
String
selector
(optional)
kind
(optional)
String
labels
(optional)
name
String
value
String
names
(optional)
name
String
successPattern
(optional)
String
template
(optional)
String
$class: 'com.cloudbees.dockerpublish.DockerBuilder'
repoName
String
buildAdditionalArgs
(optional)
String
buildContext
(optional)
String
createFingerprint
(optional)
boolean
dockerToolName
(optional)
String
dockerfilePath
(optional)
String
forcePull
(optional)
boolean
forceTag
(optional)
boolean
noCache
(optional)
boolean
registry
(optional)
url
https://index.docker.io/v1/
).
String
credentialsId
String
repoTag
(optional)
String
server
(optional)
uri
unix:///var/run/docker.sock
or tcp://127.0.0.1:2376
).
String
credentialsId
String
skipBuild
(optional)
boolean
skipDecorate
(optional)
boolean
skipPush
(optional)
boolean
skipTagLatest
(optional)
boolean
$class: 'com.cloudbees.plugins.deployer.DeployBuilder'
hosts
? extends com.cloudbees.plugins.deployer.hosts.DeployHost<?, ?>
$class: 'com.etas.jenkins.plugins.CreateTextFile.CreateFileBuilder'
textFilePath
String
textFileContent
String
fileOption
String
useWorkspace
boolean
$class: 'com.groupon.jenkinsci.plugins.DotCiFigtemplate.HelloWorldBuilder'
name
String
azureVMSSUpdate
azureCredentialsId
String
resourceGroup
String
name
String
imageReference
id
(optional)
Resource ID or VHD URI of the custom image.
Example Resource ID: /subscriptions/your-subscription-id/resourceGroups/your-resource-group/providers/Microsoft.Compute/images/your-image-name
Example VHD URI: http://your-storage-account.blob.core.windows.net/vhds/your-disk-image.vhd
String
offer
(optional)
String
publisher
(optional)
String
sku
(optional)
String
version
(optional)
String
$class: 'com.openshift.jenkins.plugins.freestyle.CreateStep'
jsonyaml
String
advancedArguments
(optional)
value
String
clusterName
(optional)
String
credentialsId
(optional)
String
logLevel
(optional)
String
project
(optional)
String
$class: 'com.openshift.jenkins.plugins.freestyle.DeleteStep'
advancedArguments
(optional)
value
String
clusterName
(optional)
String
credentialsId
(optional)
String
ignoreNotFound
(optional)
boolean
logLevel
(optional)
String
project
(optional)
String
selector
(optional)
kind
(optional)
String
labels
(optional)
name
String
value
String
names
(optional)
name
String
$class: 'com.openshift.jenkins.plugins.freestyle.RawStep'
command
String
arguments
String
advancedArguments
(optional)
value
String
clusterName
(optional)
String
credentialsId
(optional)
String
logLevel
(optional)
String
project
(optional)
String
$class: 'com.openshift.jenkins.plugins.freestyle.WatchStep'
advancedArguments
(optional)
value
String
clusterName
(optional)
String
credentialsId
(optional)
String
failPattern
(optional)
String
logLevel
(optional)
String
project
(optional)
String
selector
(optional)
kind
(optional)
String
labels
(optional)
name
String
value
String
names
(optional)
name
String
successPattern
(optional)
String
template
(optional)
String
$class: 'com.syncapse.jenkinsci.plugins.awscloudformationwrapper.CloudFormationBuildStep'
stacks
stackName
Name of the stack. The name associated with the stack. The name must be unique within your AWS account. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters. You can pass Environment Variables into this field.
String
description
String
cloudFormationRecipe
String
parameters
The parameters to pass into the recipe. A comma separated list of key/value pairs. ie: key1=value1,key2=value2
You can pass environment variables as values to a stack parameters.
String
timeout
long
awsAccessKey
String
awsSecretKey
String
awsRegion
US_East_Northern_Virginia
, US_WEST_Oregon
, US_WEST_Northern_California
, EU_Ireland
, EU_Frankfurt
, Asia_Pacific_Singapore
, Asia_Pacific_Sydney
, Asia_Pacific_Tokyo
, South_America_Sao_Paulo
sleep
long
$class: 'com.synopsys.integration.jenkins.coverity.extensions.buildstep.CoverityBuildStep'
coverityInstanceUrl
Specify which Synopsys Coverity connect instance to run this job against.
The resulting Synopsys Coverity connect instance URL is stored in the $COV_URL environment variable, and will affect both the full and incremental analysis.
String
onCommandFailure
Specify the action to take if a Coverity static analysis command fails.
String
projectName
Specify the name of the Coverity project.
The resulting project name is stored in the $COV_PROJECT environment variable, and will affect both the full and incremental analysis.
String
streamName
Specify the name of the Coverity stream that you would like to use for the commands.
The resulting stream name is stored in the $COV_STREAM environment variable, and will affect both the full and incremental analysis.
String
checkForIssuesInView
viewName
Specify the name of the Coverity view that you would like to check for issues.
The resulting view name is stored in the $COV_VIEW environment variable, and affects checking for issues in both the full and incremental analysis, if configured.
String
buildStatusForIssues
Specify the build status to set if issues are found in the configured view.
String
configureChangeSetPatterns
changeSetExclusionPatterns
Specify a comma separated list of filename patterns that you would like to explicitly excluded from the Jenkins change set.
The pattern is applied to the $CHANGE_SET environment variable, and will affect which files are analyzed in an incremental analysis (cov-run-desktop).
Examples:
File Name | Pattern | Will be excluded |
---|---|---|
test.java | *.java | Yes |
test.java | *.jpg | No |
test.java | test.* | Yes |
test.java | test.???? | Yes |
test.java | test.????? | No |
String
changeSetInclusionPatterns
Specify a comma separated list of filename patterns that you would like to explicitly included from the Jenkins change set.
The pattern is applied to the $CHANGE_SET environment variable, and will affect which files are analyzed in an incremental analysis (cov-run-desktop).
Examples:
File Name | Pattern | Will be included |
---|---|---|
test.java | *.java | Yes |
test.java | *.jpg | No |
test.java | test.* | Yes |
test.java | test.???? | Yes |
test.java | test.????? | No |
String
coverityRunConfiguration
$class: 'AdvancedCoverityRunConfiguration'
commands
command
Provide the Coverity command you want to run.
The command should start with the name of the Coverity command you want to run. Ex: cov-build, cov-analyze, etc.
For examples and a list of the available environment variables that can be used, refer to the Command Examples documentation
String
$class: 'SimpleCoverityRunConfiguration'
coverityAnalysisType
Specify the way you wish to perform your Coverity analysis.
Each analysis type runs a specific Coverity command with some default arguments, followed by cov-commit-defects with some default arguments. Additional command-specific arguments can be provided below.
Full Analysis:
cov-analyze --dir ${WORKSPACE}/idir
cov-commit-defects --dir ${WORKSPACE}/idir --url ${COV_URL} --stream ${COV_STREAM}
Incremental Analysis:
cov-run-desktop --dir ${WORKSPACE}/idir --url ${COV_URL} --stream ${COV_STREAM} ${CHANGE_SET}
cov-commit-defects --dir ${WORKSPACE}/idir --url ${COV_URL} --stream ${COV_STREAM}
Determined by change set threshold
Will run the commands specified by Full Analysis if the number of files listed in the CHANGE_SET environment variable meets or exceeds the specified threshold, otherwise will run the commands specified by Incremental Analysis.
COV_ANALYZE
, COV_RUN_DESKTOP
, THRESHOLD
sourceArgument
The argument that specifies the source for the given capture type.
For Build, this is the build command to pass to cov-build.
For Buildless Capture (Project) this is the project directory to pass to cov-capture.
For Buildless Capture (SCM) this is the scm url to pass to cov-capture.
String
commandArguments
covBuildArguments
Specify additional arguments to apply to the invocation of the cov-build command. Affects the Build capture type.
Note:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
String
covAnalyzeArguments
Specify additional arguments to apply to the invocation of the cov-analyze command. Affects the Full Analysis analysis type.
Note:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
String
covRunDesktopArguments
Specify additional arguments to apply to the invocation of the cov-run-desktop command. Affects the Incremental Analysis analysis type.
Note:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
String
covCommitDefectsArguments
Specify additional arguments to apply to the invocation of the cov-commit-defects command. Affects all analysis types.
Note:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
String
covCaptureArguments
Specify additional arguments to apply to the invocation of the cov-capture command. Affects the Buildless Capture (Project) and Buildless Capture (SCM) capture types.
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
With the Buildless Capture (Project) capture type, the following arguments are automatically provided:
With the Buildless Capture (SCM) capture type, the following arguments are automatically provided:
String
changeSetAnalysisThreshold
(optional)
For use with the Coverity Analysis Type Determined by change set threshold. Specifies the number of files that triggers a Full Analysis.
Determined by change set threshold will run an Incremental Analysis unless the number of files specified in the $CHANGE_SET environment variable meets or exceeds the value of this field.
If the number of files specified in the $CHANGE_SET environment variable meets or exceeds the value of this field, Determined by change set threshold will run a Full Analysis
int
coverityCaptureType
(optional)
Specify the way you wish to capture your source for Coverity analysis.
Each capture type runs a specific Coverity command with some default arguments. Additional command-specific arguments can be provided below.
Build
cov-build --dir ${WORKSPACE}/idir Source Argument (build command)
Buildless Capture (Project)
cov-capture --project-dir Source Argument (project directory)
Buildless Capture (SCM)
cov-capture --scm-url Source Argument (scm url)
COV_BUILD
, COV_CAPTURE_PROJECT
, COV_CAPTURE_SCM
customWorkingDirectory
(optional)
The fully qualified path to a directory in which to run the cov-build or cov-capture command.
String
cleanUpAction
(optional)
Specify the clean up action to perform on a successful execution.
Will either persist or delete the intermediate directory created by the specified capture type.
PERSIST_INTERMEDIATE_DIRECTORY
, DELETE_INTERMEDIATE_DIRECTORY
credentialsId
(optional)
Specify the credentials to use with the Synopsys Coverity connect instance.
String
overrideDefaultCredentials
(optional)
boolean
$class: 'eggPlantBuilder'
script
Relative to the Execution Directory, specify the script or scripts, separated by commas to execute in the test relative to the workspace directory for this job, for example:
NOTE: To have scripts run against different SUTs, it is necessary to create a build step for each SUT.
String
SUT
String
port
Set the VNC Server port for the SUT, eg. 5900. Leaving this blank will use the default port for VNC, 5900.
String
password
Specifies the password for the VNC server. If there's no password, this field can be left blank.
String
colorDepth
String
globalResultsFolder
OPTIONAL. Specify the path to the global results folder, relative to the workspace.
String
defaultDocumentDirectory
Specify the path to the Default Document Directory, relative to the Execution Directory. See Running Eggplant From the Command Line in the Eggplant documentation
String
params
Parameters to be passed to the script(s). Equivalent to the -params flag when executing from the command line.
String
reportFailures
boolean
commandLineOutput
Pipe eggPlant results out as part of the console output.
boolean
installationName
String
$class: 'iOSAppInstaller'
url
String
cloudTestServerID
String
ipa
String
additionalOptions
String
$class: 'iOSSimulatorLauncher'
url
String
cloudTestServerID
String
app
String
sdk
String
family
String
dotnetRestore
dotnet restore
command uses NuGet to restore dependencies as well as project-specific tools that are specified in the project file. In most cases, you don't need to explicitly use the dotnet restore
command, since a NuGet restore is run implicitly if necessary when you run the following commands:
dotnet restore
explicitly to control when the restore occurs so that they can control network usage. To prevent the implicit NuGet restore, you can use the --no-restore
flag with any of these commands to disable implicit restore.
configfile
(optional)
String
disableParallel
(optional)
boolean
force
(optional)
boolean
forceEvaluate
(optional)
boolean
ignoreFailedSources
(optional)
boolean
lockFilePath
(optional)
String
lockedMode
(optional)
boolean
noCache
(optional)
boolean
noDependencies
(optional)
boolean
packages
(optional)
String
project
(optional)
String
runtime
(optional)
String
runtimes
(optional)
String
runtimesString
(optional)
<RuntimeIdentifiers>
tag in the .csproj file. For a list of Runtime Identifiers (RIDs), see the RID catalog.
String
sdk
(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.
String
showSdkInfo
(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.
boolean
source
(optional)
String
sources
(optional)
String
sourcesString
(optional)
String
specificSdkVersion
(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.
boolean
useLockFile
(optional)
boolean
verbosity
(optional)
String
workDirectory
(optional)
String
dotnetToolRestore
dotnet tool restore
command finds the tool manifest file that is in scope for the current directory and installs the tools that are listed in it. For information about manifest files, see Install a local tool and Invoke a local tool.
additionalSource
(optional)
String
additionalSources
(optional)
String
additionalSourcesString
(optional)
String
configfile
(optional)
String
disableParallel
(optional)
boolean
ignoreFailedSources
(optional)
boolean
noCache
(optional)
boolean
sdk
(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.
String
showSdkInfo
(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.
boolean
specificSdkVersion
(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.
boolean
toolManifest
(optional)
String
verbosity
(optional)
q[uiet]
, m[inimal]
, n[ormal]
, d[etailed]
, and diag[nostic]
.
String
workDirectory
(optional)
String
$class: 'jenkins.plugins.coverity.CoverityBuildStep'
The build step can be configured as any other build steps. Choose the appropriate builder and configure the command to be performed. The configured build step will be wrapped with the Coverity cov-build executables so that it captures the build and can be used to further analysis by using coverity static tools. This build step is only for capturing build of compiled sources.
buildStep
hudson.tasks.BuildStep
)$class: 'org.jenkinsci.plugins.dockerbuildstep.DockerBuilder'
dockerCmd
$class: 'CommitCommand'
containerId
String
repo
String
tag
String
runCmd
String
$class: 'CreateContainerCommand'
image
String
command
String
hostName
String
containerName
String
envVars
String
links
String
exposedPorts
String
cpuShares
String
memoryLimit
String
dns
String
extraHosts
String
networkMode
String
publishAllPorts
This setting corresponds to the --publish-all
(-P
) option of the docker run
CLI command.
boolean
portBindings
--publish
(-p
) option of the docker run
CLI command.
Enter one or more port binding, each on its own line. The syntax is host container
where host
is either hostPort
or hostIp:hostPort
and container
is either containerPort
or containerPort/protocol
.
Alternatively, you can separate host and port with a colon (":"), thus using the same syntax as in the Docker CLI.
Examples
String
bindMounts
--volume
(-v
) option of the docker run
CLI command.
Enter one or more bind mount, each on its own line. The syntax is hostPath containerPath[ rw|ro]
String
privileged
This setting corresponds to the --privileged
option of the docker run
CLI command.
boolean
alwaysRestart
boolean
$class: 'CreateImageCommand'
dockerFolder
String
imageTag
String
dockerFile
String
pull
boolean
noCache
boolean
rm
boolean
buildArgs
String
$class: 'ExecCreateAndStartCommand'
containerIds
String
command
String
$class: 'ExecCreateCommand'
containerIds
String
command
String
$class: 'ExecStartCommand'
commandIds
String
$class: 'KillCommand'
containerIds
String
$class: 'PullImageCommand'
fromImage
String
tag
String
registry
String
dockerRegistryEndpoint
url
https://index.docker.io/v1/
).
String
credentialsId
String
$class: 'PushImageCommand'
image
String
tag
String
registry
String
dockerRegistryEndpoint
url
https://index.docker.io/v1/
).
String
credentialsId
String
$class: 'RemoveAllCommand'
removeVolumes
boolean
force
boolean
$class: 'RemoveCommand'
containerIds
String
ignoreIfNotFound
boolean
removeVolumes
boolean
force
boolean
$class: 'RemoveImageCommand'
imageName
String
imageId
String
ignoreIfNotFound
boolean
$class: 'RestartCommand'
containerIds
String
timeout
int
$class: 'SaveImageCommand'
imageName
String
imageTag
String
destination
String
filename
String
ignoreIfNotFound
boolean
$class: 'StartByImageIdCommand'
imageId
String
$class: 'StartCommand'
containerIds
String
waitPorts
String
containerIdsLogging
String
$class: 'StopAllCommand'
$class: 'StopByImageIdCommand'
imageId
String
$class: 'StopCommand'
containerIds
String
$class: 'TagImageCommand'
image
String
repository
String
tag
String
ignoreIfNotFound
boolean
withForce
boolean
$class: 'org.jenkinsci.plugins.ios.connector.DeployBuilder'
path
String
udid
(We are looking for more ways to let you specify the target device flexibly. Please send in your suggestions.)
String
$class: 'org.jenkinsci.plugins.liquibase.builder.UpdateBuilder'
changeLogFile
(optional)
String
changeLogParameters
(optional)
String
contexts
(optional)
String
credentialsId
(optional)
String
installationName
(optional)
String
labels
(optional)
String
liquibasePropertiesPath
(optional)
String
password
(optional)
String
resourceDirectories
(optional)
String
url
(optional)
String
username
(optional)
String
osfBuilderSuiteForSFCCDeploy
hostname
(optional)
String
tfCredentialsId
(optional)
String
ocCredentialsId
(optional)
String
ocVersion
(optional)
String
buildVersion
(optional)
String
createBuildInfoCartridge
(optional)
boolean
activateBuild
(optional)
boolean
sourcePaths
(optional)
sourcePath
String
excludePatterns
excludePattern
String
tempDirectory
(optional)
String
greet
name
String
useFrench
(optional)
boolean
$class: 'org.quality.gates.jenkins.plugin.QGBuilder'
jobConfigData
class org.quality.gates.jenkins.plugin.JobConfigData
globalConfigDataForSonarInstance
class org.quality.gates.jenkins.plugin.GlobalConfigDataForSonarInstance
$class: 'quality.gates.jenkins.plugin.QGBuilder'
jobConfigData
class quality.gates.jenkins.plugin.JobConfigData
$class: 'vRABlueprintBuildStep'
params
serverUrl
String
userName
String
password
String
tenant
String
packageBlueprint
boolean
blueprintPath
String
overWrite
boolean
publishBlueprint
boolean
serviceCategory
String
$class: 'vRADeploymentBuildStep'
params
serverUrl
String
userName
String
password
String
tenant
String
blueprintName
String
waitExec
boolean
requestTemplate
boolean
requestParams
json
String
buildContent
String
Please submit your feedback about this page through this quick form.
Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?
See existing feedback here.