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.
catchError
: Catch error and set build result to failuredeleteDir
: Recursively delete the current directory from the workspacedir
: Change current directoryecho
: Print Messageerror
: Error signalfileExists
: Verify if file exists in workspaceisUnix
: Checks if running on a Unix-like nodemail
: Mailpwd
: Determine current directoryreadFile
: Read file from workspaceretry
: Retry the body up to N timessleep
: Sleepstash
: Stash some files to be used later in the buildstep
: General Build Steptimeout
: Enforce time limittool
: Use a tool from a predefined Tool Installationunstable
: Set stage result to unstableunstash
: Restore files previously stashedwaitUntil
: Wait for conditionwarnError
: Catch error and set build and stage result to unstablewithEnv
: Set environment variableswrap
: General Build WrapperwriteFile
: Write file to workspacearchive
: Archive artifactsgetContext
: Get contextual object from internal APIsunarchive
: Copy archived artifacts into the workspacewithContext
: Use contextual object from internal APIs within a blockcatchError
: Catch error and set build result to failurecatchError
step. The behavior of the step when an exception is thrown can be configured to print a message, set a build result other than failure, change the stage result, or ignore certain kinds of exceptions that are used to interrupt the build.
This step is most useful when used in Declarative Pipeline or with the options to set the stage result or ignore build interruptions. Otherwise, consider using plain try
-catch
(-finally
) blocks. It is also useful when using certain post-build actions (notifiers) originally defined for freestyle projects which pay attention to the result of the ongoing build.
node { catchError { sh 'might fail' } step([$class: 'Mailer', recipients: 'admin@somewhere']) }
If the shell step fails, the Pipeline build’s status will be set to failed, so that the subsequent mail step will see that this build is failed. In the case of the mail sender, this means that it will send mail. (It may also send mail if this build succeeded but previous ones failed, and so on.) Even in that case, this step can be replaced by the following idiom:
node { try { sh 'might fail' } catch (err) { echo "Caught: ${err}" currentBuild.result = 'FAILURE' } step([$class: 'Mailer', recipients: 'admin@somewhere']) }
For other cases, plain try
-catch
(-finally
) blocks may be used:
node { sh './set-up.sh' try { sh 'might fail' echo 'Succeeded!' } catch (err) { echo "Failed: ${err}" } finally { sh './tear-down.sh' } echo 'Printed whether above succeeded or failed.' } // …and the pipeline as a whole succeeds
See this document for background.
buildResult
(optional)
SUCCESS
if the current result is
UNSTABLE
or worse. Use
SUCCESS
or
null
to keep the build result from being set when an error is caught.
String
catchInterruptions
(optional)
timeout
step.
boolean
message
(optional)
String
stageResult
(optional)
SUCCESS
or
null
to keep the stage result from being set when an error is caught.
String
deleteDir
: Recursively delete the current directory from the workspacedeleteDir
step in a
dir
step.
dir
: Change current directorydir
block will use this directory as current and any relative path will use it as base path.
path
String
error
: Error signalthrow new Exception()
, but this step will avoid printing a stack trace.
message
String
fileExists
: Verify if file exists in workspacetrue | false
.
file
/
-separated) path to file within a workspace to verify its existence.
String
isUnix
: Checks if running on a Unix-like nodenode
is running on a Unix-like system (such as Linux or Mac OS X), false if Windows.
mail
: Mailsubject
String
body
String
bcc
(optional)
String
cc
(optional)
String
charset
(optional)
UTF-8
String
from
(optional)
String
mimeType
(optional)
text/plain
.
String
replyTo
(optional)
String
to
(optional)
String
pwd
: Determine current directorytmp
(optional)
boolean
readFile
: Read file from workspacefile
/
-separated) path to file within a workspace to read.
String
encoding
(optional)
String
retry
: Retry the body up to N timescount
int
sleep
: Sleepsh 'sleep …'
. May be used to pause one branch of
parallel
while another proceeds.
time
int
unit
(optional)
NANOSECONDS
, MICROSECONDS
, MILLISECONDS
, SECONDS
, MINUTES
, HOURS
, DAYS
stash
: Stash some files to be used later in the buildstash
and
unstash
steps are designed for use with small files. For large data transfers, use the External Workspace Manager plugin, or use an external repository manager such as Nexus or Artifactory. This is because stashed files are archived in a compressed TAR, and with large files this demands considerable on-master resources, particularly CPU time. There's not a hard stash size limit, but between 5-100 MB you should probably consider alternatives.
name
String
allowEmpty
(optional)
boolean
excludes
(optional)
String
includes
(optional)
**
: all files.
dir
.
String
useDefaultExcludes
(optional)
boolean
step
: General Build StepThis is a special step that allows to call builders or post-build actions (as in freestyle or similar projects), in general "build steps". Just select the build step to call from the dropdown list and configure it as needed.
Note that only Pipeline-compatible steps will be shown in the list.
delegate
$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: 'ACIPluginPublisher'
name
String
shownOnProjectPage
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
publishATX
Publishes the ATX reports of all configured ECU-TEST packages or projects in this job.
These ATX reports are generated automatically in this post-build step and uploaded to TEST-GUIDE.
publishATX(String atxName, boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll) : void
publishATX(ATXInstallation installation, boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll) : void
ATXServer.publish(boolean allowMissing, boolean runOnFailed, boolean archiving, boolean keepAll) : void
ATXServer.publish(Map<String, Object> settings) : void
publishATX('TEST-GUIDE', false, false, true, true)
def server = ATX.server('TEST-GUIDE') publishATX atxInstallation: server.installation
def server = ATX.newServer('TEST-GUIDE', 'ECU-TEST') server.publish()
def server = ATX.newServer atxName: 'TEST-GUIDE', toolName: 'ECU-TEST' server.publish allowMissing: true, runOnFailed: true, archiving: true, keepAll: true
atxName
String
allowMissing
(optional)
boolean
archiving
(optional)
boolean
atxInstallation
(optional)
name
String
toolName
String
config
settings
atxBooleanSetting
name
String
group
UPLOAD
, ARCHIVE
, ATTRIBUTE
, TBC_CONSTANTS
, TCF_CONSTANTS
, SPECIAL
value
boolean
atxTextSetting
name
String
group
UPLOAD
, ARCHIVE
, ATTRIBUTE
, TBC_CONSTANTS
, TCF_CONSTANTS
, SPECIAL
value
String
customSettings
atxCustomBooleanSetting
name
String
checked
boolean
atxCustomTextSetting
name
String
value
String
failOnOffline
(optional)
boolean
keepAll
(optional)
boolean
runOnFailed
(optional)
boolean
$class: 'AWSCodeDeployPublisher'
s3bucket
String
s3prefix
String
applicationName
String
deploymentGroupName
String
deploymentConfig
String
region
String
deploymentGroupAppspec
If checked, the build will use a dedicated appspec.yml file per deployment group.
The appspec file should be named "appspec.DEPLOYMENT_GROUP_NAME.yml" and must be present in the jenkins project workspace.
e.g.: appsec.staging.yml
boolean
waitForCompletion
If checked, this build will wait for the AWS CodeDeploy deployment to finish (with either success or failure). Polling Timeout, below, sets the maximum amount of time to wait.
If unchecked, the deployment will be handed off to AWS CodeDeploy and the build will move on to the next step.
The build will be marked a failure if either the timeout is reached or the deployment fails. The build log will indicate which.
boolean
pollingTimeoutSec
long
pollingFreqSec
long
credentials
String
versionFileName
String
deploymentMethod
String
awsAccessKey
AWS Access and Secret keys to use for this deployment. At minimum the keys must be allowed to execute codedeploy:*
and s3:Put*
. It's a best practice to have these keys be from an IAM role with limited scope.
If your Jenkins install is running on an EC2 instance with an associate IAM role, you can leave these fields blank. You will just need to ensure that the role has the correct policies.
String
awsSecretKey
AWS Access and Secret keys to use for this deployment. At minimum the keys must be allowed to execute codedeploy:*
and s3:Put*
. It's a best practice to have these keys be from an IAM role with limited scope.
If your Jenkins install is running on an EC2 instance with an associate IAM role, you can leave these fields blank. You will just need to ensure that the role has the correct policies.
String
iamRoleArn
In order to keep your application(s) more secure, this plugin only uses temporary credentials via STS, scoped to each application. To set this up:
{"Version": "2012-10-17", "Statement": [{"Effect": "Allow", "Action": ["codedeploy:*", "s3:*"], "Resource": "*"}]}
String
externalId
String
includes
String
proxyHost
Proxy host DNS name
String
proxyPort
Proxy host port
int
excludes
String
subdirectory
String
devicefarm
projectName
String
devicePoolName
String
testSpecName
String
environmentToRun
String
appArtifact
String
runName
String
testToRun
String
storeResults
boolean
isRunUnmetered
boolean
eventCount
String
eventThrottle
String
seed
String
username
String
password
String
appiumJavaJUnitTest
String
appiumJavaTestNGTest
String
appiumPythonTest
String
appiumRubyTest
String
appiumNodeTest
String
calabashFeatures
String
calabashTags
String
calabashProfile
String
junitArtifact
String
junitFilter
String
uiautomatorArtifact
String
uiautomatorFilter
String
uiautomationArtifact
String
xctestArtifact
String
xctestFilter
String
xctestUiArtifact
String
xctestUiFilter
String
appiumVersionJunit
String
appiumVersionPython
String
appiumVersionTestng
String
ifWebApp
boolean
extraData
boolean
extraDataArtifact
String
deviceLocation
boolean
deviceLatitude
double
deviceLongitude
double
radioDetails
boolean
ifBluetooth
boolean
ifWifi
boolean
ifGPS
boolean
ifNfc
boolean
jobTimeoutMinutes
int
ifVideoRecording
boolean
ifAppPerformanceMonitoring
boolean
ignoreRunError
boolean
ifVpce
boolean
ifSkipAppResigning
boolean
vpceServiceName
String
$class: 'AWSEBDeploymentBuilder'
credentialId
String
awsRegion
String
applicationName
String
environmentName
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
bucketName
S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
(Optional, will call createStorageLocation
if blank)
String
keyPrefix
String
versionLabelFormat
String
versionDescriptionFormat
String
rootObject
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
includes
String
excludes
String
zeroDowntime
boolean
sleepTime
int
checkHealth
boolean
maxAttempts
int
awsebReleaser
credentialId
String
awsRegion
String
applicationName
String
environmentId
String
versionLabel
String
$class: 'AddTestToSetStep'
domain
String
project
String
testPlanPath
String
testSetPath
String
alaudaDeleteBuild
buildID
(optional)
String
alaudaStartBuild
buildConfigName
(optional)
String
async
(optional)
boolean
branch
(optional)
String
commitID
(optional)
String
spaceName
(optional)
String
$class: 'AlaudaNotifier'
name
(optional)
String
body
(optional)
String
spaceName
(optional)
String
allure
results
path
String
commandline
(optional)
String
config
(optional)
results
path
String
commandline
(optional)
String
configPath
(optional)
String
includeProperties
(optional)
boolean
jdk
(optional)
String
properties
(optional)
key
String
value
String
reportBuildPolicy
(optional)
ALWAYS
, UNSTABLE
, UNSUCCESSFUL
configPath
(optional)
String
disabled
(optional)
boolean
includeProperties
(optional)
boolean
jdk
(optional)
String
properties
(optional)
key
String
value
String
report
(optional)
String
reportBuildPolicy
(optional)
ALWAYS
, UNSTABLE
, UNSUCCESSFUL
$class: 'AnalysisPublisher'
androidLintActivated
(optional)
boolean
canComputeNew
(optional)
boolean
canResolveRelativePaths
(optional)
boolean
canRunOnFailed
(optional)
boolean
checkStyleActivated
(optional)
boolean
defaultEncoding
(optional)
String
dryActivated
(optional)
boolean
failedNewAll
(optional)
String
failedNewHigh
(optional)
String
failedNewLow
(optional)
String
failedNewNormal
(optional)
String
failedTotalAll
(optional)
String
failedTotalHigh
(optional)
String
failedTotalLow
(optional)
String
failedTotalNormal
(optional)
String
findBugsActivated
(optional)
boolean
healthy
(optional)
String
openTasksActivated
(optional)
boolean
pmdActivated
(optional)
boolean
shouldDetectModules
(optional)
boolean
thresholdLimit
(optional)
String
unHealthy
(optional)
String
unstableNewAll
(optional)
String
unstableNewHigh
(optional)
String
unstableNewLow
(optional)
String
unstableNewNormal
(optional)
String
unstableTotalAll
(optional)
String
unstableTotalHigh
(optional)
String
unstableTotalLow
(optional)
String
unstableTotalNormal
(optional)
String
useDeltaValues
(optional)
boolean
usePreviousBuildAsReference
(optional)
boolean
useStableBuildAsReference
(optional)
boolean
warningsActivated
(optional)
boolean
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
$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: 'AnsibleVaultBuilder'
action
(optional)
String
ansibleName
(optional)
String
content
(optional)
String
input
(optional)
String
newVaultCredentialsId
(optional)
String
output
(optional)
String
vaultCredentialsId
(optional)
String
androidApkUpload
apkFilesPattern
(optional)
String
deobfuscationFilesPattern
(optional)
String
expansionFilesPattern
(optional)
Specifies filenames or patterns matching zero or more expansion files that should be associated with the APK files being uploaded to Google Play.
You can list as many or as few expansion files as you like — you have the option of associating previously-uploaded expansion files with the new APKs being uploading here.String
filesPattern
(optional)
String
googleCredentialsId
(optional)
String
recentChangeList
(optional)
language
String
text
String
rolloutPercent
(optional)
double
rolloutPercentage
(optional)
String
trackName
(optional)
String
usePreviousExpansionFilesIfMissing
(optional)
boolean
appCenter
apiToken
String
ownerName
String
appName
String
pathToApp
String
distributionGroups
String
notifyTesters
(optional)
boolean
pathToDebugSymbols
(optional)
String
releaseNotes
(optional)
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
$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: 'ApperianRecorder'
uploads
prodEnv
Choose the production environment to which the plugin will connect. If you aren’t sure which environment to choose, contact Customer Support at support@arxan.com.
String
customApperianUrl
String
apiTokenId
Choose an API token to use for authenticating your Apperian organization.
To include additional tokens in this list, go to Jenkins > Credentials and add a new Global Credential. In the Kind field, choose Secret Text, set Scope to Global, and add your API token in the Secret field.
The user associated with the API token must have valid permissions for adding apps in Apperian. For more information on user permissions, see Managing Users.
String
appId
To update an existing app, choose it from this list of native apps currently stored in your Apperian organization.
String
filename
Specify the filename pattern that this plugin will use to search for and upload the app file from your workspace.
If your project builds multiple versions of the app binary (for example, signed and unsigned), use this field to explicitly specify the correct file in the workspace. For example: target/android-app-v*.apk.
String
appName
String
shortDescription
String
longDescription
String
author
String
version
String
versionNotes
String
signApp
boolean
credential
Choose the credentials you want to use to sign the app. If no credentials are listed, or if you need to add different credentials, see Managing Signing Credentials.
Remember, when you re-sign an iOS or Android app that was already installed on any of your users' devices, it is important that you sign it with the same signing credentials used to previously sign it.
String
enableApp
boolean
reapplyPolicies
boolean
applatix
axUrl
String
axUsername
String
axPassword
String
axServiceTemplateName
String
axServiceTemplateRepository
String
axServiceTemplateBranch
String
axServiceTemplateParameters
key
String
value
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
customFlags
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
arestocats
metricsDatafilesPattern
String
resultsDatafilesPattern
String
numBuilds
int
archiveArtifacts
artifacts
String
allowEmptyArchive
(optional)
boolean
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
excludes
(optional)
String
fingerprint
(optional)
boolean
onlyIfSuccessful
(optional)
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
Define the artifacts you would like to download.
The target directory defines where the artifacts should be copied to. The coordinates are as you know it from maven or ivy:
artifacts
groupId
String
artifactId
String
version
String
classifier
(optional)
String
extension
(optional)
String
targetFileName
(optional)
String
enableRepoLogging
(optional)
boolean
failOnError
(optional)
boolean
releaseChecksumPolicy
(optional)
String
releaseUpdatePolicy
(optional)
String
snapshotChecksumPolicy
(optional)
String
snapshotUpdatePolicy
(optional)
String
targetDirectory
(optional)
String
assertthatBddFeatures
projectId
String
credentialsId
String
outputFolder
String
jql
String
mode
String
proxyURI
String
proxyUsername
String
proxyPassword
String
assertthatBddReport
projectId
String
credentialsId
String
jsonReportFolder
String
jsonReportIncludePattern
String
runName
String
type
String
proxyURI
String
proxyUsername
String
proxyPassword
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
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
$class: 'BapFtpPromotionPublisherPlugin'
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
ftpPublisher
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
Select to publish from the Jenkins master.
The default is to publish from the server that holds the files to transfer (workspace on the slave, or artifacts directory on the master)
Enabling this option could help dealing with strict network configurations and firewall rules.
This option will cause the files to be transferred through the master before being sent to the remote server, this may increase network traffic, and could increase the build time.
boolean
masterNodeName
Set the NODE_NAME for the master Jenkins.
Set this option to give a value to the NODE_NAME environment variable when the value is missing (the Jenkins master).
This is useful if you use the $NODE_NAME variable in the remoteDirectory option and the build may occur on the master.
String
paramPublish
parameterName
String
$class: 'BapSshPromotionPublisherPlugin'
publishers
configName
Select an SSH configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the SSH server.
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
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
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
execCommand
(optional)
A command to execute on the remote server
This command will be executed on the remote server after any files are transferred.
The SSH Transfer Set must include either a Source Files pattern, an Exec command, or both. If both are present, the files are transferred before the command is executed. If you want to Exec before the files are transferred, use 2 Transfer Sets and move the Exec command before the Transfer set that includes a Source files pattern.
String
execTimeout
(optional)
Timeout in milliseconds for the Exec command
Set to zero to disable.
int
usePty
(optional)
Exec the command in a pseudo tty
This will enable the execution of sudo commands that require a tty (and possibly help in other scenarios too.)
From the sudoers(5) man page:
requiretty If set, sudo will only run when the user is logged in to a real tty. When this flag is set, sudo can only be run from a login session and not via other means such as cron(8) or cgi-bin scripts. This flag is off by default.
boolean
useAgentForwarding
(optional)
Exec the command using Agent Forwarding
Allows a chain of ssh connections to forward key challenges back to the original agent, thus eliminating the need for using a password or public/private keys for these connections.
From the ssh(1) man page:
Enables forwarding of the authentication agent connection. This can also be specified on a per-host basis in a configuration file. Agent forwarding should be enabled with caution. Users with the ability to bypass file permissions on the remote host (for the agent's UNIX-domain socket) can access the local agent through the forwarded connection. An attacker cannot obtain key material from the agent, however they can perform operations on the keys that enable them to authenticate using the identities loaded into the agent.
boolean
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
sshRetry
If publishing to this server or command execution fails, try again.
Files that were successfully transferred will not be re-sent.
If Exec command is configured, but fails in any way (including a non zero exit code), then it will be retried.
retries
int
retryDelay
long
sshLabel
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
label
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
String
sshCredentials
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set them here.
username
String
encryptedPassphrase
Key
or
Path to key
is configured.
String
key
The private key.
Paste the private key here, or provide the path to the file containing the key in Path to key
.
String
keyPath
The path to the private key.
Either supply the path to the file containing the key, or paste the key into the Key
box.
The Path to key
can be absolute, or relative to $JENKINS_HOME
String
continueOnError
boolean
failOnError
boolean
alwaysPublishFromMaster
boolean
masterNodeName
String
paramPublish
parameterName
String
sshPublisher
alwaysPublishFromMaster
(optional)
Select to publish from the Jenkins master.
The default is to publish from the server that holds the files to transfer (workspace on the slave, or artifacts directory on the master)
Enabling this option could help dealing with strict network configurations and firewall rules.
This option will cause the files to be transferred through the master before being sent to the remote server, this may increase network traffic, and could increase the build time.
boolean
continueOnError
(optional)
boolean
failOnError
(optional)
boolean
masterNodeName
(optional)
Set the NODE_NAME for the master Jenkins.
Set this option to give a value to the NODE_NAME environment variable when the value is missing (the Jenkins master).
This is useful if you use the $NODE_NAME variable in the remote directory option and the build may occur on the master.
String
paramPublish
(optional)
parameterName
String
publishers
(optional)
configName
Select an SSH configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the SSH server.
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
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
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
execCommand
(optional)
A command to execute on the remote server
This command will be executed on the remote server after any files are transferred.
The SSH Transfer Set must include either a Source Files pattern, an Exec command, or both. If both are present, the files are transferred before the command is executed. If you want to Exec before the files are transferred, use 2 Transfer Sets and move the Exec command before the Transfer set that includes a Source files pattern.
String
execTimeout
(optional)
Timeout in milliseconds for the Exec command
Set to zero to disable.
int
usePty
(optional)
Exec the command in a pseudo tty
This will enable the execution of sudo commands that require a tty (and possibly help in other scenarios too.)
From the sudoers(5) man page:
requiretty If set, sudo will only run when the user is logged in to a real tty. When this flag is set, sudo can only be run from a login session and not via other means such as cron(8) or cgi-bin scripts. This flag is off by default.
boolean
useAgentForwarding
(optional)
Exec the command using Agent Forwarding
Allows a chain of ssh connections to forward key challenges back to the original agent, thus eliminating the need for using a password or public/private keys for these connections.
From the ssh(1) man page:
Enables forwarding of the authentication agent connection. This can also be specified on a per-host basis in a configuration file. Agent forwarding should be enabled with caution. Users with the ability to bypass file permissions on the remote host (for the agent's UNIX-domain socket) can access the local agent through the forwarded connection. An attacker cannot obtain key material from the agent, however they can perform operations on the keys that enable them to authenticate using the identities loaded into the agent.
boolean
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
sshRetry
If publishing to this server or command execution fails, try again.
Files that were successfully transferred will not be re-sent.
If Exec command is configured, but fails in any way (including a non zero exit code), then it will be retried.
retries
int
retryDelay
long
sshLabel
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
label
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
String
sshCredentials
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set them here.
username
String
encryptedPassphrase
Key
or
Path to key
is configured.
String
key
The private key.
Paste the private key here, or provide the path to the file containing the key in Path to key
.
String
keyPath
The path to the private key.
Either supply the path to the file containing the key, or paste the key into the Key
box.
The Path to key
can be absolute, or relative to $JENKINS_HOME
String
$class: 'BeaglePlugin'
apptoken
hudson.util.Secret
accesstoken
hudson.util.Secret
benchmark
filepath
String
benchmark
The Benchmark Plugin collect and display boolean and numeral results. The results may come from one or multiple files. The result may be either in XML or JSON format. The content of the file may follow either a standard or a custom schema. The schema type may be selected using the drop-down menu and the custom schema entered in the associated text area.
In addition, the Benchmark Plugin provides the capability to associate different types of thresholds on numerical values to one or multiple results. If crossed, the thresholds will identify results as failures and ultimately trigger the build failure.The Benchmark Plugin, if successful, provides access to two pages where results are displayed. One with tables compiling information on all results and one with the details for a specific result.
inputLocation
String
schemaSelection
String
truncateStrings
boolean
altInputSchema
String
altInputSchemaLocation
String
thresholds
(optional)
org.jenkinsci.plugins.benchmark.thresholds.Threshold
$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: '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
$class: 'BrakemanPublisher'
outputFile
String
canComputeNew
(optional)
boolean
canResolveRelativePaths
(optional)
boolean
canRunOnFailed
(optional)
boolean
defaultEncoding
(optional)
String
failedNewAll
(optional)
String
failedNewHigh
(optional)
String
failedNewLow
(optional)
String
failedNewNormal
(optional)
String
failedTotalAll
(optional)
String
failedTotalHigh
(optional)
String
failedTotalLow
(optional)
String
failedTotalNormal
(optional)
String
healthy
(optional)
String
shouldDetectModules
(optional)
boolean
thresholdLimit
(optional)
String
unHealthy
(optional)
String
unstableNewAll
(optional)
String
unstableNewHigh
(optional)
String
unstableNewLow
(optional)
String
unstableNewNormal
(optional)
String
unstableTotalAll
(optional)
String
unstableTotalHigh
(optional)
String
unstableTotalLow
(optional)
String
unstableTotalNormal
(optional)
String
useDeltaValues
(optional)
boolean
usePreviousBuildAsReference
(optional)
boolean
useStableBuildAsReference
(optional)
boolean
buildDescription
descriptionTemplate
String
buildName
nameTemplate
String
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
$class: 'BuildStepsFromJsonBuilder'
buildStep
$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
$class: 'APISecurityNotifier'
apiServer
(optional)
String
credsId
(optional)
String
apiId
(optional)
String
dataCriticality
(optional)
String
dataGroupCount
(optional)
String
grade
(optional)
String
isFailOnDataGroup
(optional)
boolean
isFailOnGrade
(optional)
boolean
isFailOnSecurityGroup
(optional)
boolean
isFailOnValidationGroup
(optional)
boolean
newAppName
(optional)
String
platform
(optional)
String
proxyCredentialsId
(optional)
String
proxyPort
(optional)
int
proxyServer
(optional)
String
securityCriticality
(optional)
String
securityGroupCount
(optional)
String
swaggerPath
(optional)
String
useProxy
(optional)
boolean
validationCriticality
(optional)
String
validationGroupCount
(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'
credentialId
String
awsRegion
String
applicationName
String
environmentName
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
bucketName
S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
(Optional, will call createStorageLocation
if blank)
String
keyPrefix
String
versionLabelFormat
String
versionDescriptionFormat
String
rootObject
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
includes
String
excludes
String
zeroDowntime
boolean
sleepTime
int
checkHealth
boolean
maxAttempts
int
awsebReleaser
credentialId
String
awsRegion
String
applicationName
String
environmentId
String
versionLabel
String
$class: 'ActionHubPlugin'
$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
$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
verbose
(optional)
boolean
importTowerLogs
(optional)
boolean
removeColor
(optional)
boolean
templateType
(optional)
String
importWorkflowChildLogs
(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
$class: 'AppClone'
apiKey
String
appName
String
templateAppName
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
$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
$class: 'ApprendaBuilder'
appAlias
String
appName
String
versionAlias
String
stage
String
artifactName
String
credentialsId
String
prefix
String
advVersionAliasToBeForced
String
advancedNewVersionOption
String
customPackageDirectory
String
applicationPackageURL
String
archiveUploadMethod
String
buildWithParameters
boolean
aqua
locationType
String
registry
String
register
boolean
localImage
String
hostedImage
String
onDisallowed
String
notCompliesCmd
String
hideBase
boolean
showNegligible
boolean
policies
String
customFlags
String
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: '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
Define the artifacts you would like to download.
The target directory defines where the artifacts should be copied to. The coordinates are as you know it from maven or ivy:
artifacts
groupId
String
artifactId
String
version
String
classifier
(optional)
String
extension
(optional)
String
targetFileName
(optional)
String
enableRepoLogging
(optional)
boolean
failOnError
(optional)
boolean
releaseChecksumPolicy
(optional)
String
releaseUpdatePolicy
(optional)
String
snapshotChecksumPolicy
(optional)
String
snapshotUpdatePolicy
(optional)
String
targetDirectory
(optional)
String
$class: 'ArtifactsUploadBuilder'
projectName
String
parameters
String
selector
$class: 'ParameterizedBuildSelector'
parameterName
String
$class: 'PermalinkBuildSelector'
id
String
$class: 'SavedBuildSelector'
$class: 'SpecificBuildSelector'
buildNumber
String
$class: 'StatusBuildSelector'
stableOnly
boolean
$class: 'TriggeredBuildSelector'
fallback
boolean
$class: 'WorkspaceSelector'
filter
String
target
String
flatten
boolean
optional
boolean
fingerprintArtifacts
boolean
autoMedia
Type or select the item path in the media repository.
A path without an extension would be considered a folder into which the file/s will be uploaded.
If you specify a path of a file, that would be the name of the uploaded file in the repository.
String
assertthatBddFeatures
projectId
String
credentialsId
String
outputFolder
String
jql
String
mode
String
proxyURI
String
proxyUsername
String
proxyPassword
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
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
$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
hudson.util.Secret
configurations
String
cuuid
String
$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
$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
$class: 'BapSshBuilderPlugin'
publishers
configName
Select an SSH configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the SSH server.
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
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
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
execCommand
(optional)
A command to execute on the remote server
This command will be executed on the remote server after any files are transferred.
The SSH Transfer Set must include either a Source Files pattern, an Exec command, or both. If both are present, the files are transferred before the command is executed. If you want to Exec before the files are transferred, use 2 Transfer Sets and move the Exec command before the Transfer set that includes a Source files pattern.
String
execTimeout
(optional)
Timeout in milliseconds for the Exec command
Set to zero to disable.
int
usePty
(optional)
Exec the command in a pseudo tty
This will enable the execution of sudo commands that require a tty (and possibly help in other scenarios too.)
From the sudoers(5) man page:
requiretty If set, sudo will only run when the user is logged in to a real tty. When this flag is set, sudo can only be run from a login session and not via other means such as cron(8) or cgi-bin scripts. This flag is off by default.
boolean
useAgentForwarding
(optional)
Exec the command using Agent Forwarding
Allows a chain of ssh connections to forward key challenges back to the original agent, thus eliminating the need for using a password or public/private keys for these connections.
From the ssh(1) man page:
Enables forwarding of the authentication agent connection. This can also be specified on a per-host basis in a configuration file. Agent forwarding should be enabled with caution. Users with the ability to bypass file permissions on the remote host (for the agent's UNIX-domain socket) can access the local agent through the forwarded connection. An attacker cannot obtain key material from the agent, however they can perform operations on the keys that enable them to authenticate using the identities loaded into the agent.
boolean
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
sshRetry
If publishing to this server or command execution fails, try again.
Files that were successfully transferred will not be re-sent.
If Exec command is configured, but fails in any way (including a non zero exit code), then it will be retried.
retries
int
retryDelay
long
sshLabel
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
label
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
String
sshCredentials
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set them here.
username
String
encryptedPassphrase
Key
or
Path to key
is configured.
String
key
The private key.
Paste the private key here, or provide the path to the file containing the key in Path to key
.
String
keyPath
The path to the private key.
Either supply the path to the file containing the key, or paste the key into the Key
box.
The Path to key
can be absolute, or relative to $JENKINS_HOME
String
continueOnError
boolean
failOnError
boolean
alwaysPublishFromMaster
boolean
masterNodeName
String
paramPublish
parameterName
String
batchFile
command
String
$class: 'BeaglePlugin'
apptoken
hudson.util.Secret
accesstoken
hudson.util.Secret
$class: 'BeakerBuilder'
jobSource
$class: 'FileJobSource'
jobPath
String
$class: 'StringJobSource'
jobContent
String
downloadFiles
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: '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
$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
$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
hudson.util.Secret
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
$class: 'BuildStepBuilder'
sourceFolderMode
String
subfolder
String
packageId
String
serverType
String
server
String
authenticationType
String
userName
String
password
hudson.util.Secret
database
String
compareOptions
(optional)
String
$class: 'BuildStepWithTimeout'
buildStep
$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: 'CFLintBuilder'
folder
String
cflintFolder
String
cflintExcludesFile
String
otherArgs
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
activeMQSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(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
fedmsgSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(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
$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
activeMQSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(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
fedmsgSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(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
$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: 'CallOtherJenkinsBuilder'
hostName
String
jobName
String
span
String
retry
String
userName
String
password
String
parameters
String
$class: 'CaptureIOSDeviceScreenshot'
url
String
cloudTestServerID
String
additionalOptions
String
castecho
installationName
String
sourcePath
String
applicationName
String
displayLog
(optional)
boolean
logPath
(optional)
String
outputPath
(optional)
String
qualityGate
(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: 'ChangesetEvaluator'
basePath
(optional)
String
changeLogFile
(optional)
String
changeLogParameters
(optional)
String
classpath
(optional)
String
contexts
(optional)
String
credentialsId
(optional)
String
databaseEngine
(optional)
String
defaultSchemaName
(optional)
String
driverClassname
(optional)
String
dropAll
(optional)
boolean
labels
(optional)
String
liquibasePropertiesPath
(optional)
String
password
(optional)
String
tagOnSuccessfulBuild
(optional)
boolean
testRollbacks
(optional)
boolean
url
(optional)
String
useIncludedDriver
(optional)
boolean
username
(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
examCleanTarget
$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.lang.String>
$class: '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
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
$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: 'CodeAnalysisBuilder'
connection
An Oracle connection string used for connecting to the database.
user/password@host:port/service
String
objects
name
A database object name can contain special pattern-matching characters:
An underscore (_) or question mark (?) in the pattern matches exactly one character.
A percent sign (%) or asterisk (*) in the pattern matches zero or more characters.
An exclamation mark (!) in the pattern excludes zero or more characters.
String
owner
A database object owner can contain special pattern-matching characters:
An underscore (_) or question mark (?) in the pattern matches exactly one character.
A percent sign (%) or asterisk (*) in the pattern matches zero or more characters.
An exclamation mark (!) in the pattern excludes zero or more characters.
String
type
String
objectFolders
path
The path of the directory to use to analyse files. Please note that this is relative to the machine running the job.
String
filter
String
recurse
boolean
report
name
The base name of the reports, without an extension. If empty no reports will be generated.
String
html
boolean
json
boolean
xls
boolean
xml
boolean
ruleSet
int
failConditions
halstead
Halstead level which will cause the code analysis to fail, exclude to ignore.
int
maintainability
Maintainability index level which will cause the code analysis to fail, exclude to ignore.
int
mcCabe
McCabes level which will cause the code analysis to fail, exclude to ignore.
int
TCR
Toad Code Rating level which will cause the code analysis to fail, exclude to ignore.
int
ruleViolations
If enabled, code analysis will fail on any violation for the selected rule set.
boolean
syntaxErrors
If enabled, code analysis will fail on any syntax error.
boolean
ignoreWrappedPackages
If enabled, code analysis will fail when a wrapped package is found.
boolean
$class: 'CodeBuilder'
credentialsType
String
credentialsId
String
proxyHost
String
proxyPort
String
awsAccessKey
String
awsSecretKey
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
cloudWatchLogsStatusOverride
String
cloudWatchLogsGroupNameOverride
String
cloudWatchLogsStreamNameOverride
String
s3LogsStatusOverride
String
s3LogsLocationOverride
String
certificateOverride
String
serviceRoleOverride
String
insecureSslOverride
String
privilegedModeOverride
String
cwlStreamingDisabled
String
exceptionFailureMode
String
$class: 'CodeCoverageBuilder'
connectionId
String
credentialsId
String
analysisPropertiesPath
String
analysisProperties
String
$class: 'CodeScanBuilder'
projectKey
String
commitOverride
String
version
String
emailReportTo
The list of user names in instance. Invalid usernames are skipped with a warning.
Setting the analysis mode to 'preview' will create a 'new issues' build report but will not update the database
String
analysisMode
String
projectBranch
String
blocking
boolean
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
useBiomarkers
(optional)
boolean
$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: '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
$class: 'APISecurityNotifier'
apiServer
(optional)
String
credsId
(optional)
String
apiId
(optional)
String
dataCriticality
(optional)
String
dataGroupCount
(optional)
String
grade
(optional)
String
isFailOnDataGroup
(optional)
boolean
isFailOnGrade
(optional)
boolean
isFailOnSecurityGroup
(optional)
boolean
isFailOnValidationGroup
(optional)
boolean
newAppName
(optional)
String
platform
(optional)
String
proxyCredentialsId
(optional)
String
proxyPort
(optional)
int
proxyServer
(optional)
String
securityCriticality
(optional)
String
securityGroupCount
(optional)
String
swaggerPath
(optional)
String
useProxy
(optional)
boolean
validationCriticality
(optional)
String
validationGroupCount
(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'
credentialId
String
awsRegion
String
applicationName
String
environmentName
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
bucketName
S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
(Optional, will call createStorageLocation
if blank)
String
keyPrefix
String
versionLabelFormat
String
versionDescriptionFormat
String
rootObject
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
includes
String
excludes
String
zeroDowntime
boolean
sleepTime
int
checkHealth
boolean
maxAttempts
int
awsebReleaser
credentialId
String
awsRegion
String
applicationName
String
environmentId
String
versionLabel
String
$class: 'ActionHubPlugin'
$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
$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
verbose
(optional)
boolean
importTowerLogs
(optional)
boolean
removeColor
(optional)
boolean
templateType
(optional)
String
importWorkflowChildLogs
(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
$class: 'AppClone'
apiKey
String
appName
String
templateAppName
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
$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
$class: 'ApprendaBuilder'
appAlias
String
appName
String
versionAlias
String
stage
String
artifactName
String
credentialsId
String
prefix
String
advVersionAliasToBeForced
String
advancedNewVersionOption
String
customPackageDirectory
String
applicationPackageURL
String
archiveUploadMethod
String
buildWithParameters
boolean
aqua
locationType
String
registry
String
register
boolean
localImage
String
hostedImage
String
onDisallowed
String
notCompliesCmd
String
hideBase
boolean
showNegligible
boolean
policies
String
customFlags
String
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: '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
Define the artifacts you would like to download.
The target directory defines where the artifacts should be copied to. The coordinates are as you know it from maven or ivy:
artifacts
groupId
String
artifactId
String
version
String
classifier
(optional)
String
extension
(optional)
String
targetFileName
(optional)
String
enableRepoLogging
(optional)
boolean
failOnError
(optional)
boolean
releaseChecksumPolicy
(optional)
String
releaseUpdatePolicy
(optional)
String
snapshotChecksumPolicy
(optional)
String
snapshotUpdatePolicy
(optional)
String
targetDirectory
(optional)
String
$class: 'ArtifactsUploadBuilder'
projectName
String
parameters
String
selector
$class: 'ParameterizedBuildSelector'
parameterName
String
$class: 'PermalinkBuildSelector'
id
String
$class: 'SavedBuildSelector'
$class: 'SpecificBuildSelector'
buildNumber
String
$class: 'StatusBuildSelector'
stableOnly
boolean
$class: 'TriggeredBuildSelector'
fallback
boolean
$class: 'WorkspaceSelector'
filter
String
target
String
flatten
boolean
optional
boolean
fingerprintArtifacts
boolean
autoMedia
Type or select the item path in the media repository.
A path without an extension would be considered a folder into which the file/s will be uploaded.
If you specify a path of a file, that would be the name of the uploaded file in the repository.
String
assertthatBddFeatures
projectId
String
credentialsId
String
outputFolder
String
jql
String
mode
String
proxyURI
String
proxyUsername
String
proxyPassword
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
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
$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
hudson.util.Secret
configurations
String
cuuid
String
$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
$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
$class: 'BapSshBuilderPlugin'
publishers
configName
Select an SSH configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the SSH server.
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
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
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
execCommand
(optional)
A command to execute on the remote server
This command will be executed on the remote server after any files are transferred.
The SSH Transfer Set must include either a Source Files pattern, an Exec command, or both. If both are present, the files are transferred before the command is executed. If you want to Exec before the files are transferred, use 2 Transfer Sets and move the Exec command before the Transfer set that includes a Source files pattern.
String
execTimeout
(optional)
Timeout in milliseconds for the Exec command
Set to zero to disable.
int
usePty
(optional)
Exec the command in a pseudo tty
This will enable the execution of sudo commands that require a tty (and possibly help in other scenarios too.)
From the sudoers(5) man page:
requiretty If set, sudo will only run when the user is logged in to a real tty. When this flag is set, sudo can only be run from a login session and not via other means such as cron(8) or cgi-bin scripts. This flag is off by default.
boolean
useAgentForwarding
(optional)
Exec the command using Agent Forwarding
Allows a chain of ssh connections to forward key challenges back to the original agent, thus eliminating the need for using a password or public/private keys for these connections.
From the ssh(1) man page:
Enables forwarding of the authentication agent connection. This can also be specified on a per-host basis in a configuration file. Agent forwarding should be enabled with caution. Users with the ability to bypass file permissions on the remote host (for the agent's UNIX-domain socket) can access the local agent through the forwarded connection. An attacker cannot obtain key material from the agent, however they can perform operations on the keys that enable them to authenticate using the identities loaded into the agent.
boolean
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
sshRetry
If publishing to this server or command execution fails, try again.
Files that were successfully transferred will not be re-sent.
If Exec command is configured, but fails in any way (including a non zero exit code), then it will be retried.
retries
int
retryDelay
long
sshLabel
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
label
Set the label for this Server instance - for use with Parameterized publishing
Expand the help for Parameterized publishing for more details
String
sshCredentials
If you want to use different credentials from those configured for this server, or if the credentials have not been specified for this server, then enable this option and set them here.
username
String
encryptedPassphrase
Key
or
Path to key
is configured.
String
key
The private key.
Paste the private key here, or provide the path to the file containing the key in Path to key
.
String
keyPath
The path to the private key.
Either supply the path to the file containing the key, or paste the key into the Key
box.
The Path to key
can be absolute, or relative to $JENKINS_HOME
String
continueOnError
boolean
failOnError
boolean
alwaysPublishFromMaster
boolean
masterNodeName
String
paramPublish
parameterName
String
batchFile
command
String
$class: 'BeaglePlugin'
apptoken
hudson.util.Secret
accesstoken
hudson.util.Secret
$class: 'BeakerBuilder'
jobSource
$class: 'FileJobSource'
jobPath
String
$class: 'StringJobSource'
jobContent
String
downloadFiles
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: '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
$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
$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
hudson.util.Secret
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
$class: 'BuildStepBuilder'
sourceFolderMode
String
subfolder
String
packageId
String
serverType
String
server
String
authenticationType
String
userName
String
password
hudson.util.Secret
database
String
compareOptions
(optional)
String
$class: 'BuildStepWithTimeout'
buildStep
$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: 'CFLintBuilder'
folder
String
cflintFolder
String
cflintExcludesFile
String
otherArgs
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
activeMQSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(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
fedmsgSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(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
$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
activeMQSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(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
fedmsgSubscriber
checks
(optional)
field
String
expectedValue
String
name
(optional)
String
overrides
(optional)
topic
(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
$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: 'CallOtherJenkinsBuilder'
hostName
String
jobName
String
span
String
retry
String
userName
String
password
String
parameters
String
$class: 'CaptureIOSDeviceScreenshot'
url
String
cloudTestServerID
String
additionalOptions
String
castecho
installationName
String
sourcePath
String
applicationName
String
displayLog
(optional)
boolean
logPath
(optional)
String
outputPath
(optional)
String
qualityGate
(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: 'ChangesetEvaluator'
basePath
(optional)
String
changeLogFile
(optional)
String
changeLogParameters
(optional)
String
classpath
(optional)
String
contexts
(optional)
String
credentialsId
(optional)
String
databaseEngine
(optional)
String
defaultSchemaName
(optional)
String
driverClassname
(optional)
String
dropAll
(optional)
boolean
labels
(optional)
String
liquibasePropertiesPath
(optional)
String
password
(optional)
String
tagOnSuccessfulBuild
(optional)
boolean
testRollbacks
(optional)
boolean
url
(optional)
String
useIncludedDriver
(optional)
boolean
username
(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
examCleanTarget
$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.lang.String>
$class: '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
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
$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: 'CodeAnalysisBuilder'
connection
An Oracle connection string used for connecting to the database.
user/password@host:port/service
String
objects
name
A database object name can contain special pattern-matching characters:
An underscore (_) or question mark (?) in the pattern matches exactly one character.
A percent sign (%) or asterisk (*) in the pattern matches zero or more characters.
An exclamation mark (!) in the pattern excludes zero or more characters.
String
owner
A database object owner can contain special pattern-matching characters:
An underscore (_) or question mark (?) in the pattern matches exactly one character.
A percent sign (%) or asterisk (*) in the pattern matches zero or more characters.
An exclamation mark (!) in the pattern excludes zero or more characters.
String
type
String
objectFolders
path
The path of the directory to use to analyse files. Please note that this is relative to the machine running the job.
String
filter
String
recurse
boolean
report
name
The base name of the reports, without an extension. If empty no reports will be generated.
String
html
boolean
json
boolean
xls
boolean
xml
boolean
ruleSet
int
failConditions
halstead
Halstead level which will cause the code analysis to fail, exclude to ignore.
int
maintainability
Maintainability index level which will cause the code analysis to fail, exclude to ignore.
int
mcCabe
McCabes level which will cause the code analysis to fail, exclude to ignore.
int
TCR
Toad Code Rating level which will cause the code analysis to fail, exclude to ignore.
int
ruleViolations
If enabled, code analysis will fail on any violation for the selected rule set.
boolean
syntaxErrors
If enabled, code analysis will fail on any syntax error.
boolean
ignoreWrappedPackages
If enabled, code analysis will fail when a wrapped package is found.
boolean
$class: 'CodeBuilder'
credentialsType
String
credentialsId
String
proxyHost
String
proxyPort
String
awsAccessKey
String
awsSecretKey
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
cloudWatchLogsStatusOverride
String
cloudWatchLogsGroupNameOverride
String
cloudWatchLogsStreamNameOverride
String
s3LogsStatusOverride
String
s3LogsLocationOverride
String
certificateOverride
String
serviceRoleOverride
String
insecureSslOverride
String
privilegedModeOverride
String
cwlStreamingDisabled
String
exceptionFailureMode
String
$class: 'CodeCoverageBuilder'
connectionId
String
credentialsId
String
analysisPropertiesPath
String
analysisProperties
String
$class: 'CodeScanBuilder'
projectKey
String
commitOverride
String
version
String
emailReportTo
The list of user names in instance. Invalid usernames are skipped with a warning.
Setting the analysis mode to 'preview' will create a 'new issues' build report but will not update the database
String
analysisMode
String
projectBranch
String
blocking
boolean
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
useBiomarkers
(optional)
boolean
$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: '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: '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: '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: '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: '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: '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: '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: '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: '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
$class: 'ConfigAdd'
apiKey
String
appName
String
configVars
String
$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.lang.String>
$class: 'CoordinatorBuilder'
executionPlan
org.jenkinsci.plugins.coordinator.model.TreeNode
$class: 'CopadoBuilder'
stepName
String
webhookUrl
String
api_key
String
timeout
int
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: 'CreateFileBuilder'
textFilePath
String
textFileContent
String
fileOption
String
useWorkspace
boolean
$class: 'CreateFingerprint'
Create Fingerprints of specified files during a build process
targets
String
$class: 'CreatePackageBuilder'
Creates a new build for the selected BuildMaster application and sets the BUILDMASTER_PACKAGE_NUMBER environment variable.
The choice of using the build step or post build action to trigger a BuildMaster build will be largely dependent on how you import the build artifacts into BuildMaster:
If you have multiple Jenkins jobs all triggering a build for the same BuildMaster application check out the "Enable Deployable in BuildMaster" and "Copy Previous Build's Variables" options as a means to ensure that the new BuildMaster build picks up artifacts from only the Jenkins jobs that have build for its release.
applicationId
(optional)
String
deployToFirstStage
(optional)
waitUntilDeploymentCompleted
boolean
printLogOnFailure
(optional)
boolean
enableReleaseDeployable
(optional)
If the BuildMaster deployable that these artifacts are associated with are disabled by default for a release checking this option will enable the deployable for the release before triggering a build.
This might be useful when you have multiple Jenkins jobs all triggering a build for the same BuildMaster application.
deployableId
The id of the deployable to ensure is enabled in BuildMaster for the selected release. Defaults to the BUILDMASTER_DEPLOYABLE_ID variable populated by the "Select BuildMaster Application" action.
String
packageNumber
(optional)
The number that BuildMaster should use for the build. Defaults to the BUILDMASTER_PACKAGE_NUMBER variable populated by the "Select BuildMaster Application" action. Leave the field blank to have BuildMaster use it's own BuildNumber - the BUILDMASTER_PACKAGE_NUMBER will be set to the actual BuildMaster build number used in this instance.
If supplying a build number to BuildMaster and the build will fail with a BadRequest exception if an attempt is made to reuse a build number from a previous build. If this happens you will need to update the Jenkins build number to something greater than the latest BuildMaster build - there is a plugin to help with that: Next Build Number Plugin.
NOTE: to retain backwards compatibility BUILDMASTER_PACKAGE_NUMBER has not been updated to reflect the new naming standard from BuildMaster - this may change in a future release
String
packageVariables
(optional)
Set build level variables.
variables
Provide a list of variables to pass to BuildMaster.
String
preserveVariables
(optional)
If checked will gather the variables from the previous build and include them in the list of variables being passed in for this build, these will not override any variables being added in the Variables list below.
This might be useful when you have multiple Jenkins jobs all triggering a build for the same BuildMaster application.
boolean
releaseNumber
(optional)
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
$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'
Delimite the beginning of the exclusion zone. All build steps that follow will be managed by exclusion plugin.
cryptomove
name
String
token
String
email
String
$class: 'CucumberSlackBuildStepNotifier'
channel
String
json
String
hideSuccessfulResults
boolean
$class: 'CustomPythonBuilder'
home
String
nature
String
command
String
ignoreExitCode
boolean
$class: 'CxScanBuilder'
credentialsId
String
buildStep
String
teamPath
String
sastEnabled
boolean
exclusionsSetting
String
failBuildOnNewResults
boolean
failBuildOnNewSeverity
String
osaArchiveIncludePatterns
String
osaInstallBeforeScan
boolean
useOwnServerCredentials
(optional)
boolean
serverUrl
(optional)
String
username
(optional)
String
password
(optional)
String
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
sourceEncoding
(optional)
String
comment
(optional)
String
skipSCMTriggers
(optional)
boolean
waitForResultsEnabled
(optional)
boolean
vulnerabilityThresholdEnabled
(optional)
boolean
highThreshold
(optional)
int
mediumThreshold
(optional)
int
lowThreshold
(optional)
int
osaEnabled
(optional)
boolean
osaHighThreshold
(optional)
int
osaMediumThreshold
(optional)
int
osaLowThreshold
(optional)
int
generatePdfReport
(optional)
boolean
enableProjectPolicyEnforcement
(optional)
boolean
thresholdSettings
(optional)
String
vulnerabilityThresholdResult
(optional)
String
includeOpenSourceFolders
(optional)
Include/Exclude definition will not affect dependencies resolved from package manager manifest files.
Comma separated list of include or exclude wildcard patterns. Exclude patterns start with exclamation mark "!". Example: *.jar */folder/* */folder1/folder2/* */folder*/* */file.* */file*.jar */test/*file*.*
May reference build parameters like ${PARAM}.
Examples:
"**/*.jar" matches all .jar jars in a directory tree.
"*/test/a??.jar" matches all files/dirs which start with an 'a', then two more characters and then ".jar", 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
excludeOpenSourceFolders
(optional)
String
avoidDuplicateProjectScans
(optional)
boolean
generateXmlReport
(optional)
boolean
thisBuildIncremental
(optional)
boolean
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: 'DatabaseDocBuilder'
outputDirectory
(optional)
String
basePath
(optional)
String
changeLogFile
(optional)
String
changeLogParameters
(optional)
String
classpath
(optional)
String
contexts
(optional)
String
credentialsId
(optional)
String
databaseEngine
(optional)
String
defaultSchemaName
(optional)
String
driverClassname
(optional)
String
labels
(optional)
String
liquibasePropertiesPath
(optional)
String
password
(optional)
String
url
(optional)
String
useIncludedDriver
(optional)
boolean
username
(optional)
String
$class: 'DaticalDBBuilder'
daticalDBProjectDir
String
daticalDBServer
String
daticalDBAction
String
daticalDBCmdProject
String
daticalDBExportSQL
String
daticalDBExportRollbackSQL
String
daticalDBScriptDir
String
$class: 'DebianPackageBuilder'
pathToDebian
String
nextVersion
String
generateChangelog
boolean
signPackage
boolean
buildEvenWhenThereAreNoChanges
boolean
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
$class: 'DeleteApplication'
serverName
String
appName
String
domain
String
$class: 'DeleteChartBuildStep'
id
String
kubeName
String
namespace
String
chartsRepo
String
chartName
String
deleteComponents
nexusInstanceId
String
tagName
String
$class: 'DeleteEnvironmentBuilder'
systemId
int
environmentName
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
$class: 'DeployChartBuildStep'
id
String
kubeName
String
namespace
String
chartsRepo
String
chartName
String
deleteChartWhenFinished
boolean
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
?>
$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
buildMasterDeployPackageToStage
Deploys (or re-deploys) a build to a particular stage.
Note that when used in a pipeline step that the applicationdId, releaseNumber, and packageNumber fields are required:
buildMasterDeployPackageToStage(applicationId: BUILDMASTER_APPLICATION_ID, releaseNumber: BUILDMASTER_RELEASE_NUMBER, packageNumber: BUILDMASTER_PACKAGE_NUMBER, waitTillBuildCompleted: [printLogOnFailure: true])
applicationId
(optional)
This setting would only be altered if not using the "Select BuildMaster Application" action.
String
deployVariables
(optional)
Set deployment level variables.
variables
Provide a list of variables to pass to BuildMaster.
String
packageNumber
(optional)
The job will fail if there is no active BuildMaster release.
This setting would only be altered if not using the "Select BuildMaster Application" action.
String
printLogOnFailure
(optional)
boolean
releaseNumber
(optional)
String
stage
(optional)
Optional. If not supplied, the next stage in the pipeline will be used.
String
waitUntilDeploymentCompleted
(optional)
boolean
$class: 'Deployer'
stack
String
dryRun
boolean
branch
String
apiKey
String
$class: 'DeploymentBuilder'
url
String
userId
String
password
String
enableZipFile
boolean
enableAutoDeploy
boolean
enableTestCase
testcaseblock
projectname
String
testcasename
String
xpath
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
devSpacesCreate
azureCredentialsId
String
aksName
(optional)
String
kubeconfigId
(optional)
String
resourceGroupName
(optional)
String
sharedSpaceName
(optional)
String
spaceName
(optional)
String
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)
hudson.util.Secret
profileId
(optional)
String
$class: 'DiawiUploader'
token
String
fileName
String
proxyHost
String
proxyPort
int
proxyProtocol
String
$class: 'DistTestingBuilder'
The goal of this plugin is to enable a distributed testing of some compiled classes on multiple nodes. Tests are send one by one to nodes in the label specified for the project and run. Test results are saved in the "results" directory in the project workspace. f.e. "TEST-helloword.HelloTest.xml" for the test class "helloworld.HelloTest".
This plugin suppose that all slaves in the specified label have a shared workspace directory. (like NFS)
Only classes in the "Tests classes directory" directory with a file name containing a "test" substring (case insensitive) are automatically found by this plugin and run.
If you enable "Publish JUnit test result report" in the "Post-build Actions" section and type "results/*.xml" you will see test results in the Hudson's web UI.
Only nodes in a label which were specified for this project ("Tie this project to a node") will be used for distributed testing. This label must contain at least 2 nodes.
It's possible let this plugin to compile tests class sources which were checkout from a repository if "Compile tests" checkbox was checked. Remember to provide all necessary libraries needed for compilation.
It's possible to check a "Wait for nodes which are busy" checkbox to wait for other nodes which are busy to be freed.
distLocations
distDir
String
libLocations
libDir
String
testDir
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
volumesString
String
volumesFrom
String
environmentsString
String
hostname
String
memoryLimit
int
memorySwap
int
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
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 slave nodes. These labels are metadata attached to the docker container itself (again, not the jenkins slave), 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
extraHostsString
(optional)
String
hostname
(optional)
String
macAddress
(optional)
String
memoryLimit
(optional)
int
memorySwap
(optional)
int
network
(optional)
String
privileged
(optional)
boolean
pullCredentialsId
(optional)
String
shmSize
(optional)
int
tty
(optional)
boolean
volumesFromString
(optional)
String
volumesString
(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
user
(optional)
String
jnlp
jnlpLauncher
tunnel
String
vmargs
String
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 master 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.
Note that containers which have not been created by Jenkins are not included in this 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.
Deprecated you should configure template with memory/cpu constraints, so docker infrastructure can manage resource consumption.
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)
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
$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
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
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
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
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: '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
azureIoTEdgeBuild
azureCredentialsId
(optional)
String
defaultPlatform
(optional)
In your .template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.
String
deploymentManifestFilePath
(optional)
The path of Azure IoT Edge solution .template.json. This file defines the modules and routes in Azure IoT Edge solution, file name must end with .template.json
String
resourceGroup
(optional)
String
rootPath
(optional)
String
azureIoTEdgeDeploy
azureCredentialsId
(optional)
String
resourceGroup
(optional)
String
rootPath
(optional)
In some cases, the Edge solution is not under the root of the code repository. You can specify path to the root of Edge solution in build definition. Example: If your code repository is an Edge solution, then leave it to default value './'. If your solution is under subfolder 'edge', then set it to 'edge'" Please notice that the module.json file path is relative to the root path of solution.
String
deploymentFilePath
(optional)
String
deploymentId
(optional)
Input the IoT Edge Deployment ID, if ID exists, it will be overridden.Lowercase letters, numbers and the following characters are allowed [ -:+%_#*?!(),=@;' ], no more than 128 characters. For more information: Visit docs
String
deploymentType
(optional)
String
deviceId
(optional)
String
iothubName
(optional)
String
priority
(optional)
Set the priority to a positive integer to resolve deployment conflicts: when targeted by multiple deployments a device will use the one with highest priority or (in case of two deployments with the same priority) latest creation time. For more information: Visit docs
String
targetCondition
(optional)
A target condition to determine which devices will be targeted with this deployment. Example tags.environment='test', properties.reported.devicemodel='4000x'
String
azureIoTEdgeGenConfig
azureCredentialsId
(optional)
String
defaultPlatform
(optional)
In your .template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.
String
deploymentFilePath
(optional)
String
deploymentManifestFilePath
(optional)
The path of Azure IoT Edge solution .template.json. This file defines the modules and routes in Azure IoT Edge solution, file name must end with .template.json
String
resourceGroup
(optional)
String
rootPath
(optional)
String
azureIoTEdgePush
azureCredentialsId
(optional)
String
resourceGroup
(optional)
String
acrName
(optional)
String
bypassModules
(optional)
List of modules to bypass when building.
You can leave this field empty to build all modules
Or use comma delimited list of modules. Example "ModuleA,ModuleB"
String
defaultPlatform
(optional)
In your .template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.
String
deploymentManifestFilePath
(optional)
The path of Azure IoT Edge solution .template.json. This file defines the modules and routes in Azure IoT Edge solution, file name must end with .template.json
String
dockerRegistryEndpoint
(optional)
url
https://index.docker.io/v1/
).
String
credentialsId
String
dockerRegistryType
(optional)
String
rootPath
(optional)
String
$class: 'ElasticsearchQueryBuilder'
query
String
aboveOrBelow
String
threshold
long
since
long
units
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
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
$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
jobDsl
additionalClasspath
(optional)
String
additionalParameters
(optional)
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 loose 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
publish
boolean
projectId
long
buildId
String
sessionTag
String
appendEnv
boolean
$class: 'ExecuteKatalonStudioTask'
version
String
location
String
executeArgs
String
x11Display
String
xvfbConfiguration
String
$class: 'ExecuteKatalonTestOpsPlan'
apiKey
String
serverUrl
String
projectId
String
plan
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: '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)
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
$class: 'FigletBuilder'
message
String
fileOperations
fileOperations
fileCopyOperation
includes
String
excludes
String
targetLocation
String
flattenFiles
boolean
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
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.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'
fortifyCloudScan
buildId
String
useAutoHeap
boolean
xmx
String
rmiWorkerMaxHeap
String
buildLabel
String
buildProject
String
buildVersion
String
useSsc
boolean
sscToken
String
upToken
String
versionId
String
scanArgs
String
filter
String
noDefaultRules
boolean
disableSourceRendering
boolean
disableSnippets
boolean
quick
boolean
rules
String
useParallelAnalysis
boolean
sensorPool
String
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
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: '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'
genexusb
gxInstallationId
String
kbPath
String
kbVersion
String
kbEnvironment
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
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
$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 slave in Jenkins, setting the environment variable localized files to the workspace avoid collisions accessing gradle cache.
boolean
useWrapper
(optional)
boolean
wrapperLocation
(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
$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
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
$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
quiet
(optional)
boolean
requestBody
(optional)
String
timeout
(optional)
int
uploadFile
(optional)
String
useSystemProperties
(optional)
boolean
validResponseCodes
(optional)
String
validResponseContent
(optional)
String
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
$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
$class: 'InstallBuilder'
apkFile
String
uninstallFirst
boolean
failOnInstallFailure
boolean
$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
advancedProperties
key1=value1
key2=value2
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
$class: 'JbpmUrlResourceBuilder'
url
String
processId
String
SoapUIPro
pathToTestrunner
String
pathToProjectFile
String
environment
(optional)
String
projectPasswor