Pipeline: Basic Steps

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.

Table of Contents

Pipeline: Basic Steps

Pipeline: Basic Steps

View this plugin on the Plugins Index

`catchError`: Catch error and set build result to failure

If the body throws an exception, mark the build as a failure, but nonetheless continue to execute the Pipeline from the statement following the catchError 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)
If an error is caught, the overall build result will be set to this value. Note that the build result can only get worse, so you cannot change the result to 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.
- Type: String
catchInterruptions (optional)
If true, certain types of exceptions that are used to interrupt the flow of execution for Pipelines will be caught and handled by the step. If false, those types of exceptions will be caught and immediately rethrown. Examples of these types of exceptions include those thrown when a build is manually aborted through the UI and those thrown by the timeout step.
- Type: boolean
message (optional)
A message that will be logged to the console if an error is caught. If the stage result is specified, the message will also be associated with that result and may be shown in visualizations.
- Type: String
stageResult (optional)
If an error is caught, the stage result will be set to this value. If a message was specified, the message will be associated with this result. Use SUCCESS or null to keep the stage result from being set when an error is caught.
- Type: String

`deleteDir`: Recursively delete the current directory from the workspace

Recursively deletes the current directory and its contents. Symbolic links and junctions will not be followed but will be removed. To delete a specific directory of a workspace wrap the deleteDir step in a dir step.

`dir`: Change current directory

Change current directory. Any step inside the dir block will use this directory as current and any relative path will use it as base path.

path
- Type: String

`echo`: Print Message

message
- Type: String

`error`: Error signal

Signals an error. Useful if you want to conditionally abort some part of your program. You can also just throw new Exception(), but this step will avoid printing a stack trace.

message
- Type: String

`fileExists`: Verify if file exists in workspace

Checks if the given file (as relative path to current directory) exists. Returns true | false.

file
Relative ( /-separated) path to file within a workspace to verify its existence.
- Type: String

`isUnix`: Checks if running on a Unix-like node

Returns true if enclosing node is running on a Unix-like system (such as Linux or Mac OS X), false if Windows.

`mail`: Mail

Simple step for sending email.

subject
Email subject line.
- Type: String
body
Email body.
- Type: String
bcc (optional)
BCC email address list. Comma separated list of email addresses.
- Type: String
cc (optional)
CC email address list. Comma separated list of email addresses.
- Type: String
charset (optional)
Email body character encoding. Defaults to UTF-8
- Type: String
from (optional)
From email address. Defaults to the admin address globally configured for the Jenkins instance.
- Type: String
mimeType (optional)
Email body MIME type. Defaults to text/plain.
- Type: String
replyTo (optional)
Reploy-To email address. Defaults to the admin address globally configured for the Jenkins instance.
- Type: String
to (optional)
To email address list. Comma separated list of email addresses.
- Type: String

`pwd`: Determine current directory

Returns the current directory path as a string.

tmp (optional)
If selected, return a temporary directory associated with the workspace rather than the workspace itself. This is an appropriate place to put temporary files which should not clutter a source checkout; local repositories or caches; etc.
- Type: boolean

`readFile`: Read file from workspace

Reads a file from a relative path (with root in current directory, usually workspace) and returns its content as a plain string.

file
Relative ( /-separated) path to file within a workspace to read.
- Type: String
encoding (optional)
The encoding to use when reading the file. If left blank, the platform default encoding will be used. Binary files can be read into a Base64-encoded string by specifying "Base64" as the encoding.
- Type: String

`retry`: Retry the body up to N times

Retry the block (up to N times) if any exception happens during its body execution. If an exception happens on the final attempt then it will lead to aborting the build (unless it is caught and processed somehow). User aborts of the build are not caught.

count
- Type: int

`sleep`: Sleep

Simply pauses the Pipeline build until the given amount of time has expired. Equivalent to (on Unix) sh 'sleep …'. May be used to pause one branch of parallel while another proceeds.

time
- Type: int
unit (optional)
- Values: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS

`stash`: Stash some files to be used later in the build

Saves a set of files for use later in the same build, generally on another node/workspace. Stashed files are not otherwise available and are generally discarded at the end of the build. Note that the stash 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
Name of a stash. Should be a simple identifier akin to a job name.
- Type: String
allowEmpty (optional)
- Type: boolean
excludes (optional)
Optional set of Ant-style exclude patterns.
Use a comma separated list to add more than one expression.
If blank, no files will be excluded.
- Type: String
includes (optional)
Optional set of Ant-style include patterns.
Use a comma separated list to add more than one expression.
If blank, treated like **: all files.
The current working directory is the base directory for the saved files, which will later be restored in the same relative locations, so if you want to use a subdirectory wrap this in dir.
- Type: String
useDefaultExcludes (optional)
If selected, use the default excludes from Ant - see here for the list.
- Type: boolean

`step`: General Build Step

This 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

Nested Choice of Objects

$class: 'A3Builder'

project_file
Absolute path to the a³ project file (.apx) containing the analysis items and configuration.
(Note: a³ workspace files (also .apx) are not supported as input.)
- Type: String
analysis_ids
The following values are allowed:
- Comma separated list of analysis IDs. Then only the given analysis items will be executed. Note: The ID must be contained in the apx project and must adhere the analysis ID naming conventions (letters, numbers and underscores only).
- No ID at all (i.e. empty field). Then all analysis items specified in the apx project file will be executed.
- Type: String
pedantic_level
- Type: String
export_a3apxworkspace
Exports the status of a³ at the end of the a³ analysis build step run as a workspace .apx file. This workspace file can later be opened in an interactive run of a³. The result is that the a³ GUI then shows all messages and all results generated by the batch-mode analyses without the need to run these analyses again.
- Type: String
copy_report_file
- Type: boolean
copy_result_file
- Type: boolean
skip_a3_analysis
This switch can be used to deactivate the a³ analysis build step. This switch provides a more convenient method to temporarily deactivate analysis runs than removing the entire build step and reconfiguring the a³ analysis run from scratch when later adding the build step again.
- Type: boolean

$class: 'ACIPluginPublisher'

name
- Type: String
shownOnProjectPage
- Type: boolean

$class: 'ACSDeploymentBuilder'

context
- azureCredentialsId
  The Azure Service Principal credentials used to communicate with the Azure services. Check the following documentation for more information about the service principal:
  - Use portal to create an Azure Active Directory application and service principal that can access resources
  - Type: String
- resourceGroupName
  Resource group of the target Azure Container Service.
  - Type: String
- containerService
  The name of the Azure Container Service. Refer to the following documentation on how to setup Azure Container Service:
  - Deploy Kubernetes cluster for Linux containers
  - Deploy a DC/OS cluster
  - Type: 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.
  - Type: 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.
  - Type: String
- containerRegistryCredentials (optional)
  All the credentials needed for pulling images from private repositories. Specify multiple entries if your deployments need to pull images from multiple, private repositories that require authentication.
  - url
    URL to the Docker registry you are using. May be left blank to use the public DockerHub registry (currently https://index.docker.io/v1/).
    - Type: String
  - credentialsId
    - Type: 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.
  - Type: 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
  - Type: String
- enableConfigSubstitution (optional)
  Substitute variables (in the form $VARIABLE or ${VARIABLE}) in the configuration with values from Jenkins environment variables.
  This allows you to use dynamic values produced during the build in your Kubernetes or DC/OS configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.
  - Type: boolean
- secretName (optional)
  The secret name that you can use in the Kubernetes Deployment configuration for the 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.
  - Type: String
- secretNamespace (optional)
  The Kubernetes namespace in which the secrets will be created with the credentials configured below.
  - Type: String
- swarmRemoveContainersFirst (optional)
  Stop and remove containers first.
  - Type: 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.

Pipeline usage

Signatures:

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

Examples:

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')
atx.publish()

atxName
- Type: String
allowMissing (optional)
- Type: boolean
archiving (optional)
- Type: boolean
atxInstallation (optional)
- name
  - Type: String
- toolName
  - Type: String
- config
  - settings
    - atxBooleanSetting
    - atxTextSetting
  - customSettings
    - atxCustomBooleanSetting
    - atxCustomTextSetting
keepAll (optional)
- Type: boolean
runOnFailed (optional)
- Type: boolean

$class: 'AWSCodeDeployPublisher'

s3bucket
The bucket in S3 where new AWS CodeDeploy revisions will be uploaded.
- Type: String
s3prefix
The prefix in the S3 Bucket to prepend to the AWS CodeDeploy revision. Default is the root of the bucket. You can use environment variables in this field.
- Type: String
applicationName
The name of the AWS CodeDeploy application you wish to deploy to. This plugin assumes that you've already created the application and deployment group. If you haven't already, work through the How to create an Application with AWS CodeDeploy documentation. You can use environment variables in this field.
- Type: String
deploymentGroupName
The name of the AWS CodeDeploy deployment group attached to your application that you want to deploy to. This plugin assumes that you've already created the application and deployment group. If you haven't already, work through the How to create an Application with AWS CodeDeploy documentation.
- Type: String
deploymentConfig
- Type: String
region
- Type: 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
- Type: 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.
- Type: boolean
pollingTimeoutSec
- Type: long
pollingFreqSec
- Type: long
credentials
- Type: String
versionFileName
- Type: String
deploymentMethod
- Type: 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.
- Type: 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.
- Type: 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:
1. Log into the AWS Management Console, and navigate to the Identity and Access Management console.
2. Click on Roles, then click Create New Role.
3. Give an appropriate name for this role (for example, "JenkinsCodeDeployProject").
4. In the "Select Role Type" screen, click "Role for Cross-Account Access" then select Allows IAM users from a 3rd party AWS account to access this account.
5. The account and external IDs for this Jenkins project are listed below
6. In the policy screen, select Custom Policy and copy-paste the following policy:
  - {"Version": "2012-10-17", "Statement": [{"Effect": "Allow", "Action": ["codedeploy:*", "s3:*"], "Resource": "*"}]}
7. Click Create Role, then copy-paste the Role ARN into the below field.
8. Click the Test Connection button to ensure that the permissions are set up properly.
- Type: String
externalId
The External ID you should use in the IAM cross-account access policy.
- Type: String
includes
Includes and Excludes together define the file(s) that will be contained in the application revision that is uploaded to Amazon S3.
- Type: String
proxyHost

Proxy host DNS name
- Type: String
proxyPort

Proxy host port
- Type: int
excludes
Includes and Excludes together define the file(s) that will be contained in the application revision that is uploaded to Amazon S3.
- Type: String
subdirectory
A subdirectory inside the workspace to be packed instead of the whole workspace. Remember that the appspec.yml must be placed at the top of the .zip archive. The excludes and includes will be applied based on this path.
- Type: String

devicefarm

projectName
Name of AWS Device Farm project to use. This can be found in your AWS web console.
Examples:
demoproject
My FireOS Project
My Android Project
- Type: String
devicePoolName
Name of AWS Device Farm device pool to use.
Examples:
Top 10 devices
Top 25 devices
My Custom Tablet Pool
- Type: String
testSpecName
Use the default YAML spec, or select one of your saved YAML spec.
- Type: String
environmentToRun
- Type: String
appArtifact
File pattern (local to workspace) where the newly built application (.apk, .ipa) exists.
Leave it blank when it is a web application.
Examples:
**/build/apk/MyApp-*-debug.apk
/bin/apk/MyApp.apk
- Type: String
runName
Name pattern to name your Device Farm Run. You can also use Jenkins environment variables.
Examples:
SanityTest-${BUILD_TAG}
IntegrationTest-${BUILD_ID}
- Type: String
testToRun
- Type: String
storeResults
- Type: boolean
isRunUnmetered
- Type: boolean
eventCount
- Type: String
eventThrottle
- Type: String
seed
- Type: String
username
- Type: String
password
- Type: String
appiumJavaJUnitTest
- Type: String
appiumJavaTestNGTest
- Type: String
appiumPythonTest
- Type: String
appiumRubyTest
- Type: String
appiumNodeTest
- Type: String
calabashFeatures
File pattern (local to workspace) where Calabash features archive.
Examples:
**/bin/tests/*.zip
/tests/Calabash/features.zip
- Type: String
calabashTags
Comma separated list of tags which will be passed to Calabash.
Examples:
@working
- Type: String
calabashProfile
- Type: String
junitArtifact
File pattern (local to workspace) where the JUnit tests exist.
Examples:
**/build/apk/MyApp-*-tests.apk
/artifacts/MyAppTests.apk
- Type: String
junitFilter
Comma separated list of TestCase/TestSuite names which will be run.
Examples:
Running a single testcase: com.android.foo.FooTest
Running a single test: com.android.foo.FooTest#testFoo
Running multiple tests: com.android.foo.FooTest,com.android.foo.BarTest
- Type: String
uiautomatorArtifact
File pattern (local to workspace) where the UI Automator tests JAR exists.
Examples:
**/build/tests/MyApp-*-tests.jar
/artifacts/MyAppTests.jar
- Type: String
uiautomatorFilter
Comma separated list of TestCase/TestSuite names which will be run.
Examples:
Running a single testcase: com.android.foo.FooTest
Running a single test: com.android.foo.FooTest#testFoo
Running multiple tests: com.android.foo.FooTest,com.android.foo.BarTest
- Type: String
uiautomationArtifact
- Type: String
xctestArtifact
- Type: String
xctestFilter
A test filter string.
Examples:
Running a single test class: "LoginTests"
Running a multiple test classes: "LoginTests,SmokeTests"
Running a single test: "LoginTests/testValid"
Running multiple tests: "LoginTests/testValid,LoginTests/testInvalid"
- Type: String
xctestUiArtifact
- Type: String
xctestUiFilter
- Type: String
appiumVersionJunit
- Type: String
appiumVersionPython
- Type: String
appiumVersionTestng
- Type: String
ifWebApp
- Type: boolean
extraData
- Type: boolean
extraDataArtifact
File pattern (local to workspace) where the extra date file (.zip) exists.
Examples:
**/build/apk/extra-data.zip
- Type: String
deviceLocation
- Type: boolean
deviceLatitude
- Type: double
deviceLongitude
- Type: double
radioDetails
- Type: boolean
ifBluetooth
- Type: boolean
ifWifi
- Type: boolean
ifGPS
- Type: boolean
ifNfc
- Type: boolean
jobTimeoutMinutes
- Type: int
ifVideoRecording
- Type: boolean
ifAppPerformanceMonitoring
- Type: boolean
ignoreRunError
- Type: boolean
ifVpce
- Type: boolean
ifSkipAppResigning
- Type: boolean
vpceServiceName
- Type: String

$class: 'AWSEBDeploymentBuilder'

credentialId
Select the credentials to use.
- Type: String
awsRegion
AWS Region (e.g. us-east-1)
- Type: String
applicationName
AWS EB Application Name (e.g.: "myapp")
- Type: String
environmentName
Optional: AWS EB Environment name(s) to deploy to.

Can accept single or multiple comma-separated values. Examples:
- "my-prod-env" (single environment)
- "my-dev-env,my-staging-env" (multiple environments)
When this value is set and each requested environment exists, an UpdateEnvironment call will be triggered as the Application Version is created.
- Type: String
bucketName

S3 Bucket Name to Upload to (e.g. "my-awseb-apps")

(Optional, will call createStorageLocation if blank)
- Type: String
keyPrefix
Prefix for newly created apps on S3 Bucket. For Example, myapp/builds/myapp-prod-env/
- Type: String
versionLabelFormat
How to set the version label? For instance, for "${GIT_COMMIT}-${BUILD_TAG}", and with "Key Prefix" set to "myapp/builds/myapp-prod-env/", the S3 Object Key is set to myapp/builds/myapp-prod-env/4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41.zip and the version Label will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41 on AWS EB Application Versions
- Type: String
versionDescriptionFormat
How to set the version description? For instance, for "${GIT_COMMIT}", the version Description will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746 on AWS EB Application Versions
- Type: 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:
- File, like target/mywebapp.war: The war file will be uploaded
- A Directory, like '.' or 'target/war': A Zip file will be built and uploaded instead (using includes and excludes).
- Type: String
includes
Optional (if rootObject points to a directory): Glob for Zip Includes, comma-separated like 'target/file,target/myapp/**/*'
- Type: String
excludes
Optional (if rootObject points to a directory): Glob for Zip Excludes, comma-separated eg '**/.git/**/*,**/node_modules/**/*'
- Type: String
zeroDowntime
- Type: boolean
sleepTime
- Type: int
checkHealth
Uncheck this to disable the Health check on deploy. Some implementations may not care to wait until the environment shows "Green".
- Type: boolean
maxAttempts
- Type: int

$class: 'AddTestToSetStep'

domain
HP ALM Domain
- Type: String
project
HP ALM Project name
- Type: String
testPlanPath
Path to a test or test folder in HP ALM which shall be added to a test set
- Type: String
testSetPath
Path to a test set in HP ALM into which test(s) shall be added
- Type: String

alaudaDeleteBuild

buildID (optional)
- Type: String

alaudaStartBuild

buildConfigName (optional)
- Type: String
async (optional)
- Type: boolean
branch (optional)
- Type: String
commitID (optional)
- Type: String
spaceName (optional)
- Type: String

$class: 'AlaudaNotifier'

name (optional)
- Type: String
body (optional)
- Type: String
spaceName (optional)
- Type: String

allure

results
- path
  - Type: String
commandline (optional)
- Type: String
config (optional)
- results
  - path
    - Type: String
- commandline (optional)
  - Type: String
- configPath (optional)
  - Type: String
- includeProperties (optional)
  - Type: boolean
- jdk (optional)
  - Type: String
- properties (optional)
  - key
    - Type: String
  - value
    - Type: String
- reportBuildPolicy (optional)
  - Values: ALWAYS, UNSTABLE, UNSUCCESSFUL
configPath (optional)
- Type: String
disabled (optional)
- Type: boolean
includeProperties (optional)
- Type: boolean
jdk (optional)
- Type: String
properties (optional)
- key
  - Type: String
- value
  - Type: String
report (optional)
- Type: String
reportBuildPolicy (optional)
- Values: ALWAYS, UNSTABLE, UNSUCCESSFUL

$class: 'AnalysisPublisher'

androidLintActivated (optional)
- Type: boolean
canComputeNew (optional)
- Type: boolean
canResolveRelativePaths (optional)
- Type: boolean
canRunOnFailed (optional)
- Type: boolean
checkStyleActivated (optional)
- Type: boolean
defaultEncoding (optional)
- Type: String
dryActivated (optional)
- Type: boolean
failedNewAll (optional)
- Type: String
failedNewHigh (optional)
- Type: String
failedNewLow (optional)
- Type: String
failedNewNormal (optional)
- Type: String
failedTotalAll (optional)
- Type: String
failedTotalHigh (optional)
- Type: String
failedTotalLow (optional)
- Type: String
failedTotalNormal (optional)
- Type: String
findBugsActivated (optional)
- Type: boolean
healthy (optional)
- Type: String
openTasksActivated (optional)
- Type: boolean
pmdActivated (optional)
- Type: boolean
shouldDetectModules (optional)
- Type: boolean
thresholdLimit (optional)
- Type: String
unHealthy (optional)
- Type: String
unstableNewAll (optional)
- Type: String
unstableNewHigh (optional)
- Type: String
unstableNewLow (optional)
- Type: String
unstableNewNormal (optional)
- Type: String
unstableTotalAll (optional)
- Type: String
unstableTotalHigh (optional)
- Type: String
unstableTotalLow (optional)
- Type: String
unstableTotalNormal (optional)
- Type: String
useDeltaValues (optional)
- Type: boolean
usePreviousBuildAsReference (optional)
- Type: boolean
useStableBuildAsReference (optional)
- Type: boolean
warningsActivated (optional)
- Type: boolean

anchore

name
Name of the file that contains a list of container images for anchore to analyze, evaluate policy, and run queries against. The format for each line is "imageId /path/to/Dockerfile", where the Dockerfile is optional. This file must be made available (created by a prior step) to Anchore Container Image Scanner plugin.
- Type: String
anchoreioPass (optional)
Your password for the associated username on https://anchore.io
- Type: String
anchoreioUser (optional)
Your username on https://anchore.io that has access to a custom policy bundle to sync with your local anchore installation
- Type: String
annotations (optional)
- key
  - Type: String
- value
  - Type: String
autoSubscribeTagUpdates (optional)
If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Engine to automatically begin watching the added tag for updates from registry. Default value: 'true'
- Type: boolean
bailOnFail (optional)
If selected or set to 'true', the Anchore Container Image Scanner step will cause the build to fail if the policy evaluation result is FAIL. Default value: 'true'
- Type: boolean
bailOnPluginFail (optional)
If selected or set to 'true', the Anchore Container Image Scanner step will cause the build to fail if the plugin encounters an error. Default value: 'true'
- Type: boolean
bailOnWarn (optional)
If selected or set to 'true', the Anchore Container Image Scanner step will cause the build to fail if the policy check result is WARN. Default value: 'false'
- Type: boolean
bundleFileOverride (optional)
Name of the file that contains a custom anchore policy bundle to be used by Anchore policy evaluation engine. If this file does not exist or the field is left blank, anchore will attempt to use any previously synced/cached policy bundles that you may have, or will fail evaluation if no bundle can be found or used.
- Type: String
doCleanup (optional)
If selected or set to 'true', all images in the input file will be flushed from the Anchore database at the end of plugin execution. Default value: 'false'
- Type: boolean
engineCredentialsId (optional)
- Type: String
engineRetries (optional)
Number of polling attempts spaced at 5 second intervals spent waiting for the Anchore Engine operation to complete.
- Type: String
engineurl (optional)
Anchore Engine URL
- Type: String
engineverify (optional)
- Type: boolean
forceAnalyze (optional)
If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Engine to force analyze the image. Default value: 'false'
- Type: boolean
globalWhiteList (optional)
Name of the file that contains a custom whitelist to be used by Anchore policy evaluation engine. If this file does not exist or the field is left blank, Anchore will use its default global whitelist.
- Type: String
inputQueries (optional)
- query
  Any query that Anchore supports. Results of the query will be added to the anchore report upon plugin completion.
  - Type: String
policyBundleId (optional)
ID of the policy bundle on Anchore Engine to be used for policy evaluations. If empty, the policy bundle marked active on Anchore Engine will be used by default.
- Type: String
policyEvalMethod (optional)
- Type: String
policyName (optional)
Name of the file that contains a custom policy to be used by Anchore policy evaluation engine. If this file does not exist or the field is left blank, Anchore will use its default policy.
- Type: String
useCachedBundle (optional)
Check this in order to use a previously synced policy bundle (if one exists) in the case where login to anchore.io or bundle sync fails for any reason.
- Type: boolean
userScripts (optional)
Optional directory that contains user defined Anchore analyzer/gate/query modules that will be executed in addition to the built in analyzer/gate/queries modules. If this directory does not exist or the field is left blank, Anchore will run only its default modules.
- Type: String

$class: 'AnsibleAdHocCommandBuilder'

hostPattern
The host or set of hosts on which the command will be executed. For more details see the ansible documentation for Patterns.
- Type: String
inventory
- $class: 'InventoryContent'
- $class: 'InventoryDoNotSpecify'
- $class: 'InventoryPath'
module
Module name to execute. The shell module is used when left empty.
- Type: String
command
Module arguments or shell command to execute
- Type: String
additionalParameters (optional)
Any additional parameters to pass to the ansible command.
Warning:
The content of this textbox will be passed as is to the command line.
- Type: String
ansibleName (optional)
- Type: String
becomeUser (optional)
Desired become user. "root" is used when this field is empty.
- Type: String
colorizedOutput (optional)
Check this box to allow ansible to render ANSI color codes in the Jenkins console. This option works well with the Jenkins AnsiColor plugin.
- Type: boolean
credentialsId (optional)
Select the credentials for the SSH connections. Only private key authentication is supported.
- Type: String
disableHostKeyChecking (optional)
Check this box if you really want to disable the validation of the hosts SSH server keys.
- Type: boolean
extraVars (optional)
- hidden (optional)
  - Type: boolean
- key (optional)
  - Type: String
- value (optional)
  - Type: String
forks (optional)
Specify number of parallel processes to use. Set to 0 to use the default value.
- Type: int
hostKeyChecking (optional)
- Type: boolean
sudo (optional)
Run operations with sudo. It works only when the remote user is sudoer with nopasswd option. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- Type: boolean
sudoUser (optional)
Desired sudo user. "root" is used when this field is empty. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- Type: String
unbufferedOutput (optional)
Skip standard output buffering for the ansible process. The ansible output is directly rendered into the Jenkins console. This option can be usefull for long running operations.
- Type: boolean
vaultCredentialsId (optional)
Select the credentials for vault encrypted vars. Only secret file and secret text are supported.
- Type: String

$class: 'AnsiblePlaybookBuilder'

playbook
Path to the ansible playbook file. The path can be absolute or relative to the job workspace.
- Type: String
inventory
- $class: 'InventoryContent'
- $class: 'InventoryDoNotSpecify'
- $class: 'InventoryPath'
additionalParameters (optional)
Any additional parameters to pass to the ansible command.
Warning:
The content of this textbox will be passed as is to the command line.
- Type: String
ansibleName (optional)
- Type: String
becomeUser (optional)
Desired become user. "root" is used when this field is empty.
- Type: String
colorizedOutput (optional)
Check this box to allow ansible to render ANSI color codes in the Jenkins console. This option works well with the Jenkins AnsiColor plugin.
- Type: boolean
credentialsId (optional)
Select the credentials for the SSH connections. Only private key authentication is supported.
- Type: String
disableHostKeyChecking (optional)
Check this box if you really want to disable the validation of the hosts SSH server keys.
- Type: boolean
extraVars (optional)
- hidden (optional)
  - Type: boolean
- key (optional)
  - Type: String
- value (optional)
  - Type: String
forks (optional)
Specify number of parallel processes to use. Set to 0 to use the default value.
- Type: int
hostKeyChecking (optional)
- Type: boolean
limit (optional)
Further limit selected hosts to an additional pattern.
- Type: String
skippedTags (optional)
only run plays and tasks whose tags do not match these values.
- Type: String
startAtTask (optional)
Start the playbook at the task matching this name.
- Type: String
sudo (optional)
Run operations with sudo. It works only when the remote user is sudoer with nopasswd option. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- Type: boolean
sudoUser (optional)
Desired sudo user. "root" is used when this field is empty. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- Type: String
tags (optional)
Only run plays and tasks tagged with these values.
- Type: String
unbufferedOutput (optional)
Skip standard output buffering for the ansible process. The ansible output is directly rendered into the Jenkins console. This option can be usefull for long running operations.
- Type: boolean
vaultCredentialsId (optional)
Select the credentials for vault encrypted vars. Only secret file and secret text are supported.
- Type: String

$class: 'AnsibleVaultBuilder'

action (optional)
Desired vault action.
- Type: String
ansibleName (optional)
- Type: String
content (optional)
Desired encrypted content.
- Type: String
input (optional)
Desired input file to encrypt.
- Type: String
newVaultCredentialsId (optional)
Select the credentials for rekeying vault encrypted files. Only Jenkins secret file and secret text are supported.
- Type: String
output (optional)
Desired output file for encrypted content.
- Type: String
vaultCredentialsId (optional)
Select the credentials for vault encrypted vars. Only Jenkins secret file and secret text are supported.
- Type: String

androidApkUpload

apkFilesPattern (optional)
Specifies filenames or patterns matching one or more APKs that should be uploaded to Google Play.
You can use wildcards like "**/build/outputs/*/*-release.apk".
See the 'includes' attribute of Ant's FileSet for the exact format.
Note that multiple entries must be comma-separated.
The base directory is the build's workspace. You can only upload APKs that are located in your workspace.
Applications which have several APKs per release, taking advantage of Multiple APK Support, must have all of their APKs uploaded together, and all APKs must have the same application identifier (APK package name).
This field supports substituting environment variables in the form ${SOME_VARIABLE} or $SOME_VARIABLE at build time.
- Type: String
deobfuscationFilesPattern (optional)
Specifies filenames or patterns matching one or more ProGuard mapping files that should be uploaded to Google Play, so that it can automatically deobfuscate stacktraces from crash reports.
You can use wildcards like "**/build/**/mapping.txt".
See the 'includes' attribute of Ant's FileSet for the exact format.
Note that multiple entries must be comma-separated.
The base directory is the build's workspace. You can only upload mapping files that are located in your workspace.
If there are multiple APKs being uploaded, and only one mapping.txt file is found, then this file will be associated with each of the APKs being uploaded. If there are multiple mapping.txt files, this plugin will make a basic attempt to associate each mapping file with the corresponding APK.
Otherwise, if the number of mapping files found is not equal to the number of APKs being uploaded, the build will fail, as this situation is not supported.
For more information on deobfuscating crash stacktraces, see the Google Play documentation:
https://support.google.com/googleplay/android-developer/answer/6295281 This field supports substituting environment variables in the form ${SOME_VARIABLE} or $SOME_VARIABLE at build time.
- Type: 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.
Naming
Files must be named in the format [main|patch].<expansion-version>.<application-id>.obb
For example:
- main.1000.com.example.mygame.obb
- patch.1002.com.example.mygame.obb
Patterns
You can use wildcards like "**/build/**/*.obb".
See the 'includes' attribute of Ant's FileSet for the exact format.
Note that multiple entries must be comma-separated.
The base directory is the build's workspace. You can only upload OBB files that are located in your workspace.
Re-using existing expansion files
If you don't provide a main or patch expansion file for every APK that you want to upload, enabling the "Re-use expansion files from existing APKs where necessary" option will automatically associate existing expansion file(s) with the APK(s) being uploaded.
With this option enabled, if not enough expansion files are provided for all of the APK(s) being uploaded, this plugin will search for the newest, previously-uploaded APKs on Google Play with main or patch expansion files, and will associate those files with the new APK(s) being uploaded here.
For example: If you want to upload a new APK, but the expansion files have not changed at all, you should leave the "Expansion files" field blank, but enable the checkbox.
At build time, the latest existing main (and patch, if available) expansion files will be associated with the newly-uploaded APK.
Similarly, if you have a new build, but only want to change the patch file, then just provide the patch expansion file and make sure this option is checked. The uploaded APK will have the existing main expansion file associated with it, along with the newly-uploaded patch file. This field supports substituting environment variables in the form ${SOME_VARIABLE} or $SOME_VARIABLE at build time.
- Type: String
googleCredentialsId (optional)
Specifies which credential to use in order to connect to Google Play.
The selected credential must be a "Google Service Account from private key" — if you have not added one already, refer to the documentation on this plugin's page.
By choosing the "Parameter expression" option, you can also provide a credential at build time, either from an environment variable, or from a build parameter, e.g. the Credentials Parameter type.
But you can use any type of expression, so long as it expands to the name of a "Google Service Account from private key" credential at build time. This field supports substituting environment variables in the form ${SOME_VARIABLE} at build time.
Note that variables in the form $SOME_VARIABLE are not accepted by the Credentials Plugin.
- Type: String
recentChangeList (optional)
You can optionally apply "What's new" text to the uploaded APK(s), in order to inform your user of changes contained in the new app version.
You add entries for as many or as few of your supported language as you wish, but each language must already have been added to your app, under the "Store Listing" section in the Google Play Developer Console.
The language must match the language code shown in the Developer Console, e.g. "en-GB" for British English, or "ar" for Arabic.
The text may be between zero and 500 characters.
For more information on describing what's new in your app, see the Google Play documentation:
https://support.google.com/googleplay/android-developer/answer/189724 Both fields support substituting environment variables in the form ${SOME_VARIABLE} or $SOME_VARIABLE at build time.
- language
  - Type: String
- text
  - Type: String
rolloutPercentage (optional)
The percentage of users in the given track to which the uploaded APK(s) should be rolled out.
If you enter no value here, or 100%, the app will be rolled out to all users.
For more information on staged rollouts, see the Google Play documentation:
https://support.google.com/googleplay/android-developer/answer/3131213 This field supports substituting environment variables in the form ${SOME_VARIABLE} or $SOME_VARIABLE at build time.
- Type: String
trackName (optional)
The release track to which the given APK file(s) will be assigned.
This can be one of:
- internal
- alpha
- beta
- production
For each release track, you have the choice of rolling your new version out to all existing users simultaneously, or doing a staged rollout so that only a fraction of your existing userbase will be able to download the new version.
For more information on internal, alpha and beta testing, or staged rollouts, see the Google Play documentation:
https://support.google.com/googleplay/android-developer/answer/3131213 This field supports substituting environment variables in the form ${SOME_VARIABLE} or $SOME_VARIABLE at build time.
- Type: String
usePreviousExpansionFilesIfMissing (optional)
- Type: boolean

appCenter

apiToken
- Type: String
ownerName
- Type: String
appName
- Type: String
distributionGroups
- Type: String
pathToApp
- Type: String

appscan

scanner
- dynamic_analyzer
- mobile_analyzer
- static_analyzer
name
- Type: String
type
- Type: String
application
- Type: String
credentials
- Type: String
email (optional)
- Type: boolean
failBuild (optional)
- Type: boolean
failBuildNonCompliance (optional)
- Type: boolean
failureConditions (optional)
- failureType
  - Type: String
- threshold
  - Type: int
target (optional)
- Type: String
wait (optional)
- Type: boolean

$class: 'AppScanSourceBuilder'

disableScan
- Type: boolean
applicationFile
- Type: String
acceptSSL
- Type: 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.
- Type: String
installation (optional)
- Type: String

$class: 'AppScanStandardBuilder'

startingURL
Insert the URL that you want AppScan Standard to start scanning from.
Spiders will find the remaining URLs in the domain to be included for scanning.
- Type: String
installation
- Type: String

additionalCommands (optional)

Provide additional and optional commands to run on AppScan Standard CLI.

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

Type: String

authScan (optional)
Checking this option will allow AppScan Stardard to spider and scan a website using authentication, optimizing the results obtained in the report.
If the website contains private information accessed only by logging in this option should be checked and credentials provided to increase dynamic security coverage.
- Type: boolean
authScanPw (optional)
Provide the password corresponding to the account's user name inserted above.
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
- Type: String
authScanRadio (optional)
Check "Recorded Login Sequence" if you have one for the website, this is, for the majority of the cases, the most reliable option for authenticated scanning.
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.
- Type: boolean
authScanUser (optional)
Provide the user name of an account with access to the private functionalities of the website.
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
- Type: String
generateReport (optional)
Check this option if you want AppScan Standard to generate a report after scannning.
The report is available in HTML and PDF.

The HTML report generated is ready to be integrated with the HTML Publisher Plugin.
- Type: boolean
htmlReport (optional)
This report can be integrated with the HTML Publisher Plugin.
- Type: boolean
includeURLS (optional)
This is used to include URLs for scanning,
Some URLs might not be found by AppScan Standard's spiders, include them to get the best possible coverage.
- Type: String
pathRecordedLoginSequence (optional)
Provide the full path to the recorded login sequence file (.login). More info. at: (9.0.3.2 User Guide) Login Management view - Chapter 4 - Configuring - Page 45 http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
- Type: String
pdfReport (optional)
A PDF report is generated.
- Type: boolean
policyFile (optional)
Provide the Path to a Test Policy File (.policy) to determine which type of flaws to scan for.
A Test Policy File can be created following these steps:

"Scan" > "Scan Configuration" > "Test Policy" > "Export".
- Type: String
reportName (optional)
Provide the name to save the report with.
To configure HTML Publisher Plugin properly, the names in the configuration must match.
- Type: String
verbose (optional)
Selecting this option will enable AppScan Standards' verbose, printing the full scan output in Jenkins log.
- Type: boolean

xooa

name
Xooa Jenkins
- Type: String
appId
- Type: 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.
  - Type: String
- customApperianUrl
  - Type: 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.
  - Type: String
- appId
  
  To update an existing app, choose it from this list of native apps currently stored in your Apperian organization.
  - Type: 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.
  - Type: String
- appName
  - Type: String
- shortDescription
  - Type: String
- longDescription
  - Type: String
- author
  - Type: String
- version
  - Type: String
- versionNotes
  - Type: String
- signApp
  - Type: 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.
  - Type: String
- enableApp
  - Type: boolean
- reapplyPolicies
  - Type: boolean

applatix

axUrl
The URL of Applatix system. For example: https://applatix.yourcompany.com
- Type: String
axUsername
Applatix credential: username
- Type: String
axPassword
Applatix credential: password
- Type: String
axServiceTemplateName
- Type: String
axServiceTemplateRepository
The repository where your Service Template is.
- Type: String
axServiceTemplateBranch
The branch where your Service Template is.
- Type: String
axServiceTemplateParameters
The parameters of your Service Template at Applatix system. It is optional. It is in JSON format, for example: {"service": "service_name", "iterations": 3 }
- key
  - Type: String
- value
  - Type: String

$class: 'ApprendaBuilder'

appAlias
The Applicaton Alias to be used.
- Type: String
appName
The Applicaton Name to be used.
- Type: String
versionAlias
The application Version Alias to target.
- Type: String
stage
The desired Apprenda Application lifecycle Stage.
- Type: String
artifactName
The filename of the Apprenda Application Package. For example myapplication.zip.
- Type: String
credentialsId
- Type: String
prefix
The Version Alias prefix to be used. Apprenda will append a number to the prefix to complete the Version Alias.
- Type: String
advVersionAliasToBeForced
The complete Version Alias, including the Version prefix and Version number to be used. For example v23.
- Type: String
advancedNewVersionOption
- Type: String
customPackageDirectory
The full path to the folder that contains the Apprenda Application Package defined in the Artifact Name.
- Type: String
applicationPackageURL
The complete URL to the Apprenda Application Package, starting with http:// or https://.
- Type: String
archiveUploadMethod
- Type: String
buildWithParameters
Check this box if you are using a parameterized project and want the Apprenda build step to do the substitution of variables from parameters.
- Type: boolean

aqua

locationType
- Type: String
registry
Name of a Docker registry that is defined in the Aqua Management Console. E.g. Docker Hub.
- Type: String
register
- Type: boolean
localImage
Path of local Docker image, including tag. E.g. my_ubuntu:latest
- Type: String
hostedImage
Path of Docker image on registry, including tag. E.g. google/mysql:latest
- Type: String
onDisallowed
- Type: String
notCompliesCmd
A shell command to execute when image does not comply with Aqua security policy
- Type: String
hideBase
- Type: boolean
showNegligible
- Type: boolean
policies
Comma separated names of image assurance policies. Available for only for local images and with scanner cli > v3.2.
- Type: String
customFlags
- Type: String

aquaMicroscanner

imageName
- Type: String
onDisallowed
- Type: String
notCompliesCmd
A shell command to execute when image does not comply with Aqua security policy
- Type: String
outputFormat
- Type: String

aquaServerlessScanner

onDisallowed
- Type: String
notCompliesCmd
- Type: String
codeScanPath
- Type: String
customFlags
- Type: String

arachniScanner

url
URL of the system under scan.
- Type: String
checks
Here you can specify a comma separated list with the checks to load. Or leave it blank to load all checks.
- Type: String
scope
- pageLimit
  Set the scope property page_limit. See Arachni Security Scanner Wiki for more information.
  - Type: int
- excludePathPattern
  Set the scope property exclude_path_patterns. See Arachni Security Scanner Wiki for more information.
  - Type: String
userConfig
- filename
  Name of the file with your own configuration in json format. Specify an absolute path or a relative to workspace.
  - Type: String
format
- Type: String

arestocats

metricsDatafilesPattern
- Type: String
resultsDatafilesPattern
- Type: String
numBuilds
- Type: int

archiveArtifacts

Archives the build artifacts (for example, distribution zip files or jar files) so that they can be downloaded later. Archived files will be accessible from the Jenkins webpage.
Normally, Jenkins keeps artifacts for a build as long as a build log itself is kept, but if you don't need old artifacts and would rather save disk space, you can do so.

Note that the Maven job type automatically archives any produced Maven artifacts. Any artifacts configured here will be archived on top of that. Automatic artifact archiving can be disabled under the advanced Maven options.

artifacts
You can use wildcards like 'module/dist/**/*.zip'. See the includes attribute of Ant fileset for the exact format. The base directory is the workspace. You can only archive files that are located in your workspace.
- Type: String
allowEmptyArchive (optional)
Normally, a build fails if archiving returns zero artifacts. This option allows the archiving process to return nothing without failing the build. Instead, the build will simply throw a warning.
- Type: boolean
caseSensitive (optional)
Artifact archiver uses Ant 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.

This option can be used to disable case sensitivity. When it's unchecked, pattern "**/*.HPI" will match any *.hpi files, or pattern "**/cAsEsEnSiTiVe.jar" will match a file called caseSensitive.jar.
- Type: boolean
defaultExcludes (optional)
- Type: boolean
excludes (optional)
Optionally specify the 'excludes' pattern, such as "foo/bar/**/*". A file that matches this mask will not be archived even if it matches the mask specified in 'files to archive' section.
- Type: String
fingerprint (optional)
- Type: boolean
onlyIfSuccessful (optional)
- Type: boolean

$class: 'ArtifactPromotionBuilder'

Here you can configure the artifact promotion plugin for single artifacts. In the first section ( Artifact Information) you enter the coordinates of your artifact.
In the Staging Repository Information section you tell there your source repository is, e.g. http://192.168.56.24/nexus/content/repositories/staging/.
In the following section Release Repository Information, you enter the information about the target repository, e.g. http://192.168.56.24/nexus/content/repositories/releases/. In both sections, you can add user credentials. If you do, the connection to the repository servers will be done using these credentials. If you don't suppot credentials, the access will be done without any authentication.
Both repositorys should be release repositories, not snapshot repos! The password(s) will be saved currently using the standard Jenkins functionality to save those. It's planned to use in the future the credentials plugin.

groupId
- Type: String
artifactId
- Type: String
classifier
- Type: String
version
- Type: String
extension
- Type: String
stagingRepository
- Type: String
stagingUser
- Type: String
stagingPW
- Type: String
releaseUser
- Type: String
releasePW
- Type: String
releaseRepository
- Type: String
promoterClass
- Type: String
debug
- Type: 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.
- Type: 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:

GroupId: This is generally unique amongst an organization or a project.
ArtifactId: The artifactId is generally the name that the project is known by.
Version: The version of the artifact to be resolved. The dynamic definitions 'RELEASE' (the latest release) and 'LATEST' (the latest build) are allowed too.
Classifier: It is some optional and arbitrary string that - if present - is appended to the artifact name just after the version number.
Extension: This is the extension of the artifact to be resolved. Important: this is not always the same as 'packaging' in maven! (although it might be the same e.g. for 'jar')
Target file name: should the file have a different name after downloading? You can also define a subdirectory.

artifacts
- groupId
  - Type: String
- artifactId
  - Type: String
- version
  - Type: String
- classifier (optional)
  - Type: String
- extension (optional)
  - Type: String
- targetFileName (optional)
  - Type: String
enableRepoLogging (optional)
- Type: boolean
failOnError (optional)
- Type: boolean
releaseChecksumPolicy (optional)
- Type: String
releaseUpdatePolicy (optional)
- Type: String
snapshotChecksumPolicy (optional)
- Type: String
snapshotUpdatePolicy (optional)
- Type: String
targetDirectory (optional)
- Type: String

assertthatBddFeatures

projectId
Jira project id.
- Type: String
credentialsId
- Type: String
outputFolder

Output folder for feature files withing workspace. Default ./features/.
By default features are downloaded to the root of the workspace.
- Type: String
jql
- Type: String
mode
- Type: String

assertthatBddReport

projectId
Jira project id.
- Type: String
credentialsId
- Type: String
jsonReportFolder
Cucumber json files folder withing the workspace. The folder where cucumber json is outputted after the tests run. e.g. ./reports/.
By default searching for json files in the root of the workspace.
- Type: String
jsonReportIncludePattern
Pattern for json file names. Default **/*.json
- Type: String
runName
The name of the run. Default 'Test run dd MMM yyyy HH:mm:ss'
- Type: String
type
Report type: Cucumber or Karate
- Type: String

associateTag

nexusInstanceId
- Type: String
tagName
The tag which will be applied to components matching the specified search criteria
- Type: String
search
The search criteria used to locate components on the target Nexus Repository Manager server. For more details, please see Search API
- key
  - Type: String
- value
  - Type: String

$class: 'AstreeBuilder'

dax_file
Absolute path to the DAX file containing the analysis specification and configuration.
Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
Paths and environment variables are evaluated on the machine running Jenkins.
- Type: String
analysis_id
ID of an existing, preconfigured analysis on the Astrée server that serves as a revisioning base for the analyses of the current Jenkins project. The analysis, as configured via the supported DAX file, of a build is imported as a new revision into the project with this ID on the server, if such a project exists. The new revision will become a child revision of the last existing revision. If no project with this ID exists on the server, the analysis will become the first revision of a new project with the specified ID.
Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
- Type: String
output_dir
Absolute path to the folder into which the Summary Reports are to be generated. If left empty, reports will be generated into the project's Workspace directory and will be accessible from the Jenkins web interface.
Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
- Type: String
skip_analysis
This switch can be used to deactivate the Astrée analysis build step. This switch provides a more convenient method to temporarily deactivate analysis runs than removing the entire build step and reconfiguring the Astrée analysis run from scratch when later adding the build step again.
- Type: boolean
genXMLOverview
- Type: boolean
genXMLCoverage
- Type: boolean
genXMLAlarmsByOccurence
- Type: boolean
genXMLAlarmsByCategory
- Type: boolean
genXMLAlarmsByFile
- Type: boolean
genXMLRulechecks
- Type: boolean
dropAnalysis
When this option is activated, the analysis is not stored on the Astrée server, instead it is automatically deleted after the analysis run of the build step.
This option is very helpful if the analysis run is only specified by a DAX file and it is not intended to archive each analysis run on the server.
Please be aware that using this option in an analysis run only specified by an analysis ID will result in deleting the analysis with that ID on the Astrée server.
This option corresponds to adding a --drop to a command line call to Astrée.
- Type: boolean
genPreprocessOutput
- Type: boolean
failonswitch
This option allow Astrée to fail a build depeneding on the types of detected code defects. The following settings are available:
- Only Errors
  ... lets Astrée fail a build if an Error (Definite Type A Alarm) is reported.
  This is the preferred setting for most use cases. A build is failed if Astrée can formally show the presence of a severe code defect in a (analysis) context.
- Errors and Alarms
  ... lets Astrée fail a build if an Error or Alarm (Definite Type A Alarm or Potential Alarm of Type B or Type C) is reported.
  This is the preferred setting in case the absence of runtime errors in an application is to be formally shown. A build is failed if Astrée reports potential runtime errors.
- Errors, Alarms, and Data-Flow Anomalies
  ... lets Astrée fail a build if and only if any type of alarm (definite/potential Type A, B, C or D) is reported.
  This setting fails builds on any reported potential code defect or anomaly.
- failon
  - Type: String

azureCLI

principalCredentialId
The Service Principal credentials required to connect to your Azure account.
More information can be found here: https://github.com/Azure/azure-devops-utils#user-content-create-service-principal
If you want to add an Azure credential click "Add" and select "Microsoft Azure Service Principal" from the Kind drop-down.
If you want to remove existing Azure credentials you must go to the Credentials Dashboard.
- Type: String
commands
- script
  - Type: String
- exportVariablesString
  Export the output of the command to environment variables
  The format: /"variable from JSON" | "desired environment variable name"
  For example: Output: { "id": "/subscriptions/some-guid/resourceGroups/test", "location": "northeurope", "managedBy": null, "name": "test", "properties": { "provisioningState": "Succeeded" }, "tags": null } Environment Variable String: /location|LOCATION , /name|NAME
  - Type: String

azureDownload

storageCredentialId
- Type: String
downloadType
- Type: String
buildSelector (optional)
- downstream
- lastWithArtifacts
- lastCompleted
- $class: 'MultiJobBuildSelector'
- buildParameter
- permalink
- $class: 'PromotedBuildSelector'
- latestSavedBuild
- specific
- lastSuccessful
- upstream
- workspace
containerName (optional)
Enter a storage container name.
Environment variables can also be referenced.
For example: ${JOB_NAME}
- Type: String
deleteFromAzureAfterDownload (optional)
If checked, the file copy on Azure will be removed after it's downloaded to local.
- Type: boolean
downloadDirLoc (optional)
Enter a download path. If not specified, the files will be downloaded into the job's workspace.
Environment variables can also be referenced, for example: ${JOB_NAME} If "Flatten Directories" is checked, this directory will contain all outputs.
- Type: String
excludeFilesPattern (optional)
Enter a pattern of blobs to exclude from the download. Ant fileset syntax. Leaving blank will download the entire container. Environment variables can also be referenced.
For example: ${JOB_NAME}
- Type: String
fileShare (optional)
Enter a Azure File Storage Share name.
Environment variables can also be referenced.
For example: ${JOB_NAME}
- Type: String
flattenDirectories (optional)
If checked, all files specified for download will be flattened to the single download directory. If two files are named the same in different directories, only one will remain.
- Type: boolean
includeArchiveZips (optional)
The archive zip files generated (archive.zip in the root of the container/virtual path) are typically excluded from download. Check this to enable downloading of the archive zip.
- Type: boolean
includeFilesPattern (optional)
Enter a pattern of blobs to download. Ant fileset syntax. Environment variables can also be referenced.
For example: ${JOB_NAME}
- Type: String
projectName (optional)
The name of the project to download the managed artifact from.
- Type: String

$class: 'BapFtpPromotionPublisherPlugin'

Send build artifacts over FTP as a build step during a promotion process

publishers

Array/List

Nested Object

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.
- Type: String
verbose
Select to enable logging of all commands sent to, and responses received from the FTP server in the Jenkins console.
- Type: boolean

transfers

Array/List

Nested Object

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.
- Type: 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)
- Type: 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.
- Type: 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.
- Type: 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.
- Type: 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`

Type: 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.
- Type: boolean
cleanRemote

Select to delete all files and directories within the remote directory before transferring files.
- Type: boolean
noDefaultExcludes
- Type: 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.
- Type: 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.
- Type: 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
- Type: 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.
- Type: 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
  The number of times to retry this server in the event of failure
  - Type: int
- retryDelay
  The time to wait, in milliseconds, before attempting another transfer
  - Type: 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
  - Type: String
ftpCredentials
Set the username and password to use with this connection.
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
  - Type: String
- password
  - Type: String

continueOnError
- Type: boolean
failOnError
- Type: boolean
alwaysPublishFromMaster
- Type: boolean
masterNodeName
- Type: String
paramPublish
- parameterName
  The name of the parameter or environment variable that will contain the expression for matching the labels.
  - Type: String

ftpPublisher

Send build artifacts over FTP

publishers

Array/List

Nested Object

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.
- Type: String
verbose
Select to enable logging of all commands sent to, and responses received from the FTP server in the Jenkins console.
- Type: boolean

transfers

Array/List

Nested Object

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.
- Type: 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)
- Type: 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.
- Type: 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.
- Type: 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.
- Type: boolean

remoteDirectorySDF

Select this to include the timestamp in the remote directory.

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`

Type: 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.
- Type: boolean
cleanRemote

Select to delete all files and directories within the remote directory before transferring files.
- Type: boolean
noDefaultExcludes
- Type: 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.
- Type: 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.
- Type: 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
- Type: 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.
- Type: 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
  The number of times to retry this server in the event of failure
  - Type: int
- retryDelay
  The time to wait, in milliseconds, before attempting another transfer
  - Type: 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
  - Type: String
ftpCredentials
Set the username and password to use with this connection.
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
  - Type: String
- password
  - Type: String

continueOnError
Select to continue publishing to the other FTP servers after a problem with a previous server
- Type: boolean
failOnError
Select to mark the build as a failure if there is a problem publishing to a server. The default is to mark the build as unstable
- Type: 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.
- Type: 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.
- Type: String
paramPublish
- parameterName
  The name of the parameter or environment variable that will contain the expression for matching the labels.
  - Type: String

$class: 'BapSshPromotionPublisherPlugin'

Send files or execute commands over SSH as a build step during a promotion process

publishers

Array/List

Nested Object

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.
- Type: String
verbose
Select to enable an obscene amount of information to the Jenkins console - only really useful to help track down problems
- Type: boolean

transfers

Array/List

Nested Object

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.
- Type: 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)
- Type: 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.
- Type: 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.
- Type: String

remoteDirectorySDF

Select this to include the timestamp in the remote directory.

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`

Type: 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.
- Type: boolean
cleanRemote
- Type: boolean
noDefaultExcludes
- Type: 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.
- Type: 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.
- Type: 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.
- Type: String
execTimeout (optional)

Timeout in milliseconds for the Exec command

Set to zero to disable.
- Type: 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.

Type: 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.

Type: 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
- Type: 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.
- Type: 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
  The number of times to retry this server in the event of failure
  - Type: int
- retryDelay
  The time to wait, in milliseconds, before attempting another transfer
  - Type: 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
  - Type: String
sshCredentials
Set the credentials to use with this connection.
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
  The username to connect with.
  - Type: String
- encryptedPassphrase
  The passphrase for the private key, or the password for password authentication if no Key or Path to key is configured.
  Leave blank if the key is not encrypted.
  - Type: String
- key
  
  The private key.
  
  Paste the private key here, or provide the path to the file containing the key in Path to key.
  - Type: 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
  - Type: String

continueOnError
- Type: boolean
failOnError
- Type: boolean
alwaysPublishFromMaster
- Type: boolean
masterNodeName
- Type: String
paramPublish
- parameterName
  The name of the parameter or environment variable that will contain the expression for matching the labels.
  - Type: String

sshPublisher

Send files or execute commands over SSH

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.
- Type: boolean
continueOnError (optional)
Select to continue publishing to the other servers after a problem with a previous server
- Type: boolean
failOnError (optional)
Select to mark the build as a failure if there is a problem publishing to a server. The default is to mark the build as unstable
- Type: 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.
- Type: String
paramPublish (optional)
- parameterName
  The name of the parameter or environment variable that will contain the expression for matching the labels.
  - Type: String

publishers (optional)

Array/List

Nested Object

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.
- Type: String
verbose
Select to enable an obscene amount of information to the Jenkins console - only really useful to help track down problems
- Type: boolean

transfers

Array/List

Nested Object

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.
- Type: 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)
- Type: 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.
- Type: 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.
- Type: String

remoteDirectorySDF

Select this to include the timestamp in the remote directory.

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`

Type: 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.
- Type: boolean
cleanRemote
- Type: boolean
noDefaultExcludes
- Type: 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.
- Type: 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.
- Type: 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.
- Type: String
execTimeout (optional)

Timeout in milliseconds for the Exec command

Set to zero to disable.
- Type: 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.

Type: 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.

Type: 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
- Type: 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.
- Type: 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
  The number of times to retry this server in the event of failure
  - Type: int
- retryDelay
  The time to wait, in milliseconds, before attempting another transfer
  - Type: 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
  - Type: String
sshCredentials
Set the credentials to use with this connection.
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
  The username to connect with.
  - Type: String
- encryptedPassphrase
  The passphrase for the private key, or the password for password authentication if no Key or Path to key is configured.
  Leave blank if the key is not encrypted.
  - Type: String
- key
  
  The private key.
  
  Paste the private key here, or provide the path to the file containing the key in Path to key.
  - Type: 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
  - Type: String

$class: 'BeaglePlugin'

apptoken

Generate your Application Token From Beagle

Home -> Applications -> Select your Application -> Settings -> Application Token
usertoken

Generate your User Token From Beagle User Settings

Settings -> Access Token -> Generate Your New Personal Access Token

benchmark

filepath
Please insert a filepath.
- Type: 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
Location of the result files relative to the workspace.
The locations may include wildcards using the character "*".
JSON and XML formats supported. Must match the selected schema format.
Create a list of locations in a file with the "*.list" extension.
- Type: String
schemaSelection
The schema defines the content of the result files.
JSON and XML formats supported.
Note: xUnit is an XML format.
- Type: String
truncateStrings
Truncate strings to 512 characters. Strongly suggested. Affects storage processing and loading time.
- Type: boolean
altInputSchema
Custom schema. JSON and XML formats supported.
- Type: String
altInputSchemaLocation
Location of custom schema relative to the workspace.
JSON and XML formats supported.
- Type: String
thresholds (optional)
This field is meant to define additional result thresholds, not located inside the result file.

$class: 'BitbucketPublisher'

serverUrl (optional)
Bitbucket Server Url.
- Type: String
credentialsId (optional)
Credentials for bitucket server. The user must have access to create project and repository.
- Type: String
projectKey (optional)
Input the project key for the bitbucket.
- Type: String
createProject (optional)
Check this if you want to create the bitbucket project.
- projectName
  - Type: String
- projectUsers
  - Type: String
- projectGroups
  - Type: String
createJenkinsJobs (optional)
Check this if you want to use the bitbucket post commit external hook to call.
- ciServer
  - Type: String
projectName (optional)
Input name of the Bitbucket project.
- Type: String

$class: 'BlueprintLaunch'

projectName

Project selection is mandatory.
- Type: String
blueprintName

Blueprint selection is mandatory.
- Type: 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.
- Type: String
appProfileName

Application Profile selection is mandatory.
- Type: 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.
- Type: 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.
- Type: String
waitForSuccessFulLaunch
- Type: boolean
blueprintDescription

Description is fetched from the selected Calm blueprint
- Type: String

$class: 'BrakemanPublisher'

outputFile
- Type: String
canComputeNew (optional)
- Type: boolean
canResolveRelativePaths (optional)
- Type: boolean
canRunOnFailed (optional)
- Type: boolean
defaultEncoding (optional)
- Type: String
failedNewAll (optional)
- Type: String
failedNewHigh (optional)
- Type: String
failedNewLow (optional)
- Type: String
failedNewNormal (optional)
- Type: String
failedTotalAll (optional)
- Type: String
failedTotalHigh (optional)
- Type: String
failedTotalLow (optional)
- Type: String
failedTotalNormal (optional)
- Type: String
healthy (optional)
- Type: String
shouldDetectModules (optional)
- Type: boolean
thresholdLimit (optional)
- Type: String
unHealthy (optional)
- Type: String
unstableNewAll (optional)
- Type: String
unstableNewHigh (optional)
- Type: String
unstableNewLow (optional)
- Type: String
unstableNewNormal (optional)
- Type: String
unstableTotalAll (optional)
- Type: String
unstableTotalHigh (optional)
- Type: String
unstableTotalLow (optional)
- Type: String
unstableTotalNormal (optional)
- Type: String
useDeltaValues (optional)
- Type: boolean
usePreviousBuildAsReference (optional)
- Type: boolean
useStableBuildAsReference (optional)
- Type: boolean

buildDescription

Normally, build description is empty, but it can be changed by setting what name new build gets. This field can contain macros.

descriptionTemplate
- Type: String

buildName

Normally, builds are named by their sequential numbers, but you can change that here by setting what name new build gets. This field can contain macros.

nameTemplate
- Type: String

crxBuild

Create and build a content package on CRX by specifying a workspace filter, and then download it to the workspace to get archived as a backup, or as the beginning of a magical content package adventure, full of drama, suspense, and deployments to lower environments!

packageId (optional)
Specify a list of package IDs to replicate from each specified Base URL. Each package ID string must occupy its own line.

A Package ID consists of the group, the name, and the version of a package, separated by colons (':'), as in: "group:name:version". The version may be omitted.

This field supports parameter tokens.
- Type: String
baseUrl (optional)
Specify the base URL of the Adobe Granite server, including hostname and port. The CRX Package Manager service path will be appended to this value for all requests. For example, http://localhost:4502 or https://author.mycorp.com, etc.

If login credentials for the server are different than those configured in the Connection Options section, you may override them in the Base URL by inserting username[:password]@ between the scheme and the hostname.

For example, to override the Username without changing the associated password or private key, you may use the following form:

http:// deployer@localhost:4502

To override the credentials completely, provide a username and password (which may be provided by an encrypted parameter) by separating them with a colon, as shown below:
http:// deployer:Password123@localhost:4502

This field supports parameter tokens.
- Type: String
credentialsId (optional)
Select the login credentials for authenticating requests to the CRX server.

[Signature] credentials may be used if the target server supports HTTP Signature Authentication using the keyId format, /$username/keys/$fingerprint.

Select "-none-" to use the default credentials set in the global CRX Content Package Deployer - HTTP Client configuration.
- Type: String
download (optional)
Check this box to download the package after building it.
- Type: boolean
localDirectory (optional)
Specify a path relative to the workspace where the package will be downloaded (if the "Download" box is checked).

This field supports parameter tokens.
- Type: String
requestTimeout (optional)
Specify the timeout in milliseconds to wait for a response for each individual request. Specify a value of 0 to use default behavior.
- Type: long
serviceTimeout (optional)
Specify the timeout in milliseconds to wait for PackageManager service availability between sending POST requests. Specify a value of 0 to use default behavior.
- Type: long
waitDelay (optional)
Specify a delay in milliseconds before calls to check for Package Manager service availability. Increase this value if a /crx/packmgr node is sometimes created in the repository by this step, indicating that the Package Manager servlet was brought down for bundle installation AFTER a successful check for service availability, but BEFORE the next POST request was sent. What happens is that the SlingPostServlet takes over when the crx-packagemgr bundle is refreshed and creates nodes for any POST requests that it handles. Increasing this delay gives more time for the bundle refresh process to begin on the server.
- Type: long
wspFilter (optional)
Specify a package workspace filter in a simple text format that will be applied to the package before build. This defines what content will be captured by the package.

Simple spec is defined simply as a line-by-line format where:
- each line consists of significant text before an optional comment character (#)
- each line that begins with a "/" begins a new filter root.
- the first non-empty, non-comment line must define a new filter root
- each non-empty, non-comment line after a filter root that begins with a "+" or "-" defines an include or exclude rule, respectively. Everything following the "+" or "-" must be a valid regular expression
Content is "covered" by a filter root if the content path starts with, or is the same as the filter root path. Once the "covering" filter root is identified, its include/exclude rules are evaluated from top to bottom, by matching the content path against each rule pattern (which is a Java regular expression). The last rule whose pattern matches the content path defines whether that content is included (line starts with "+") or excluded (line starts with "-"). If no rules are defined, all content covered by that root path is included

For example, to include everything under /etc except for packages:
```
        /etc                 # define /etc as the filter root
        +/etc(/.*)?          # include everything under /etc
        -/etc/packages(/.)?  # exclude package paths
    
```
To 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 code
    
```
This field supports parameter tokens.
- Type: String

$class: 'BuildScanner'

Trigger automated Acunetix scans as part of your web application's build process

profile
The Scan Type used to scan the target
- Type: String
target
The Scan Target on which to run a scan (excludes Targets requiring Manual Intervention)
- Type: String
repTemp
Generate a Report after the scan completes. The report download link will be provided in the job console output
- Type: String
threat
The Threat Level (High, Medium, Low) to fail the build on
- Type: String
stopScan
If selected, the scan will be stopped if the build fails (Threat Level is reached)
- Type: boolean

$class: 'BuildStepsFromJsonBuilder'

buildStep

Nested Choice of Objects

$class: 'A3Builder'

project_file
Absolute path to the a³ project file (.apx) containing the analysis items and configuration.
(Note: a³ workspace files (also .apx) are not supported as input.)
- Type: String
analysis_ids
The following values are allowed:
- Comma separated list of analysis IDs. Then only the given analysis items will be executed. Note: The ID must be contained in the apx project and must adhere the analysis ID naming conventions (letters, numbers and underscores only).
- No ID at all (i.e. empty field). Then all analysis items specified in the apx project file will be executed.
- Type: String
pedantic_level
- Type: String
export_a3apxworkspace
Exports the status of a³ at the end of the a³ analysis build step run as a workspace .apx file. This workspace file can later be opened in an interactive run of a³. The result is that the a³ GUI then shows all messages and all results generated by the batch-mode analyses without the need to run these analyses again.
- Type: String
copy_report_file
- Type: boolean
copy_result_file
- Type: boolean
skip_a3_analysis
This switch can be used to deactivate the a³ analysis build step. This switch provides a more convenient method to temporarily deactivate analysis runs than removing the entire build step and reconfiguring the a³ analysis run from scratch when later adding the build step again.
- Type: boolean

$class: 'ACSDeploymentBuilder'

context
- azureCredentialsId
  The Azure Service Principal credentials used to communicate with the Azure services. Check the following documentation for more information about the service principal:
  - Use portal to create an Azure Active Directory application and service principal that can access resources
  - Type: String
- resourceGroupName
  Resource group of the target Azure Container Service.
  - Type: String
- containerService
  The name of the Azure Container Service. Refer to the following documentation on how to setup Azure Container Service:
  - Deploy Kubernetes cluster for Linux containers
  - Deploy a DC/OS cluster
  - Type: 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.
  - Type: 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.
  - Type: String
- containerRegistryCredentials (optional)
  All the credentials needed for pulling images from private repositories. Specify multiple entries if your deployments need to pull images from multiple, private repositories that require authentication.
  - url
    URL to the Docker registry you are using. May be left blank to use the public DockerHub registry (currently https://index.docker.io/v1/).
    - Type: String
  - credentialsId
    - Type: 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.
  - Type: 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
  - Type: String
- enableConfigSubstitution (optional)
  Substitute variables (in the form $VARIABLE or ${VARIABLE}) in the configuration with values from Jenkins environment variables.
  This allows you to use dynamic values produced during the build in your Kubernetes or DC/OS configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.
  - Type: boolean
- secretName (optional)
  The secret name that you can use in the Kubernetes Deployment configuration for the 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.
  - Type: String
- secretNamespace (optional)
  The Kubernetes namespace in which the secrets will be created with the credentials configured below.
  - Type: String
- swarmRemoveContainersFirst (optional)
  Stop and remove containers first.
  - Type: boolean

$class: 'AWSEBBuilder'

extensions
- awsRegion
  AWS Region (e.g. us-east-1) This will be the default if no valid environments are provided in the Regions field.
  - Values: 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
  AWS Region (e.g. us-east-1) Needs to match an environment name. If one is missing, write an issue so we can update the aws sdk.
  - Type: String
- credentialsString
  - Type: String
- credentialsText
  Use a credentials name that will be resolved during the build.
  - Type: String
- applicationName
  AWS EB Application Name (e.g.: "myapp")
  - Type: String
- versionLabelFormat
  How to set the version label? For instance, for "${GIT_COMMIT}-${BUILD_TAG}", and with "Key Prefix" set to "myapp/builds/myapp-prod-env/", the S3 Object Key is set to myapp/builds/myapp-prod-env/4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41.zip and the version Label will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41 on AWS EB Application Versions
  - Type: String
- failOnError
  If any of the environments fail to update, or if there are no matching environments then fail the build.
  - Type: boolean
- extensions
  - $class: 'AWSEBElasticBeanstalkSetup'
  - $class: 'AWSEBS3Setup'
  - $class: 'ByName'
  - $class: 'ByUrl'
- envLookup
  - $class: 'AWSEBElasticBeanstalkSetup'
  - $class: 'AWSEBS3Setup'
  - $class: 'ByName'
  - $class: 'ByUrl'

$class: 'AWSEBDeploymentBuilder'

credentialId
Select the credentials to use.
- Type: String
awsRegion
AWS Region (e.g. us-east-1)
- Type: String
applicationName
AWS EB Application Name (e.g.: "myapp")
- Type: String
environmentName
Optional: AWS EB Environment name(s) to deploy to.

Can accept single or multiple comma-separated values. Examples:
- "my-prod-env" (single environment)
- "my-dev-env,my-staging-env" (multiple environments)
When this value is set and each requested environment exists, an UpdateEnvironment call will be triggered as the Application Version is created.
- Type: String
bucketName

S3 Bucket Name to Upload to (e.g. "my-awseb-apps")

(Optional, will call createStorageLocation if blank)
- Type: String
keyPrefix
Prefix for newly created apps on S3 Bucket. For Example, myapp/builds/myapp-prod-env/
- Type: String
versionLabelFormat
How to set the version label? For instance, for "${GIT_COMMIT}-${BUILD_TAG}", and with "Key Prefix" set to "myapp/builds/myapp-prod-env/", the S3 Object Key is set to myapp/builds/myapp-prod-env/4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41.zip and the version Label will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41 on AWS EB Application Versions
- Type: String
versionDescriptionFormat
How to set the version description? For instance, for "${GIT_COMMIT}", the version Description will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746 on AWS EB Application Versions
- Type: 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:
- File, like target/mywebapp.war: The war file will be uploaded
- A Directory, like '.' or 'target/war': A Zip file will be built and uploaded instead (using includes and excludes).
- Type: String
includes
Optional (if rootObject points to a directory): Glob for Zip Includes, comma-separated like 'target/file,target/myapp/**/*'
- Type: String
excludes
Optional (if rootObject points to a directory): Glob for Zip Excludes, comma-separated eg '**/.git/**/*,**/node_modules/**/*'
- Type: String
zeroDowntime
- Type: boolean
sleepTime
- Type: int
checkHealth
Uncheck this to disable the Health check on deploy. Some implementations may not care to wait until the environment shows "Green".
- Type: boolean
maxAttempts
- Type: int

$class: 'ActionHubPlugin'

$class: 'AddTestToSetStep'

domain
HP ALM Domain
- Type: String
project
HP ALM Project name
- Type: String
testPlanPath
Path to a test or test folder in HP ALM which shall be added to a test set
- Type: String
testSetPath
Path to a test set in HP ALM into which test(s) shall be added
- Type: String

$class: 'AmxEclipseAntBuilder'

targets
Specify a list of Ant targets to be invoked over Tibco amx_eclipse_ant wrapper, or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
- Type: String
name
For projects that need to use TIBCO amx_eclipse_ant wrapper as the build system. This causes Jenkins to invoke amx_eclipse_ant with the given targets and options. Any non-zero exit code causes Jenkins to mark the build as a failure.
Jenkins supplies some environment variables that can be used from within the build script.
- Type: String
antOpts
If your build requires a custom ANT_OPTS, specify it here. Please refer to TIBCO Documentation for any detail
- Type: String
buildFile
If your build requires a custom -buildfile, specify it here. By default amx_eclipse_ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory. Please refer to TIBCO Documentation for any detail
- Type: String
properties
Properties needed by your ant build can be specified here (in standard properties file format):
```
# comment
name1=value1
name2=$VAR2
```
These 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
- Type: String
amxEclipseAntTra
If your build requires a custom TRA properties file, specify it here. Please refer to TIBCO Documentation for any detail.
- Type: String
businessStudioWs
If your build requires a custom Business Studio workspace to use, specify it here. By default amx_eclipse_ant use user home as location for "workspace"" creation. this option force amx_eclipse_ant to use a custom workspace by flag "-data 'your-custom-ws'" Please refer to TIBCO Documentation for any detail.
- Type: String

anchore

name
Name of the file that contains a list of container images for anchore to analyze, evaluate policy, and run queries against. The format for each line is "imageId /path/to/Dockerfile", where the Dockerfile is optional. This file must be made available (created by a prior step) to Anchore Container Image Scanner plugin.
- Type: String
anchoreioPass (optional)
Your password for the associated username on https://anchore.io
- Type: String
anchoreioUser (optional)
Your username on https://anchore.io that has access to a custom policy bundle to sync with your local anchore installation
- Type: String
annotations (optional)
- key
  - Type: String
- value
  - Type: String
autoSubscribeTagUpdates (optional)
If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Engine to automatically begin watching the added tag for updates from registry. Default value: 'true'
- Type: boolean
bailOnFail (optional)
If selected or set to 'true', the Anchore Container Image Scanner step will cause the build to fail if the policy evaluation result is FAIL. Default value: 'true'
- Type: boolean
bailOnPluginFail (optional)
If selected or set to 'true', the Anchore Container Image Scanner step will cause the build to fail if the plugin encounters an error. Default value: 'true'
- Type: boolean
bailOnWarn (optional)
If selected or set to 'true', the Anchore Container Image Scanner step will cause the build to fail if the policy check result is WARN. Default value: 'false'
- Type: boolean
bundleFileOverride (optional)
Name of the file that contains a custom anchore policy bundle to be used by Anchore policy evaluation engine. If this file does not exist or the field is left blank, anchore will attempt to use any previously synced/cached policy bundles that you may have, or will fail evaluation if no bundle can be found or used.
- Type: String
doCleanup (optional)
If selected or set to 'true', all images in the input file will be flushed from the Anchore database at the end of plugin execution. Default value: 'false'
- Type: boolean
engineCredentialsId (optional)
- Type: String
engineRetries (optional)
Number of polling attempts spaced at 5 second intervals spent waiting for the Anchore Engine operation to complete.
- Type: String
engineurl (optional)
Anchore Engine URL
- Type: String
engineverify (optional)
- Type: boolean
forceAnalyze (optional)
If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Engine to force analyze the image. Default value: 'false'
- Type: boolean
globalWhiteList (optional)
Name of the file that contains a custom whitelist to be used by Anchore policy evaluation engine. If this file does not exist or the field is left blank, Anchore will use its default global whitelist.
- Type: String
inputQueries (optional)
- query
  Any query that Anchore supports. Results of the query will be added to the anchore report upon plugin completion.
  - Type: String
policyBundleId (optional)
ID of the policy bundle on Anchore Engine to be used for policy evaluations. If empty, the policy bundle marked active on Anchore Engine will be used by default.
- Type: String
policyEvalMethod (optional)
- Type: String
policyName (optional)
Name of the file that contains a custom policy to be used by Anchore policy evaluation engine. If this file does not exist or the field is left blank, Anchore will use its default policy.
- Type: String
useCachedBundle (optional)
Check this in order to use a previously synced policy bundle (if one exists) in the case where login to anchore.io or bundle sync fails for any reason.
- Type: boolean
userScripts (optional)
Optional directory that contains user defined Anchore analyzer/gate/query modules that will be executed in addition to the built in analyzer/gate/queries modules. If this directory does not exist or the field is left blank, Anchore will run only its default modules.
- Type: String

$class: 'AnsibleAdHocCommandBuilder'

hostPattern
The host or set of hosts on which the command will be executed. For more details see the ansible documentation for Patterns.
- Type: String
inventory
- $class: 'InventoryContent'
- $class: 'InventoryDoNotSpecify'
- $class: 'InventoryPath'
module
Module name to execute. The shell module is used when left empty.
- Type: String
command
Module arguments or shell command to execute
- Type: String
additionalParameters (optional)
Any additional parameters to pass to the ansible command.
Warning:
The content of this textbox will be passed as is to the command line.
- Type: String
ansibleName (optional)
- Type: String
becomeUser (optional)
Desired become user. "root" is used when this field is empty.
- Type: String
colorizedOutput (optional)
Check this box to allow ansible to render ANSI color codes in the Jenkins console. This option works well with the Jenkins AnsiColor plugin.
- Type: boolean
credentialsId (optional)
Select the credentials for the SSH connections. Only private key authentication is supported.
- Type: String
disableHostKeyChecking (optional)
Check this box if you really want to disable the validation of the hosts SSH server keys.
- Type: boolean
extraVars (optional)
- hidden (optional)
  - Type: boolean
- key (optional)
  - Type: String
- value (optional)
  - Type: String
forks (optional)
Specify number of parallel processes to use. Set to 0 to use the default value.
- Type: int
hostKeyChecking (optional)
- Type: boolean
sudo (optional)
Run operations with sudo. It works only when the remote user is sudoer with nopasswd option. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- Type: boolean
sudoUser (optional)
Desired sudo user. "root" is used when this field is empty. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- Type: String
unbufferedOutput (optional)
Skip standard output buffering for the ansible process. The ansible output is directly rendered into the Jenkins console. This option can be usefull for long running operations.
- Type: boolean
vaultCredentialsId (optional)
Select the credentials for vault encrypted vars. Only secret file and secret text are supported.
- Type: String

$class: 'AnsiblePlaybookBuilder'

playbook
Path to the ansible playbook file. The path can be absolute or relative to the job workspace.
- Type: String
inventory
- $class: 'InventoryContent'
- $class: 'InventoryDoNotSpecify'
- $class: 'InventoryPath'
additionalParameters (optional)
Any additional parameters to pass to the ansible command.
Warning:
The content of this textbox will be passed as is to the command line.
- Type: String
ansibleName (optional)
- Type: String
becomeUser (optional)
Desired become user. "root" is used when this field is empty.
- Type: String
colorizedOutput (optional)
Check this box to allow ansible to render ANSI color codes in the Jenkins console. This option works well with the Jenkins AnsiColor plugin.
- Type: boolean
credentialsId (optional)
Select the credentials for the SSH connections. Only private key authentication is supported.
- Type: String
disableHostKeyChecking (optional)
Check this box if you really want to disable the validation of the hosts SSH server keys.
- Type: boolean
extraVars (optional)
- hidden (optional)
  - Type: boolean
- key (optional)
  - Type: String
- value (optional)
  - Type: String
forks (optional)
Specify number of parallel processes to use. Set to 0 to use the default value.
- Type: int
hostKeyChecking (optional)
- Type: boolean
limit (optional)
Further limit selected hosts to an additional pattern.
- Type: String
skippedTags (optional)
only run plays and tasks whose tags do not match these values.
- Type: String
startAtTask (optional)
Start the playbook at the task matching this name.
- Type: String
sudo (optional)
Run operations with sudo. It works only when the remote user is sudoer with nopasswd option. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- Type: boolean
sudoUser (optional)
Desired sudo user. "root" is used when this field is empty. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- Type: String
tags (optional)
Only run plays and tasks tagged with these values.
- Type: String
unbufferedOutput (optional)
Skip standard output buffering for the ansible process. The ansible output is directly rendered into the Jenkins console. This option can be usefull for long running operations.
- Type: boolean
vaultCredentialsId (optional)
Select the credentials for vault encrypted vars. Only secret file and secret text are supported.
- Type: String

$class: 'AnsibleTower'

towerServer (optional)
- Type: String
jobTemplate (optional)
- Type: String
jobType (optional)
- Type: String
extraVars (optional)
- Type: String
jobTags (optional)
- Type: String
skipJobTags (optional)
- Type: String
limit (optional)
- Type: String
inventory (optional)
- Type: String
credential (optional)
- Type: String
verbose (optional)
- Type: boolean
importTowerLogs (optional)
- Type: boolean
removeColor (optional)
- Type: boolean
templateType (optional)
- Type: String
importWorkflowChildLogs (optional)
- Type: boolean

$class: 'AnsibleVaultBuilder'

action (optional)
Desired vault action.
- Type: String
ansibleName (optional)
- Type: String
content (optional)
Desired encrypted content.
- Type: String
input (optional)
Desired input file to encrypt.
- Type: String
newVaultCredentialsId (optional)
Select the credentials for rekeying vault encrypted files. Only Jenkins secret file and secret text are supported.
- Type: String
output (optional)
Desired output file for encrypted content.
- Type: String
vaultCredentialsId (optional)
Select the credentials for vault encrypted vars. Only Jenkins secret file and secret text are supported.
- Type: String

ant

For projects that use Ant as the build system. This causes Jenkins to invoke Ant with the given targets and options. Any non-zero exit code causes Jenkins to mark the build as a failure.

Jenkins supplies some environment variables that can be used from within the build script.

targets
Specify a list of Ant targets to be invoked (separated by spaces), or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
- Type: String
antName
- Type: String
antOpts
If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
- Type: String
buildFile
If your build requires a custom -buildfile, specify it here. By default Ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
- Type: String
properties
Properties needed by your ant build can be specified here (in standard properties file format):
```
# comment
name1=value1
name2=$VAR2
```
These 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=
- Type: String

$class: 'AntExec'

scriptSource
Runs entered Apache Ant tasks as a build file with only one target, untill you write code into the "Extended script source", but the target created from this code will always be the default target of the created build file.

The script will run with WORKSPACE as the current directory. Build will be considered as failure if any Ant task fails. You can use Ant-Contrib tasks (if it is enabled in global configuration). You need to use namespace "antcontrib" (example: "<antcontrib:if>").
- Type: String
extendedScriptSource
Into this field you can enter a code, you could not able to enter into the previous field, as it should not appear within the Ant target. The entries can be other targets, import/include tasks etc. With this extension you are able to create more complex Ant build file with just one limitation - the first field (textarea) must always be used for default Ant target. This field is optional.
- Type: String
scriptName
Here you can enter the name for your new script. The name will be also used for default Ant target. This build file will then have a name that differs from the default name, so it will not be overwritten by the upcoming build step and therefore it might be used repeatedly, or it can be included/imported.
- Type: String
properties
Properties needed by your ant build can be specified here (in standard properties file format):
```
# comment
name1=value1
name2=$VAR2
```
These 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=
- Type: String
antName
- Type: String
antOpts
If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m.
Note that other Ant options (such as -lib) should not be here.
- Type: String
keepBuildfile
- Type: boolean
verbose
- Type: boolean
emacs
- Type: boolean
noAntcontrib

Disabling usage of Ant-Contrib Tasks in this build step.
- Type: boolean

antws

For projects that use Ant as the build system. This causes Jenkins to invoke Ant with the given targets and options. Any non-zero exit code causes Jenkins to mark the build as a failure.

Jenkins supplies some environment variables that can be used from within the build script.

targets
Specify a list of Ant targets to be invoked (separated by spaces), or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
- Type: String
antName
- Type: String
antOpts
If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
- Type: String
buildFile
If your build requires a custom -buildfile, specify it here. By default Ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
- Type: String
properties
Properties needed by your ant build can be specified here (in standard properties file format):
```
# comment
name1=value1
name2=$VAR2
```
These 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=
- Type: String

$class: 'ApiFortressBuilder'

mode
When running in single test mode, once specific test will run. When running in automatch mode, a collection of tests will run.
- Type: String
hook
The API Hook URL.
API Hooks are unique urls connected to projects. They provide access to API Fortress automation API and will allow you to run tests.
You can create one in the API Fortress Company dashboard.
- Type: String
id
Test ID
When running in Single Test mode, you have to provide the ID of the test you want to run. You can find this information in the interstitial page of the test.
Automatch URL
When running in Automatch mode, introduce here the URL of the resource that you are willing to test.
Tag
When running in tag mode, introduce the tag of the tests you want to run.
Project
When running in project mode, no value is required.
- Type: String
blocking
Set this flag is a test failure must determine a build failure.
- Type: boolean
dryrun
Set this flag if you don't want the event to be stored in API Fortress.
- Type: boolean
silent
Set this flag if a failure should not generate API Fortress alerts.
- Type: boolean
param1name
- Type: String
param1value
- Type: String
param2name
- Type: String
param2value
- Type: String
param3name
- Type: String
param3value
- Type: String

$class: 'AppClone'

Clones an app template to a new Heroku app.

apiKey
- Type: String
appName
The name of the new app to create from the template.
- Type: String
templateAppName
The name of the template app to clone.
- Type: String

appscan

scanner
- dynamic_analyzer
- mobile_analyzer
- static_analyzer
name
- Type: String
type
- Type: String
application
- Type: String
credentials
- Type: String
email (optional)
- Type: boolean
failBuild (optional)
- Type: boolean
failBuildNonCompliance (optional)
- Type: boolean
failureConditions (optional)
- failureType
  - Type: String
- threshold
  - Type: int
target (optional)
- Type: String
wait (optional)
- Type: boolean

$class: 'AppScanSourceBuilder'

disableScan
- Type: boolean
applicationFile
- Type: String
acceptSSL
- Type: 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.
- Type: String
installation (optional)
- Type: String

$class: 'AppScanStandardBuilder'

startingURL
Insert the URL that you want AppScan Standard to start scanning from.
Spiders will find the remaining URLs in the domain to be included for scanning.
- Type: String
installation
- Type: String

additionalCommands (optional)

Provide additional and optional commands to run on AppScan Standard CLI.

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

Type: String

authScan (optional)
Checking this option will allow AppScan Stardard to spider and scan a website using authentication, optimizing the results obtained in the report.
If the website contains private information accessed only by logging in this option should be checked and credentials provided to increase dynamic security coverage.
- Type: boolean
authScanPw (optional)
Provide the password corresponding to the account's user name inserted above.
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
- Type: String
authScanRadio (optional)
Check "Recorded Login Sequence" if you have one for the website, this is, for the majority of the cases, the most reliable option for authenticated scanning.
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.
- Type: boolean
authScanUser (optional)
Provide the user name of an account with access to the private functionalities of the website.
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
- Type: String
generateReport (optional)
Check this option if you want AppScan Standard to generate a report after scannning.
The report is available in HTML and PDF.

The HTML report generated is ready to be integrated with the HTML Publisher Plugin.
- Type: boolean
htmlReport (optional)
This report can be integrated with the HTML Publisher Plugin.
- Type: boolean
includeURLS (optional)
This is used to include URLs for scanning,
Some URLs might not be found by AppScan Standard's spiders, include them to get the best possible coverage.
- Type: String
pathRecordedLoginSequence (optional)
Provide the full path to the recorded login sequence file (.login). More info. at: (9.0.3.2 User Guide) Login Management view - Chapter 4 - Configuring - Page 45 http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
- Type: String
pdfReport (optional)
A PDF report is generated.
- Type: boolean
policyFile (optional)
Provide the Path to a Test Policy File (.policy) to determine which type of flaws to scan for.
A Test Policy File can be created following these steps:

"Scan" > "Scan Configuration" > "Test Policy" > "Export".
- Type: String
reportName (optional)
Provide the name to save the report with.
To configure HTML Publisher Plugin properly, the names in the configuration must match.
- Type: String
verbose (optional)
Selecting this option will enable AppScan Standards' verbose, printing the full scan output in Jenkins log.
- Type: boolean

xooa

name
Xooa Jenkins
- Type: String
appId
- Type: String

$class: 'AppUploaderBuilder'

buildFilePath
Please specify the absolute path or relative to the app(.apk or .ipa) file to be uploaded.
The app_url of the uploaded app can be accessed from the environment variable BROWSERSTACK_APP_ID.
- Type: String

applatix

axUrl
The URL of Applatix system. For example: https://applatix.yourcompany.com
- Type: String
axUsername
Applatix credential: username
- Type: String
axPassword
Applatix credential: password
- Type: String
axServiceTemplateName
- Type: String
axServiceTemplateRepository
The repository where your Service Template is.
- Type: String
axServiceTemplateBranch
The branch where your Service Template is.
- Type: String
axServiceTemplateParameters
The parameters of your Service Template at Applatix system. It is optional. It is in JSON format, for example: {"service": "service_name", "iterations": 3 }
- key
  - Type: String
- value
  - Type: String

$class: 'ApprendaBuilder'

appAlias
The Applicaton Alias to be used.
- Type: String
appName
The Applicaton Name to be used.
- Type: String
versionAlias
The application Version Alias to target.
- Type: String
stage
The desired Apprenda Application lifecycle Stage.
- Type: String
artifactName
The filename of the Apprenda Application Package. For example myapplication.zip.
- Type: String
credentialsId
- Type: String
prefix
The Version Alias prefix to be used. Apprenda will append a number to the prefix to complete the Version Alias.
- Type: String
advVersionAliasToBeForced
The complete Version Alias, including the Version prefix and Version number to be used. For example v23.
- Type: String
advancedNewVersionOption
- Type: String
customPackageDirectory
The full path to the folder that contains the Apprenda Application Package defined in the Artifact Name.
- Type: String
applicationPackageURL
The complete URL to the Apprenda Application Package, starting with http:// or https://.
- Type: String
archiveUploadMethod
- Type: String
buildWithParameters
Check this box if you are using a parameterized project and want the Apprenda build step to do the substitution of variables from parameters.
- Type: boolean

aqua

locationType
- Type: String
registry
Name of a Docker registry that is defined in the Aqua Management Console. E.g. Docker Hub.
- Type: String
register
- Type: boolean
localImage
Path of local Docker image, including tag. E.g. my_ubuntu:latest
- Type: String
hostedImage
Path of Docker image on registry, including tag. E.g. google/mysql:latest
- Type: String
onDisallowed
- Type: String
notCompliesCmd
A shell command to execute when image does not comply with Aqua security policy
- Type: String
hideBase
- Type: boolean
showNegligible
- Type: boolean
policies
Comma separated names of image assurance policies. Available for only for local images and with scanner cli > v3.2.
- Type: String
customFlags
- Type: String

aquaMicroscanner

imageName
- Type: String
onDisallowed
- Type: String
notCompliesCmd
A shell command to execute when image does not comply with Aqua security policy
- Type: String
outputFormat
- Type: String

aquaServerlessScanner

onDisallowed
- Type: String
notCompliesCmd
- Type: String
codeScanPath
- Type: String
customFlags
- Type: String

arachniScanner

url
URL of the system under scan.
- Type: String
checks
Here you can specify a comma separated list with the checks to load. Or leave it blank to load all checks.
- Type: String
scope
- pageLimit
  Set the scope property page_limit. See Arachni Security Scanner Wiki for more information.
  - Type: int
- excludePathPattern
  Set the scope property exclude_path_patterns. See Arachni Security Scanner Wiki for more information.
  - Type: String
userConfig
- filename
  Name of the file with your own configuration in json format. Specify an absolute path or a relative to workspace.
  - Type: String
format
- Type: String

$class: 'ArtifactPromotionBuilder'

groupId
- Type: String
artifactId
- Type: String
classifier
- Type: String
version
- Type: String
extension
- Type: String
stagingRepository
- Type: String
stagingUser
- Type: String
stagingPW
- Type: String
releaseUser
- Type: String
releasePW
- Type: String
releaseRepository
- Type: String
promoterClass
- Type: String
debug
- Type: 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.
- Type: 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:

GroupId: This is generally unique amongst an organization or a project.
ArtifactId: The artifactId is generally the name that the project is known by.
Version: The version of the artifact to be resolved. The dynamic definitions 'RELEASE' (the latest release) and 'LATEST' (the latest build) are allowed too.
Classifier: It is some optional and arbitrary string that - if present - is appended to the artifact name just after the version number.
Extension: This is the extension of the artifact to be resolved. Important: this is not always the same as 'packaging' in maven! (although it might be the same e.g. for 'jar')
Target file name: should the file have a different name after downloading? You can also define a subdirectory.

artifacts
- groupId
  - Type: String
- artifactId
  - Type: String
- version
  - Type: String
- classifier (optional)
  - Type: String
- extension (optional)
  - Type: String
- targetFileName (optional)
  - Type: String
enableRepoLogging (optional)
- Type: boolean
failOnError (optional)
- Type: boolean
releaseChecksumPolicy (optional)
- Type: String
releaseUpdatePolicy (optional)
- Type: String
snapshotChecksumPolicy (optional)
- Type: String
snapshotUpdatePolicy (optional)
- Type: String
targetDirectory (optional)
- Type: String

$class: 'ArtifactsUploadBuilder'

projectName
Name of source project for uploading of artifact(s).
If a Maven project is specified, artifacts from all of its modules will be uploaded. Enter JOBNAME/MODULENAME here to upload from a particular module; you may copy/paste this from the URL for that module when browsing Jenkins. Example: MyMavenJob/my.group$MyModule
If a multiconfiguration (matrix) project is specified, artifacts from all of its configurations will be uploaded, each into a subdirectory with the name of the configuration as seen in its URL when browsing Jenkins. Example: If target directory is given as fromMatrix then the upload could create $WORKSPACE/fromMatrix/label=slaveA/dist/mybuild.jar and $WORKSPACE/fromMatrix/label=slaveB/dist/mybuild.jar.
To upload from a particular configuration, enter JOBNAME/AXIS=VALUE,.. as seen in the URL for that configuration. Example: MyMatrixJob/jdk=Java6u17
To upload artifacts from one matrix project to another, use a parameter to select the matching configuration in the source project. Example: OtherMatrixJob/jdk=$jdk
- Type: String
parameters
Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.
- Type: String
selector
- $class: 'ParameterizedBuildSelector'
- $class: 'PermalinkBuildSelector'
- $class: 'SavedBuildSelector'
- $class: 'SpecificBuildSelector'
- $class: 'StatusBuildSelector'
- $class: 'TriggeredBuildSelector'
- $class: 'WorkspaceSelector'
filter
Relative paths to artifact(s) to upload or leave blank to upload all artifacts. Check the /artifact/ browser of a build to see the relative paths to use here, as the build page typically hides intermediate directories. Can use wildcards like module/dist/**/*.zip, and use comma (followed by optional whitespace) to separate multiple entries. See the @includes of Ant fileset for the exact format. May also contain references to build parameters like $PARAM.
- Type: String
target
- Type: String
flatten
- Type: boolean
optional
- Type: boolean
fingerprintArtifacts
- Type: 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.
- Type: String

assertthatBddFeatures

projectId
Jira project id.
- Type: String
credentialsId
- Type: String
outputFolder

Output folder for feature files withing workspace. Default ./features/.
By default features are downloaded to the root of the workspace.
- Type: String
jql
- Type: String
mode
- Type: String

$class: 'AssetBuilder'

name
- Type: String
description
- Type: String
version
- Type: String
vendor
- Type: String
platform
- Type: String
architecture
- Type: String
bits
- Type: String
cpu
- Type: int
memory
- Type: int
storage
- Type: int
installationScriptFilePath
- Type: String
mediaFilePaths
- path
  - Type: String
licenseFilePath
- Type: String
documentationFilePath
- Type: String

associateTag

nexusInstanceId
- Type: String
tagName
The tag which will be applied to components matching the specified search criteria
- Type: String
search
The search criteria used to locate components on the target Nexus Repository Manager server. For more details, please see Search API
- key
  - Type: String
- value
  - Type: String

$class: 'AstreeBuilder'

dax_file
Absolute path to the DAX file containing the analysis specification and configuration.
Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
Paths and environment variables are evaluated on the machine running Jenkins.
- Type: String
analysis_id
ID of an existing, preconfigured analysis on the Astrée server that serves as a revisioning base for the analyses of the current Jenkins project. The analysis, as configured via the supported DAX file, of a build is imported as a new revision into the project with this ID on the server, if such a project exists. The new revision will become a child revision of the last existing revision. If no project with this ID exists on the server, the analysis will become the first revision of a new project with the specified ID.
Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
- Type: String
output_dir
Absolute path to the folder into which the Summary Reports are to be generated. If left empty, reports will be generated into the project's Workspace directory and will be accessible from the Jenkins web interface.
Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
- Type: String
skip_analysis
This switch can be used to deactivate the Astrée analysis build step. This switch provides a more convenient method to temporarily deactivate analysis runs than removing the entire build step and reconfiguring the Astrée analysis run from scratch when later adding the build step again.
- Type: boolean
genXMLOverview
- Type: boolean
genXMLCoverage
- Type: boolean
genXMLAlarmsByOccurence
- Type: boolean
genXMLAlarmsByCategory
- Type: boolean
genXMLAlarmsByFile
- Type: boolean
genXMLRulechecks
- Type: boolean
dropAnalysis
When this option is activated, the analysis is not stored on the Astrée server, instead it is automatically deleted after the analysis run of the build step.
This option is very helpful if the analysis run is only specified by a DAX file and it is not intended to archive each analysis run on the server.
Please be aware that using this option in an analysis run only specified by an analysis ID will result in deleting the analysis with that ID on the Astrée server.
This option corresponds to adding a --drop to a command line call to Astrée.
- Type: boolean
genPreprocessOutput
- Type: boolean
failonswitch
This option allow Astrée to fail a build depeneding on the types of detected code defects. The following settings are available:
- Only Errors
  ... lets Astrée fail a build if an Error (Definite Type A Alarm) is reported.
  This is the preferred setting for most use cases. A build is failed if Astrée can formally show the presence of a severe code defect in a (analysis) context.
- Errors and Alarms
  ... lets Astrée fail a build if an Error or Alarm (Definite Type A Alarm or Potential Alarm of Type B or Type C) is reported.
  This is the preferred setting in case the absence of runtime errors in an application is to be formally shown. A build is failed if Astrée reports potential runtime errors.
- Errors, Alarms, and Data-Flow Anomalies
  ... lets Astrée fail a build if and only if any type of alarm (definite/potential Type A, B, C or D) is reported.
  This setting fails builds on any reported potential code defect or anomaly.
- failon
  - Type: String

$class: 'AutEnvironmentBuilder'

autEnvironmentModel
- almServerName
  - Type: String
- almUserName
  - Type: String
- almPassword
  - Type: String
- almDomain
  - Type: String
- almProject
  - Type: String
- clientType
  Client type should be provided if your server is ALM version 12.60 or above.
  - Type: String
- autEnvironmentId
  Assign ID of an AUT Environment that exists in the ALM project you selected.
  - Type: String
- useExistingAutEnvConf
  - Type: boolean
- existingAutEnvConfId
  - Type: String
- createNewAutEnvConf
  - Type: boolean
- newAutEnvConfName
  - Type: String
- autEnvironmentParameters
  - name
    The name must be set in the same hierarchical structure as it defined in ALM ( 'Parameters' tab of the AUT Environment)
    For example: 'Parameters/DB_Setting/Oracle/username'
    - Type: String
  - value
    If you are using a 'From JSON' type, specify here the path for the element you would like to get.
    Make sure you are using JsonPath style for defining it.
    - Type: String
  - paramType
    Manual - the value you'll assign for 'Parameter value' field will be used as is.
    Environmnet - the value you'll assign for 'Parameter value' will be looked for in the environment parameters and the resolved value will be used. If you named your parameter 'my_parameter' put here 'my_parameter' (exactly the same value).
    From JSON - the value you'll assign for 'Parameter value' will be looked for in the JSON file you specified for the 'Path to JSON file' entry.
    - Type: String
  - shouldGetOnlyFirstValueFromJson
    - Type: boolean
- pathToJsonFile
  A path to the JSON file that will be loaded in order to assign values to all the AUT Environment Parameters of 'From JSON' type.
  - Type: String
- outputParameter
  The name of the build environment parameter that will get the ID of the updated/created AUT Environment Configuration. It then can be used as a parameter for following build steps.
  The parameter must be a String Parameter.
  If you named your parameter 'output_parameter' put here 'output_parameter' (exactly the same value).
  - Type: String

$class: 'AutoConfigBuilder'

name
- Type: String
discobitUrl
- Type: String
discobitUser
- Type: String
discobitPassword
configurations
- Type: String
cuuid
- Type: String

$class: 'AwsBatchBuilder'

jobname
- Type: String
jobdefinition
- Type: String
command
- Type: String
jobqueue
- Type: String
vcpu
- Type: String
memory
- Type: String
retries
- Type: String

azureCLI

principalCredentialId
The Service Principal credentials required to connect to your Azure account.
More information can be found here: https://github.com/Azure/azure-devops-utils#user-content-create-service-principal
If you want to add an Azure credential click "Add" and select "Microsoft Azure Service Principal" from the Kind drop-down.
If you want to remove existing Azure credentials you must go to the Credentials Dashboard.
- Type: String
commands
- script
  - Type: String
- exportVariablesString
  Export the output of the command to environment variables
  The format: /"variable from JSON" | "desired environment variable name"
  For example: Output: { "id": "/subscriptions/some-guid/resourceGroups/test", "location": "northeurope", "managedBy": null, "name": "test", "properties": { "provisioningState": "Succeeded" }, "tags": null } Environment Variable String: /location|LOCATION , /name|NAME
  - Type: String

azureDownload

storageCredentialId
- Type: String
downloadType
- Type: String
buildSelector (optional)
- downstream
- lastWithArtifacts
- lastCompleted
- $class: 'MultiJobBuildSelector'
- buildParameter
- permalink
- $class: 'PromotedBuildSelector'
- latestSavedBuild
- specific
- lastSuccessful
- upstream
- workspace
containerName (optional)
Enter a storage container name.
Environment variables can also be referenced.
For example: ${JOB_NAME}
- Type: String
deleteFromAzureAfterDownload (optional)
If checked, the file copy on Azure will be removed after it's downloaded to local.
- Type: boolean
downloadDirLoc (optional)
Enter a download path. If not specified, the files will be downloaded into the job's workspace.
Environment variables can also be referenced, for example: ${JOB_NAME} If "Flatten Directories" is checked, this directory will contain all outputs.
- Type: String
excludeFilesPattern (optional)
Enter a pattern of blobs to exclude from the download. Ant fileset syntax. Leaving blank will download the entire container. Environment variables can also be referenced.
For example: ${JOB_NAME}
- Type: String
fileShare (optional)
Enter a Azure File Storage Share name.
Environment variables can also be referenced.
For example: ${JOB_NAME}
- Type: String
flattenDirectories (optional)
If checked, all files specified for download will be flattened to the single download directory. If two files are named the same in different directories, only one will remain.
- Type: boolean
includeArchiveZips (optional)
The archive zip files generated (archive.zip in the root of the container/virtual path) are typically excluded from download. Check this to enable downloading of the archive zip.
- Type: boolean
includeFilesPattern (optional)
Enter a pattern of blobs to download. Ant fileset syntax. Environment variables can also be referenced.
For example: ${JOB_NAME}
- Type: String
projectName (optional)
The name of the project to download the managed artifact from.
- Type: String

$class: 'BDSBuilder'

projectFile
- Type: String
switches
- Type: String
installationName
- Type: String

$class: 'BapFtpBuilder'

Send files over FTP as a build step during the build

publishers

Array/List

Nested Object

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.
- Type: String
verbose
Select to enable logging of all commands sent to, and responses received from the FTP server in the Jenkins console.
- Type: boolean

transfers

Array/List

Nested Object

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.
- Type: 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)
- Type: 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.
- Type: 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.
- Type: 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.
- Type: boolean

remoteDirectorySDF

Select this to include the timestamp in the remote directory.

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`

Type: 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.
- Type: boolean
cleanRemote

Select to delete all files and directories within the remote directory before transferring files.
- Type: boolean
noDefaultExcludes
- Type: 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.
- Type: 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.
- Type: 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
- Type: 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.
- Type: 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
  The number of times to retry this server in the event of failure
  - Type: int
- retryDelay
  The time to wait, in milliseconds, before attempting another transfer
  - Type: 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
  - Type: String
ftpCredentials
Set the username and password to use with this connection.
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
  - Type: String
- password
  - Type: String

continueOnError
- Type: boolean
failOnError
- Type: boolean
alwaysPublishFromMaster
- Type: boolean
masterNodeName
- Type: String
paramPublish
- parameterName
  The name of the parameter or environment variable that will contain the expression for matching the labels.
  - Type: String

$class: 'BapSshBuilderPlugin'

Send files or execute commands over SSH as a build step during the build

publishers

Array/List

Nested Object

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.
- Type: String
verbose
Select to enable an obscene amount of information to the Jenkins console - only really useful to help track down problems
- Type: boolean

transfers

Array/List

Nested Object

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.
- Type: 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)
- Type: 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.
- Type: 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.
- Type: String

remoteDirectorySDF

Select this to include the timestamp in the remote directory.

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`

Type: 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.
- Type: boolean
cleanRemote
- Type: boolean
noDefaultExcludes
- Type: 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.
- Type: 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.
- Type: 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.
- Type: String
execTimeout (optional)

Timeout in milliseconds for the Exec command

Set to zero to disable.
- Type: 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.

Type: 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.

Type: 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
- Type: 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.
- Type: 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
  The number of times to retry this server in the event of failure
  - Type: int
- retryDelay
  The time to wait, in milliseconds, before attempting another transfer
  - Type: 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
  - Type: String
sshCredentials
Set the credentials to use with this connection.
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
  The username to connect with.
  - Type: String
- encryptedPassphrase
  The passphrase for the private key, or the password for password authentication if no Key or Path to key is configured.
  Leave blank if the key is not encrypted.
  - Type: String
- key
  
  The private key.
  
  Paste the private key here, or provide the path to the file containing the key in Path to key.
  - Type: 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
  - Type: String

continueOnError
- Type: boolean
failOnError
- Type: boolean
alwaysPublishFromMaster
- Type: boolean
masterNodeName
- Type: String
paramPublish
- parameterName
  The name of the parameter or environment variable that will contain the expression for matching the labels.
  - Type: String

batchFile

command
- Type: String

$class: 'BeaglePlugin'

apptoken

Generate your Application Token From Beagle

Home -> Applications -> Select your Application -> Settings -> Application Token
usertoken

Generate your User Token From Beagle User Settings

Settings -> Access Token -> Generate Your New Personal Access Token

$class: 'BeakerBuilder'

jobSource
- $class: 'FileJobSource'
- $class: 'StringJobSource'
downloadFiles
- Type: boolean

benchmark

filepath
Please insert a filepath.
- Type: String

$class: 'BitbucketPublisher'

serverUrl (optional)
Bitbucket Server Url.
- Type: String
credentialsId (optional)
Credentials for bitucket server. The user must have access to create project and repository.
- Type: String
projectKey (optional)
Input the project key for the bitbucket.
- Type: String
createProject (optional)
Check this if you want to create the bitbucket project.
- projectName
  - Type: String
- projectUsers
  - Type: String
- projectGroups
  - Type: String
createJenkinsJobs (optional)
Check this if you want to use the bitbucket post commit external hook to call.
- ciServer
  - Type: String
projectName (optional)
Input name of the Bitbucket project.
- Type: String

$class: 'BlueprintLaunch'

projectName

Project selection is mandatory.
- Type: String
blueprintName

Blueprint selection is mandatory.
- Type: 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.
- Type: String
appProfileName

Application Profile selection is mandatory.
- Type: 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.
- Type: 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.
- Type: String
waitForSuccessFulLaunch
- Type: boolean
blueprintDescription

Description is fetched from the selected Calm blueprint
- Type: String

$class: 'BootPluginBuilder'

tasks
Provide a valid boot task, this could be a built in task or a user defined. Try 'boot help' for list of tasks.
- Type: String
jvmOpts
Specify JVM Options to be used within boot tasks.
- Type: String

$class: 'BranchDestructionStep'

project
- Type: String
branch
- Type: String

$class: 'BranchGenerationStep'

projectConfig
- pipelineConfig
  - destructor
    - Type: boolean
  - authorisations
    - Type: String
  - branchSCMParameter
    - Type: boolean
  - branchParameters
    - Type: String
  - generationExtension
    - Type: String
  - pipelineGenerationExtension
    - Type: String
  - disableDslScript
    - Type: boolean
  - scriptDirectory
    - Type: String
  - namingStrategy
    - projectFolderPath
      - Type: String
    - branchFolderPath
      - Type: String
    - projectSeedName
      - Type: String
    - projectDestructorName
      - Type: String
    - branchSeedName
      - Type: String
    - branchStartName
      - Type: String
    - branchName
      - Type: String
    - ignoredBranchPrefixes
      - Type: String
  - eventStrategy
    - delete
      - Type: boolean
    - auto
      - Type: boolean
    - trigger
      - Type: boolean
    - commit
      - Type: String
- project
  - Type: String
- scmType
  - Type: String
- scmUrl
  - Type: String
- scmCredentials
  - Type: String
- triggerIdentifier
  - Type: String
- triggerType
  - Type: String
- triggerSecret
  - Type: String

$class: 'BuildBuilder'

dbFolder
- value
  - Values: vcsroot, subfolder, scaproject
- subfolder
  - Type: String
- projectPath
  - Type: String
packageid
Enter an ID for the build artifact you want to build. Typically, this will be the same as your database name.
- Type: String
tempServer
- value
  - Type: String
- serverName
  - Type: String
- dbName
  - Type: String
- serverAuth
  - value
    - Type: String
  - username
    - Type: String
  - password
    - Type: String
options
- Type: String
filter
- Type: String
packageVersion
Optionally, set a custom package version. If this is left blank, the version 1.0.${BUILD_NUMBER} will be used.
- Type: String
dlmDashboard
- dlmDashboardHost
  - Type: String
- dlmDashboardPort
  - Type: String
sqlChangeAutomationVersionOption
- value
  - Values: Latest, Specific
- specificVersion
  - Type: String

buildDescription

Normally, build description is empty, but it can be changed by setting what name new build gets. This field can contain macros.

descriptionTemplate
- Type: String

buildName

Normally, builds are named by their sequential numbers, but you can change that here by setting what name new build gets. This field can contain macros.

nameTemplate
- Type: String

$class: 'BuildNameUpdater'

This plugin updates build name and description during the build process. Values to set could be stored in a file in the build workspace or in an environment variable.

fromFile
- Type: boolean
buildName
- Type: String
fromMacro
- Type: boolean
macroTemplate
- Type: String
macroFirst
- Type: boolean

crxBuild

packageId (optional)
Specify a list of package IDs to replicate from each specified Base URL. Each package ID string must occupy its own line.

A Package ID consists of the group, the name, and the version of a package, separated by colons (':'), as in: "group:name:version". The version may be omitted.

This field supports parameter tokens.
- Type: String
baseUrl (optional)
Specify the base URL of the Adobe Granite server, including hostname and port. The CRX Package Manager service path will be appended to this value for all requests. For example, http://localhost:4502 or https://author.mycorp.com, etc.

If login credentials for the server are different than those configured in the Connection Options section, you may override them in the Base URL by inserting username[:password]@ between the scheme and the hostname.

For example, to override the Username without changing the associated password or private key, you may use the following form:

http:// deployer@localhost:4502

To override the credentials completely, provide a username and password (which may be provided by an encrypted parameter) by separating them with a colon, as shown below:
http:// deployer:Password123@localhost:4502

This field supports parameter tokens.
- Type: String
credentialsId (optional)
Select the login credentials for authenticating requests to the CRX server.

[Signature] credentials may be used if the target server supports HTTP Signature Authentication using the keyId format, /$username/keys/$fingerprint.

Select "-none-" to use the default credentials set in the global CRX Content Package Deployer - HTTP Client configuration.
- Type: String
download (optional)
Check this box to download the package after building it.
- Type: boolean
localDirectory (optional)
Specify a path relative to the workspace where the package will be downloaded (if the "Download" box is checked).

This field supports parameter tokens.
- Type: String
requestTimeout (optional)
Specify the timeout in milliseconds to wait for a response for each individual request. Specify a value of 0 to use default behavior.
- Type: long
serviceTimeout (optional)
Specify the timeout in milliseconds to wait for PackageManager service availability between sending POST requests. Specify a value of 0 to use default behavior.
- Type: long
waitDelay (optional)
Specify a delay in milliseconds before calls to check for Package Manager service availability. Increase this value if a /crx/packmgr node is sometimes created in the repository by this step, indicating that the Package Manager servlet was brought down for bundle installation AFTER a successful check for service availability, but BEFORE the next POST request was sent. What happens is that the SlingPostServlet takes over when the crx-packagemgr bundle is refreshed and creates nodes for any POST requests that it handles. Increasing this delay gives more time for the bundle refresh process to begin on the server.
- Type: long
wspFilter (optional)
Specify a package workspace filter in a simple text format that will be applied to the package before build. This defines what content will be captured by the package.

Simple spec is defined simply as a line-by-line format where:
- each line consists of significant text before an optional comment character (#)
- each line that begins with a "/" begins a new filter root.
- the first non-empty, non-comment line must define a new filter root
- each non-empty, non-comment line after a filter root that begins with a "+" or "-" defines an include or exclude rule, respectively. Everything following the "+" or "-" must be a valid regular expression
Content is "covered" by a filter root if the content path starts with, or is the same as the filter root path. Once the "covering" filter root is identified, its include/exclude rules are evaluated from top to bottom, by matching the content path against each rule pattern (which is a Java regular expression). The last rule whose pattern matches the content path defines whether that content is included (line starts with "+") or excluded (line starts with "-"). If no rules are defined, all content covered by that root path is included

For example, to include everything under /etc except for packages:
```
        /etc                 # define /etc as the filter root
        +/etc(/.*)?          # include everything under /etc
        -/etc/packages(/.)?  # exclude package paths
    
```
To 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 code
    
```
This field supports parameter tokens.
- Type: String

$class: 'BuildScanner'

Trigger automated Acunetix scans as part of your web application's build process

profile
The Scan Type used to scan the target
- Type: String
target
The Scan Target on which to run a scan (excludes Targets requiring Manual Intervention)
- Type: String
repTemp
Generate a Report after the scan completes. The report download link will be provided in the job console output
- Type: String
threat
The Threat Level (High, Medium, Low) to fail the build on
- Type: String
stopScan
If selected, the scan will be stopped if the build fails (Threat Level is reached)
- Type: boolean

$class: 'BuildStepBuilder'

sourceFolderMode
- Type: String
subfolder
- Type: String
packageId
- Type: String
serverType
- Type: String
server
- Type: String
authenticationType
- Type: String
userName
- Type: String
password
database
- Type: String
compareOptions (optional)
- Type: String

$class: 'BuildStepWithTimeout'

buildStep
$class: 'BuildStepsFromJsonBuilder'
$class: 'BuildoutBuilder'

pythonName
- Type: String
buildoutCfg
- Type: String
nature
- Type: String
command
- Type: String
ignoreExitCode
- Type: boolean

byteguardGreet

token
- Type: String
task_id
- Type: String

$class: 'CFLaunchBuilder'

cfComposition
- Type: String
setCFVars
- vars
  - Variable
    - Type: String
  - Value
    - Type: String

$class: 'CFLintBuilder'

This build step can be used to invoke CFLint analysis

folder
Configure the base folder to run the CFLint analysis
- Type: String
cflintFolder
Configure the CFLint installation folder
- Type: String
cflintExcludesFile
Enter the name of the cflintexcludes json file (default : cflintexclude.json)
- Type: String
otherArgs
- Type: String

$class: 'CIMessageBuilder'

providerData (optional)
- activeMQPublisher
- activeMQSubscriber
- fedmsgPublisher
- fedmsgSubscriber

$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
- activeMQSubscriber
- fedmsgPublisher
- fedmsgSubscriber

$class: 'CToolBuilder'

Executes a tool of the CMake-suite with arbitrary command-line arguments.
Useful to run cmake in script mode ( cmake -P <script file>) or command mode ( cmake -E <command>).

installationName
- Type: String
arguments (optional)
- Type: String
ignoredExitCodes (optional)
- Type: String
toolId (optional)
- Type: String
workingDir (optional)
- Type: String

generateCache

Generate ECU-TEST file caches (A2L, ELF, Bus, Model and Service caches are supported).

caches
- type
  - Values: A2L, ELF, BUS, MODEL, SERVICE
- filePath
  - Type: String
- dbChannel
  - Type: String
- clear
  - Type: boolean

$class: 'CallOtherJenkinsBuilder'

hostName
- Type: String
jobName
- Type: String
span
- Type: String
retry
- Type: String
userName
- Type: String
password
- Type: String
parameters
- Type: String

$class: 'CaptureIOSDeviceScreenshot'

Captures a screen shot from each connected iOS device. The image will be stored in a TIFF file matching the device's UDID (e.g. 3c701dda15e238cf3f2831346067751a5c942297.tiff).

url
- Type: String
cloudTestServerID
Select the server to download iOSAppInstaller.zip from.
- Type: String
additionalOptions
If you need to pass any other command line options to the iOSAppInstaller utility, specify them here. You can separate options with new lines as well as whitespaces.
- Type: String

castecho

installationName
- Type: String
sourcePath
- Type: String
applicationName
- Type: String
displayLog (optional)
- Type: boolean
logPath (optional)
- Type: String
outputPath (optional)
- Type: String
qualityGate (optional)
- Type: String

changeAsmVer

This build step can be used to change the version in the AssemblyInfo.cs file from a .NET Project, it's going to find every AssemblyInfo.cs file in the workspace and change the version from [AssemblyVersion] and [AssemblyFileVersion] attributes. It's recommended to use this plugin with the auto-generated AssemblyInfo.cs from VisualStudio.

versionPattern
- Type: String
assemblyCompany (optional)
- Type: String
assemblyCopyright (optional)
- Type: String
assemblyCulture (optional)
- Type: String
assemblyDescription (optional)
- Type: String
assemblyFile (optional)
Set the file name to search. If the value is empty the default filename is : **/AssemblyInfo.cs. You can use an ant fileset pattern.
- Type: String
assemblyProduct (optional)
- Type: String
assemblyTitle (optional)
- Type: String
assemblyTrademark (optional)
- Type: String
regexPattern (optional)
Regex Pattern in which version is stated. Specify this value if you want to use for versioning other than assembly files (e.g. visual studio extensions .vsix). For assembly (.dll) versioning you do not need to specify anything here.
- Type: String
replacementPattern (optional)
Version value specified in regexPattern will be replaced by this. Use if you want versioning other than assembly files. e.g. "Version(\"%s\")" where %s will be new version number. For assembly (.dll) versioning keep this field blank.
- Type: String

$class: 'ChangesetEvaluator'

basePath (optional)
- Type: String
changeLogFile (optional)
- Type: String
changeLogParameters (optional)
- Type: String
classpath (optional)
- Type: String
contexts (optional)
- Type: String
credentialsId (optional)
- Type: String
databaseEngine (optional)
- Type: String
defaultSchemaName (optional)
- Type: String
driverClassname (optional)
If the list of included drivers doesn't contain a suitable driver, you may define the driver classname here. You'll most likely need to define a value for "classpath" as well.
- Type: String
dropAll (optional)
- Type: boolean
labels (optional)
- Type: String
liquibasePropertiesPath (optional)
You may opt to place all you configuration in a file whose location is defined here.
- Type: String
password (optional)
- Type: String
tagOnSuccessfulBuild (optional)
- Type: boolean
testRollbacks (optional)
- Type: boolean
url (optional)
- Type: String
useIncludedDriver (optional)
- Type: boolean
username (optional)
- Type: String

chatterPost

Simple step for posting a Chatter buildUrlTitle/body to a specified channel or the user's wall.
Usage Example:
postToChatter "Build Started - ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"

credentialsId
Utilizes the Credentials Plugin's Username with Password credentials storage to communicate with Chatter.
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.
- Type: String
body
The body text for your Chatter post
- Type: String
buildUrlTitle (optional)
The buildUrlTitle for your Chatter post. If left blank, the title will be set to your job/pipeline name and number (JOB_NAME BUILD_DISPLAY_NAME)
- Type: String
recordId (optional)
Id of record to chatter to (e.g. a group, or a custom object), leave blank to chatter to user's wall.
- Type: String
server (optional)
If left blank will connect to production, if you want to connect to a sandbox or have the my domains feature enabled, enter URL of alternative login server, e.g. https://test.salesforce.com
- Type: String

$class: 'CheckGate'

pipelineId
- Type: String
stageName
- Type: String
versionId
- Type: String
fatal
- Type: String

$class: 'CheckGateBuilder'

project
Select project.
- Type: String
gate
- Type: String

$class: 'ChefBuilderConfiguration'

url
- Type: String
sinatraurl
- Type: String
filter
- Type: String
username
- Type: String
port
- Type: int
command
- Type: String
privatekey
- Type: String
parallel
- Type: boolean
fail
- Type: boolean

chlAtuoAction

content
- Type: String
browserString
- Type: String
runScriptOnly
- Type: boolean
rootPath
- Type: String
libPath
- Type: String

$class: 'ChrootBuilder'

chrootName
- Type: String
ignoreExit
The build will always succeed.
- Type: boolean
additionalPackages
Additional packages to install into the chroot environment by 'apt-get'. These packages are persisted in the tarball to speed up subsequent builds. If you don't want this bahaviour use the 'Clear' option.
- Type: String
packagesFile
Enter a list of comma separated relative paths to files in the workspace, which contain additionals packages for apt-get to install. Such files might be placed in a git repository wich is previously checked out.
- Type: String
clear
Uses a fresh copied chroot tarball without packages installed from previous runs. The build will take longer but the build results will be more meaningful.
- Type: boolean
command
- Type: String
loginAsRoot
When this box is unchecked the subsequent commands are run inside chroot as a user with the same uid and gid as jenkins does. Whenever possible leave this box unchecked, but e. g. for testing installations it might be important to be root.
- Type: boolean
noUpdate
When this option is enabled, the repository indices are only updated if extra packages are going to be installed. When disabling repository updates, self contained builds, which do not have to install packages, will run faster. Because packages can also be installed from commands within the buildstep, by default, the package indices are always updated.
- Type: boolean
forceInstall
This option allows to force the installation of the specified packages. The underlying container will do whatever it can do to fulfill this request. This allows actions like downgrading, installing untrusted packages, etc.
- Type: boolean

$class: 'CifsBuilderPlugin'

publishers
- configName
  - Type: String
- verbose
  - Type: boolean
- transfers
  - sourceFiles
    - Type: String
  - excludes
    - Type: String
  - remoteDirectory
    - Type: String
  - removePrefix
    - Type: String
  - remoteDirectorySDF
    - Type: boolean
  - flatten
    - Type: boolean
  - cleanRemote
    - Type: boolean
  - noDefaultExcludes
    - Type: boolean
  - makeEmptyDirs
    - Type: boolean
  - patternSeparator
    - Type: String
- useWorkspaceInPromotion
  - Type: boolean
- usePromotionTimestamp
  - Type: boolean
- retry
  - retries
    - Type: int
  - retryDelay
    - Type: long
- label
  - label
    - Type: String
continueOnError
- Type: boolean
failOnError
- Type: boolean
alwaysPublishFromMaster
- Type: boolean
masterNodeName
- Type: String
paramPublish
- parameterName
  - Type: String

$class: 'ClangScanBuildBuilder'

Use this option to execute clang scan-build against and XCode project.

target
Provide the exact name of the XCode target you wish to have compiled and analyzed. You can use targets for all versions of XCode. This field is not required if you are using XCode and providing workspace and scheme.
- Type: String
targetSdk
This should be set the simulator version of a currently installed SDK. For later versions of XCode, you can set this value to 'iphonesimulator' to automatically use the latest available version of the SDK. If this does not work, you can identify a specific version by issuing the following command in Terminal:

xcodebuild -showsdks

It should typically look like 'iphonesimulator4.2' where the version number may change depending on your XCode installation.
- Type: String
config
Provide the XCode config you wish to execute scan-build against. It is recommended that you always use 'Debug' because this will allow clang to use assertions to eliminate false positives.
- Type: String
clangInstallationName
- Type: String
xcodeProjectSubPath
If your XCode project is located in a sub-folder of this job's workspace, provide the path here relative to the workspace. e.g. myProj/subfolder
- Type: String
workspace
In XCode 4 and later, you are able to configure named workspaces which are basically containers for multiple XCode projects. If your build requires a workspace, please provide its name in this field. When you provide a workspace you are XCode requires that you also provide a scheme.
- Type: String
scheme
If you are leveraging XCode workspaces and schemes, provide the name of your scheme here.
- Type: String
scanbuildargs
This field can be used to pass additional arguments to clang scan-build. The arguments will appear before the xcodebuild sub command. You can view the assembled command by viewing the job's build console.

scan-build uses the 'clang' executable relative to itself for static analysis by default.
--use-analyzer Xcode using the 'clang' packaged with Xcode (on OS X)
--use-analyzer [path to clang] to use the 'clang' from 'path to clang' or $PATH if no path specified.
- Type: String
xcodebuildargs
This field can be used to pass additional arguments to clang scan-build. The arguments will appear after the xcodebuild sub command. You can view the assembled command by viewing the job's build console.

-derivedDataPath $WORKSPACE/build is to save build products and other derived data to build directory under current workspace
- Type: String
outputFolderName
- Type: String

googleStorageUpload

credentialsId
- Type: String
bucket
- Type: String
pattern
- Type: String
pathPrefix (optional)
- Type: String
sharedPublicly (optional)
- Type: boolean
showInline (optional)
- Type: boolean

examCleanTarget

$class: 'ClifBuilder'

clifName
- Type: String
clifOpts
- Type: String
testPlanFile
- Type: String
reportDir
- Type: String

$class: 'CloudBuildBuilder'

This build step invokes Google Cloud Build.

input
- credentialsId
  - Type: String
- request
  - file
  - inline
- source (optional)
  - local
  - repo
  - storage
- substitutionList (optional)
  - items
    User-defined substitutions to be added to the build request. The set of user-defined substitutions referenced in the build request must exactly match the set of substitutions defined here. For details, see Build Requests - User-defined substitutions.
    - key
      The name of the user-defined substitution. This must begin with an underscore ( _) 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.
      - Type: String
    - value
      The value of the user-defined substitution. This must not expand to longer than 100 characters. For details, see Build Requests - User-defined substitutions.
      - Type: String
- substitutions (optional)

$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.
  - Type: String
- description
  - Type: String
- cloudFormationRecipe
  - Type: 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.
  - Type: String
- timeout
  Number of seconds to wait before giving up creating a stack. Minimum time is 5 mins.
  - Type: long
- awsAccessKey
  The Amazon API Access Key. You can pass environment variables into this field.
  - Type: String
- awsSecretKey
  The Amazon API Secret Key. You can pass environment variables into this field.
  - Type: String
- awsRegion
  Select the region you wish to run the cloudformation on.
  - Values: 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
  Number of seconds to wait before continuing to the next step(minimum is 0 sec)
  - Type: long

pushToCloudFoundry

target
- Type: String
organization
- Type: String
cloudSpace
- Type: String
credentialsId
- Type: String
manifestChoice (optional)
- appName (optional)
  - Type: String
- appPath (optional)
  - Type: String
- buildpack (optional)
  - Type: String
- command (optional)
  - Type: String
- domain (optional)
  - Type: String
- envVars (optional)
  - key
    - Type: String
  - value
    - Type: String
- hostname (optional)
  - Type: String
- instances (optional)
  - Type: String
- manifestFile (optional)
  - Type: String
- memory (optional)
  - Type: String
- noRoute (optional)
  - Type: String
- servicesNames (optional)
  - name
    - Type: String
- stack (optional)
  - Type: String
- timeout (optional)
  - Type: String
- value (optional)
  - Type: String
pluginTimeout (optional)
- Type: String
selfSigned (optional)
- Type: String
servicesToCreate (optional)
- name
  - Type: String
- type
  - Type: String
- plan
  - Type: String
- resetService (optional)
  - Type: boolean

$class: 'CloudShellConfig'

buildStep
- $class: 'StartSandbox'

$class: 'CmakeBuilder'

Uses CMake to generate build-scripts and can run these.
This causes Jenkins to invoke cmake -G with the given options.
Any non-zero exit code during build-script generation causes Jenkins to mark the build as a failure.
It also can expose the CMAKE_BUILD_TOOL build environment variable if the chosen generator supports that.

installationName
- Type: String
buildDir (optional)
- Type: String
buildType (optional)
- Type: String
cleanBuild (optional)
- Type: boolean
cmakeArgs (optional)
- Type: String
generator (optional)
- Type: String
preloadScript (optional)
- Type: String
sourceDir (optional)
- Type: String
steps (optional)
- args (optional)
  Specify arguments to pass to the build tool or cmake (separated by spaces). Arguments may contain spaces if they are enclosed in double quotes (will be handled like a Unix shell does),
  HINT: If you plan to archive the artifacts, specify DESTDIR=${WORKSPACE}/artifacts all install here to instruct the tool to copy the artifacts to DESTDIR. At least the make and the ninja tool allow overriding the installation directory that way.
  - Type: String
- envVars (optional)
  Specify extra environment variables to pass to the build tool as key-value pairs here.
  Each entry must be on its own line, for example:
  DESTDIR=${WORKSPACE}/artifacts/dir KEY=VALUE
  Please note that macros (e.g. ${WORKSPACE}) will not be resolved by a pipeline script.
  - Type: String
- withCmake (optional)
  Whether to run the actual build tool directly (by expanding $CMAKE_BUILD_TOOL) or to have cmake run the build tool (by invoking cmake --build <dir>).
  - Leave unchecked for minimal performance overhead.
  - Check this, if you selected one of the Visual Studio or Xcode generators above AND if you run CMake v. 2.8.11 or newer.
  - Type: boolean

$class: 'CocoaPodsBuilder'

cleanpods
If checked the "pod" folder will be deleted before updating the pods
- Type: boolean

$class: 'CodeAnalysisBuilder'

connection

An Oracle connection string used for connecting to the database.
user/password@host:port/service
- Type: 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.
  - Type: 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.
  - Type: String
- type
  - 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.
  - Type: String
- filter
  Filter directory files by name or extension.
  - Type: String
- recurse
  - Type: boolean
report
- name
  
  The base name of the reports, without an extension. If empty no reports will be generated.
  - Type: String
- html
  - Type: boolean
- json
  - Type: boolean
- xls
  - Type: boolean
- xml
  - Type: boolean
ruleSet
- Type: int
failConditions
- halstead
  
  Halstead level which will cause the code analysis to fail, exclude to ignore.
  - Type: int
- maintainability
  
  Maintainability index level which will cause the code analysis to fail, exclude to ignore.
  - Type: int
- mcCabe
  
  McCabes level which will cause the code analysis to fail, exclude to ignore.
  - Type: int
- TCR
  
  Toad Code Rating level which will cause the code analysis to fail, exclude to ignore.
  - Type: int
- ruleViolations
  
  If enabled, code analysis will fail on any violation for the selected rule set.
  - Type: boolean
- syntaxErrors
  
  If enabled, code analysis will fail on any syntax error.
  - Type: boolean
- ignoreWrappedPackages
  
  If enabled, code analysis will fail when a wrapped package is found.
  - Type: boolean

$class: 'CodeBuilder'

credentialsType
- Type: String
credentialsId
- Type: String
proxyHost
- Type: String
proxyPort
- Type: String
awsAccessKey
- Type: String
awsSecretKey
awsSessionToken
- Type: String
region
- Type: String
projectName
- Type: String
sourceVersion
- Type: String
sseAlgorithm
- Type: String
sourceControlType
- Type: String
localSourcePath
- Type: String
workspaceSubdir
- Type: String
gitCloneDepthOverride
- Type: String
reportBuildStatusOverride
- Type: String
secondarySourcesOverride
- Type: String
secondarySourcesVersionOverride
- Type: String
artifactTypeOverride
- Type: String
artifactLocationOverride
- Type: String
artifactNameOverride
- Type: String
artifactNamespaceOverride
- Type: String
artifactPackagingOverride
- Type: String
artifactPathOverride
- Type: String
artifactEncryptionDisabledOverride
- Type: String
overrideArtifactName
- Type: String
secondaryArtifactsOverride
- Type: String
envVariables
- Type: String
envParameters
- Type: String
buildSpecFile
- Type: String
buildTimeoutOverride
- Type: String
sourceTypeOverride
- Type: String
sourceLocationOverride
- Type: String
environmentTypeOverride
- Type: String
imageOverride
- Type: String
computeTypeOverride
- Type: String
cacheTypeOverride
- Type: String
cacheLocationOverride
- Type: String
cloudWatchLogsStatusOverride
- Type: String
cloudWatchLogsGroupNameOverride
- Type: String
cloudWatchLogsStreamNameOverride
- Type: String
s3LogsStatusOverride
- Type: String
s3LogsLocationOverride
- Type: String
certificateOverride
- Type: String
serviceRoleOverride
- Type: String
insecureSslOverride
- Type: String
privilegedModeOverride
- Type: String
cwlStreamingDisabled
- Type: String
exceptionFailureMode
- Type: String

$class: 'CodeCoverageBuilder'

connectionId
- Type: String
credentialsId
- Type: String
analysisPropertiesPath
- Type: String
analysisProperties
- Type: String

$class: 'CodeScanBuilder'

projectKey
- Type: String
commitOverride
- Type: String
version
- Type: 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
- Type: String
analysisMode
- Type: String
projectBranch
- Type: String
blocking
- Type: boolean

codescene

credentialsId
Select username/password credentials defined in Jenkins configuration. This is a safe way to use credentials in Jenkins plugin. See Injecting Secrets into Jenkins Build Jobs for more details.
- Type: String
deltaAnalysisUrl
- Type: String
repository
- Type: String
analyzeBranchDiff (optional)
- Type: boolean
analyzeLatestIndividually (optional)
Commits not seen in previous successful builds will be used for separate delta analyses.
- Type: boolean
baseRevision (optional)
- Type: String
couplingThresholdPercent (optional)
- Type: int
failOnDecliningCodeHealth (optional)
Check this option to mark the build as unstable if the Code Health of a hotspot declines.
- Type: boolean
failOnFailedGoal (optional)
Check this option to mark the build as unstable if a goal -- as defined by CodeScene's Intelligent Notes -- is violated. This could be a supervised hotspot that suddenly declines in Code Health, or a module indicated as No Problem that starts to accumulate complex code, etc.
- Type: boolean
letBuildPassOnFailedAnalysis (optional)
By default we fail the build if CodeScene couldn't run an analysis (e.g. couldn't update the repository). This behaviour can be overridden here.
- Type: boolean
markBuildAsUnstable (optional)
- Type: boolean
originUrl (optional)
- Type: String
riskThreshold (optional)
- Type: int
useBiomarkers (optional)
- Type: boolean

$class: 'CodeStreamBuilder'

serverUrl
vRealize Automation host.
- Type: String
userName
User name
- Type: String
password
Password
- Type: String
tenant
Tenant
- Type: String
pipelineName
CodeStream pipeline name. Please not only latest version of this pipeline will be executed.
- Type: String
waitExec
- Type: boolean
pipelineParams
- value
  - Type: String
- name
  - Type: String

$class: 'CodefreshPipelineBuilder'

selectPipeline
Check this if there's no SCM defined for current job or you would like to trigger a different service pipeline.
- cfPipeline
  - Type: String
- cfBranch
  - Type: String
setCFVars
- vars
  - Variable
    - Type: String
  - Value
    - Type: String

$class: 'CompareBuilder'

Compare two different schemas (from database, repository or snapshot). Based on it you can do in the next steps further actions (like generating report or alter script)

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:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}/dir.
- Type: String
srcInputType
- Type: String
tgtInputType
- Type: String
srcInputFileOrFolder
Specify input folder/file that will be used as source side input for compare. Following inputs are expected.
- Database - input is exported connection file
- File System Synchronization - input is folder mapped through Toad Edge file system synchronization
- Snapshot - input is snapshot file
Folder/file location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- Type: String
tgtInputFileOrFolder
Specify input folder/file that will be used as target side input for compare. Following inputs are expected.
- Database - input is exported connection file
- File System Synchronization - input is folder mapped through Toad Edge file system synchronization
- Snapshot - input is snapshot file
Folder/file location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- Type: 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:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Type: String

$class: 'CompareWithBaselineBuilder'

Compare your current schema with the baseline. In case that the schema is different the build step will fail.

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:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- Type: String
srcInputType
- Type: String
tgtInputType
- Type: String
srcInputFileOrFolder
Specify input folder/file that will be used as source side input for baseline compare. Following inputs are expected.
- Database - input is exported connection file
- File System Synchronization - input is folder mapped through Toad Edge file system synchronization
- Baseline - input is baseline snapshot file
Folder/file location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- Type: String
tgtInputFileOrFolder
Specify input folder/file that will be used as target side input for baseline compare. Following inputs are expected.
- Database - input is exported connection file
- File System Synchronization - input is folder mapped through Toad Edge file system synchronization
- Baseline - input is baseline snapshot file
Folder/file location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- Type: 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:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Type: String

$class: 'CompoundBuilder'

role
- Type: String
number
- Type: String

actualBuilder

Nested Choice of Objects

$class: 'A3Builder'

project_file
Absolute path to the a³ project file (.apx) containing the analysis items and configuration.
(Note: a³ workspace files (also .apx) are not supported as input.)
- Type: String
analysis_ids
The following values are allowed:
- Comma separated list of analysis IDs. Then only the given analysis items will be executed. Note: The ID must be contained in the apx project and must adhere the analysis ID naming conventions (letters, numbers and underscores only).
- No ID at all (i.e. empty field). Then all analysis items specified in the apx project file will be executed.
- Type: String
pedantic_level
- Type: String
export_a3apxworkspace
Exports the status of a³ at the end of the a³ analysis build step run as a workspace .apx file. This workspace file can later be opened in an interactive run of a³. The result is that the a³ GUI then shows all messages and all results generated by the batch-mode analyses without the need to run these analyses again.
- Type: String
copy_report_file
- Type: boolean
copy_result_file
- Type: boolean
skip_a3_analysis
This switch can be used to deactivate the a³ analysis build step. This switch provides a more convenient method to temporarily deactivate analysis runs than removing the entire build step and reconfiguring the a³ analysis run from scratch when later adding the build step again.
- Type: boolean

$class: 'ACSDeploymentBuilder'

context
- azureCredentialsId
  The Azure Service Principal credentials used to communicate with the Azure services. Check the following documentation for more information about the service principal:
  - Use portal to create an Azure Active Directory application and service principal that can access resources
  - Type: String
- resourceGroupName
  Resource group of the target Azure Container Service.
  - Type: String
- containerService
  The name of the Azure Container Service. Refer to the following documentation on how to setup Azure Container Service:
  - Deploy Kubernetes cluster for Linux containers
  - Deploy a DC/OS cluster
  - Type: 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.
  - Type: 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.
  - Type: String
- containerRegistryCredentials (optional)
  All the credentials needed for pulling images from private repositories. Specify multiple entries if your deployments need to pull images from multiple, private repositories that require authentication.
  - url
    URL to the Docker registry you are using. May be left blank to use the public DockerHub registry (currently https://index.docker.io/v1/).
    - Type: String
  - credentialsId
    - Type: 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.
  - Type: 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
  - Type: String
- enableConfigSubstitution (optional)
  Substitute variables (in the form $VARIABLE or ${VARIABLE}) in the configuration with values from Jenkins environment variables.
  This allows you to use dynamic values produced during the build in your Kubernetes or DC/OS configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.
  - Type: boolean
- secretName (optional)
  The secret name that you can use in the Kubernetes Deployment configuration for the 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.
  - Type: String
- secretNamespace (optional)
  The Kubernetes namespace in which the secrets will be created with the credentials configured below.
  - Type: String
- swarmRemoveContainersFirst (optional)
  Stop and remove containers first.
  - Type: boolean

$class: 'AWSEBBuilder'

extensions
- awsRegion
  AWS Region (e.g. us-east-1) This will be the default if no valid environments are provided in the Regions field.
  - Values: 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
  AWS Region (e.g. us-east-1) Needs to match an environment name. If one is missing, write an issue so we can update the aws sdk.
  - Type: String
- credentialsString
  - Type: String
- credentialsText
  Use a credentials name that will be resolved during the build.
  - Type: String
- applicationName
  AWS EB Application Name (e.g.: "myapp")
  - Type: String
- versionLabelFormat
  How to set the version label? For instance, for "${GIT_COMMIT}-${BUILD_TAG}", and with "Key Prefix" set to "myapp/builds/myapp-prod-env/", the S3 Object Key is set to myapp/builds/myapp-prod-env/4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41.zip and the version Label will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41 on AWS EB Application Versions
  - Type: String
- failOnError
  If any of the environments fail to update, or if there are no matching environments then fail the build.
  - Type: boolean
- extensions
  - $class: 'AWSEBElasticBeanstalkSetup'
  - $class: 'AWSEBS3Setup'
  - $class: 'ByName'
  - $class: 'ByUrl'
- envLookup
  - $class: 'AWSEBElasticBeanstalkSetup'
  - $class: 'AWSEBS3Setup'
  - $class: 'ByName'
  - $class: 'ByUrl'

$class: 'AWSEBDeploymentBuilder'

credentialId
Select the credentials to use.
- Type: String
awsRegion
AWS Region (e.g. us-east-1)
- Type: String
applicationName
AWS EB Application Name (e.g.: "myapp")
- Type: String
environmentName
Optional: AWS EB Environment name(s) to deploy to.

Can accept single or multiple comma-separated values. Examples:
- "my-prod-env" (single environment)
- "my-dev-env,my-staging-env" (multiple environments)
When this value is set and each requested environment exists, an UpdateEnvironment call will be triggered as the Application Version is created.
- Type: String
bucketName

S3 Bucket Name to Upload to (e.g. "my-awseb-apps")

(Optional, will call createStorageLocation if blank)
- Type: String
keyPrefix
Prefix for newly created apps on S3 Bucket. For Example, myapp/builds/myapp-prod-env/
- Type: String
versionLabelFormat
How to set the version label? For instance, for "${GIT_COMMIT}-${BUILD_TAG}", and with "Key Prefix" set to "myapp/builds/myapp-prod-env/", the S3 Object Key is set to myapp/builds/myapp-prod-env/4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41.zip and the version Label will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746-myjob-41 on AWS EB Application Versions
- Type: String
versionDescriptionFormat
How to set the version description? For instance, for "${GIT_COMMIT}", the version Description will be 4b5f7669b3376a1ce504bf7ef8bf7aeee9d21746 on AWS EB Application Versions
- Type: 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:
- File, like target/mywebapp.war: The war file will be uploaded
- A Directory, like '.' or 'target/war': A Zip file will be built and uploaded instead (using includes and excludes).
- Type: String
includes
Optional (if rootObject points to a directory): Glob for Zip Includes, comma-separated like 'target/file,target/myapp/**/*'
- Type: String
excludes
Optional (if rootObject points to a directory): Glob for Zip Excludes, comma-separated eg '**/.git/**/*,**/node_modules/**/*'
- Type: String
zeroDowntime
- Type: boolean
sleepTime
- Type: int
checkHealth
Uncheck this to disable the Health check on deploy. Some implementations may not care to wait until the environment shows "Green".
- Type: boolean
maxAttempts
- Type: int

$class: 'ActionHubPlugin'

$class: 'AddTestToSetStep'

domain
HP ALM Domain
- Type: String
project
HP ALM Project name
- Type: String
testPlanPath
Path to a test or test folder in HP ALM which shall be added to a test set
- Type: String
testSetPath
Path to a test set in HP ALM into which test(s) shall be added
- Type: String

$class: 'AmxEclipseAntBuilder'

targets
Specify a list of Ant targets to be invoked over Tibco amx_eclipse_ant wrapper, or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
- Type: String
name
For projects that need to use TIBCO amx_eclipse_ant wrapper as the build system. This causes Jenkins to invoke amx_eclipse_ant with the given targets and options. Any non-zero exit code causes Jenkins to mark the build as a failure.
Jenkins supplies some environment variables that can be used from within the build script.
- Type: String
antOpts
If your build requires a custom ANT_OPTS, specify it here. Please refer to TIBCO Documentation for any detail
- Type: String
buildFile
If your build requires a custom -buildfile, specify it here. By default amx_eclipse_ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory. Please refer to TIBCO Documentation for any detail
- Type: String
properties
Properties needed by your ant build can be specified here (in standard properties file format):
```
# comment
name1=value1
name2=$VAR2
```
These 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
- Type: String
amxEclipseAntTra
If your build requires a custom TRA properties file, specify it here. Please refer to TIBCO Documentation for any detail.
- Type: String
businessStudioWs
If your build requires a custom Business Studio workspace to use, specify it here. By default amx_eclipse_ant use user home as location for "workspace"" creation. this option force amx_eclipse_ant to use a custom workspace by flag "-data 'your-custom-ws'" Please refer to TIBCO Documentation for any detail.
- Type: String

anchore

name
Name of the file that contains a list of container images for anchore to analyze, evaluate policy, and run queries against. The format for each line is "imageId /path/to/Dockerfile", where the Dockerfile is optional. This file must be made available (created by a prior step) to Anchore Container Image Scanner plugin.
- Type: String
anchoreioPass (optional)
Your password for the associated username on https://anchore.io
- Type: String
anchoreioUser (optional)
Your username on https://anchore.io that has access to a custom policy bundle to sync with your local anchore installation
- Type: String
annotations (optional)
- key
  - Type: String
- value
  - Type: String
autoSubscribeTagUpdates (optional)
If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Engine to automatically begin watching the added tag for updates from registry. Default value: 'true'
- Type: boolean
bailOnFail (optional)
If selected or set to 'true', the Anchore Container Image Scanner step will cause the build to fail if the policy evaluation result is FAIL. Default value: 'true'
- Type: boolean
bailOnPluginFail (optional)
If selected or set to 'true', the Anchore Container Image Scanner step will cause the build to fail if the plugin encounters an error. Default value: 'true'
- Type: boolean
bailOnWarn (optional)
If selected or set to 'true', the Anchore Container Image Scanner step will cause the build to fail if the policy check result is WARN. Default value: 'false'
- Type: boolean
bundleFileOverride (optional)
Name of the file that contains a custom anchore policy bundle to be used by Anchore policy evaluation engine. If this file does not exist or the field is left blank, anchore will attempt to use any previously synced/cached policy bundles that you may have, or will fail evaluation if no bundle can be found or used.
- Type: String
doCleanup (optional)
If selected or set to 'true', all images in the input file will be flushed from the Anchore database at the end of plugin execution. Default value: 'false'
- Type: boolean
engineCredentialsId (optional)
- Type: String
engineRetries (optional)
Number of polling attempts spaced at 5 second intervals spent waiting for the Anchore Engine operation to complete.
- Type: String
engineurl (optional)
Anchore Engine URL
- Type: String
engineverify (optional)
- Type: boolean
forceAnalyze (optional)
If selected or set to 'true', the Anchore Container Image Scanner step will instruct Anchore Engine to force analyze the image. Default value: 'false'
- Type: boolean
globalWhiteList (optional)
Name of the file that contains a custom whitelist to be used by Anchore policy evaluation engine. If this file does not exist or the field is left blank, Anchore will use its default global whitelist.
- Type: String
inputQueries (optional)
- query
  Any query that Anchore supports. Results of the query will be added to the anchore report upon plugin completion.
  - Type: String
policyBundleId (optional)
ID of the policy bundle on Anchore Engine to be used for policy evaluations. If empty, the policy bundle marked active on Anchore Engine will be used by default.
- Type: String
policyEvalMethod (optional)
- Type: String
policyName (optional)
Name of the file that contains a custom policy to be used by Anchore policy evaluation engine. If this file does not exist or the field is left blank, Anchore will use its default policy.
- Type: String
useCachedBundle (optional)
Check this in order to use a previously synced policy bundle (if one exists) in the case where login to anchore.io or bundle sync fails for any reason.
- Type: boolean
userScripts (optional)
Optional directory that contains user defined Anchore analyzer/gate/query modules that will be executed in addition to the built in analyzer/gate/queries modules. If this directory does not exist or the field is left blank, Anchore will run only its default modules.
- Type: String

$class: 'AnsibleAdHocCommandBuilder'

hostPattern
The host or set of hosts on which the command will be executed. For more details see the ansible documentation for Patterns.
- Type: String
inventory
- $class: 'InventoryContent'
- $class: 'InventoryDoNotSpecify'
- $class: 'InventoryPath'
module
Module name to execute. The shell module is used when left empty.
- Type: String
command
Module arguments or shell command to execute
- Type: String
additionalParameters (optional)
Any additional parameters to pass to the ansible command.
Warning:
The content of this textbox will be passed as is to the command line.
- Type: String
ansibleName (optional)
- Type: String
becomeUser (optional)
Desired become user. "root" is used when this field is empty.
- Type: String
colorizedOutput (optional)
Check this box to allow ansible to render ANSI color codes in the Jenkins console. This option works well with the Jenkins AnsiColor plugin.
- Type: boolean
credentialsId (optional)
Select the credentials for the SSH connections. Only private key authentication is supported.
- Type: String
disableHostKeyChecking (optional)
Check this box if you really want to disable the validation of the hosts SSH server keys.
- Type: boolean
extraVars (optional)
- hidden (optional)
  - Type: boolean
- key (optional)
  - Type: String
- value (optional)
  - Type: String
forks (optional)
Specify number of parallel processes to use. Set to 0 to use the default value.
- Type: int
hostKeyChecking (optional)
- Type: boolean
sudo (optional)
Run operations with sudo. It works only when the remote user is sudoer with nopasswd option. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- Type: boolean
sudoUser (optional)
Desired sudo user. "root" is used when this field is empty. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- Type: String
unbufferedOutput (optional)
Skip standard output buffering for the ansible process. The ansible output is directly rendered into the Jenkins console. This option can be usefull for long running operations.
- Type: boolean
vaultCredentialsId (optional)
Select the credentials for vault encrypted vars. Only secret file and secret text are supported.
- Type: String

$class: 'AnsiblePlaybookBuilder'

playbook
Path to the ansible playbook file. The path can be absolute or relative to the job workspace.
- Type: String
inventory
- $class: 'InventoryContent'
- $class: 'InventoryDoNotSpecify'
- $class: 'InventoryPath'
additionalParameters (optional)
Any additional parameters to pass to the ansible command.
Warning:
The content of this textbox will be passed as is to the command line.
- Type: String
ansibleName (optional)
- Type: String
becomeUser (optional)
Desired become user. "root" is used when this field is empty.
- Type: String
colorizedOutput (optional)
Check this box to allow ansible to render ANSI color codes in the Jenkins console. This option works well with the Jenkins AnsiColor plugin.
- Type: boolean
credentialsId (optional)
Select the credentials for the SSH connections. Only private key authentication is supported.
- Type: String
disableHostKeyChecking (optional)
Check this box if you really want to disable the validation of the hosts SSH server keys.
- Type: boolean
extraVars (optional)
- hidden (optional)
  - Type: boolean
- key (optional)
  - Type: String
- value (optional)
  - Type: String
forks (optional)
Specify number of parallel processes to use. Set to 0 to use the default value.
- Type: int
hostKeyChecking (optional)
- Type: boolean
limit (optional)
Further limit selected hosts to an additional pattern.
- Type: String
skippedTags (optional)
only run plays and tasks whose tags do not match these values.
- Type: String
startAtTask (optional)
Start the playbook at the task matching this name.
- Type: String
sudo (optional)
Run operations with sudo. It works only when the remote user is sudoer with nopasswd option. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- Type: boolean
sudoUser (optional)
Desired sudo user. "root" is used when this field is empty. Sudo has been deprecated in favor of become and will be removed in Ansible 2.6.
- Type: String
tags (optional)
Only run plays and tasks tagged with these values.
- Type: String
unbufferedOutput (optional)
Skip standard output buffering for the ansible process. The ansible output is directly rendered into the Jenkins console. This option can be usefull for long running operations.
- Type: boolean
vaultCredentialsId (optional)
Select the credentials for vault encrypted vars. Only secret file and secret text are supported.
- Type: String

$class: 'AnsibleTower'

towerServer (optional)
- Type: String
jobTemplate (optional)
- Type: String
jobType (optional)
- Type: String
extraVars (optional)
- Type: String
jobTags (optional)
- Type: String
skipJobTags (optional)
- Type: String
limit (optional)
- Type: String
inventory (optional)
- Type: String
credential (optional)
- Type: String
verbose (optional)
- Type: boolean
importTowerLogs (optional)
- Type: boolean
removeColor (optional)
- Type: boolean
templateType (optional)
- Type: String
importWorkflowChildLogs (optional)
- Type: boolean

$class: 'AnsibleVaultBuilder'

action (optional)
Desired vault action.
- Type: String
ansibleName (optional)
- Type: String
content (optional)
Desired encrypted content.
- Type: String
input (optional)
Desired input file to encrypt.
- Type: String
newVaultCredentialsId (optional)
Select the credentials for rekeying vault encrypted files. Only Jenkins secret file and secret text are supported.
- Type: String
output (optional)
Desired output file for encrypted content.
- Type: String
vaultCredentialsId (optional)
Select the credentials for vault encrypted vars. Only Jenkins secret file and secret text are supported.
- Type: String

ant

For projects that use Ant as the build system. This causes Jenkins to invoke Ant with the given targets and options. Any non-zero exit code causes Jenkins to mark the build as a failure.

Jenkins supplies some environment variables that can be used from within the build script.

targets
Specify a list of Ant targets to be invoked (separated by spaces), or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
- Type: String
antName
- Type: String
antOpts
If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
- Type: String
buildFile
If your build requires a custom -buildfile, specify it here. By default Ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
- Type: String
properties
Properties needed by your ant build can be specified here (in standard properties file format):
```
# comment
name1=value1
name2=$VAR2
```
These 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=
- Type: String

$class: 'AntExec'

scriptSource
Runs entered Apache Ant tasks as a build file with only one target, untill you write code into the "Extended script source", but the target created from this code will always be the default target of the created build file.

The script will run with WORKSPACE as the current directory. Build will be considered as failure if any Ant task fails. You can use Ant-Contrib tasks (if it is enabled in global configuration). You need to use namespace "antcontrib" (example: "<antcontrib:if>").
- Type: String
extendedScriptSource
Into this field you can enter a code, you could not able to enter into the previous field, as it should not appear within the Ant target. The entries can be other targets, import/include tasks etc. With this extension you are able to create more complex Ant build file with just one limitation - the first field (textarea) must always be used for default Ant target. This field is optional.
- Type: String
scriptName
Here you can enter the name for your new script. The name will be also used for default Ant target. This build file will then have a name that differs from the default name, so it will not be overwritten by the upcoming build step and therefore it might be used repeatedly, or it can be included/imported.
- Type: String
properties
Properties needed by your ant build can be specified here (in standard properties file format):
```
# comment
name1=value1
name2=$VAR2
```
These 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=
- Type: String
antName
- Type: String
antOpts
If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m.
Note that other Ant options (such as -lib) should not be here.
- Type: String
keepBuildfile
- Type: boolean
verbose
- Type: boolean
emacs
- Type: boolean
noAntcontrib

Disabling usage of Ant-Contrib Tasks in this build step.
- Type: boolean

antws

For projects that use Ant as the build system. This causes Jenkins to invoke Ant with the given targets and options. Any non-zero exit code causes Jenkins to mark the build as a failure.

Jenkins supplies some environment variables that can be used from within the build script.

targets
Specify a list of Ant targets to be invoked (separated by spaces), or leave it empty to invoke the default Ant target specified in the build script. Additionally, you can also use this field to specify other Ant options.
- Type: String
antName
- Type: String
antOpts
If your build requires a custom ANT_OPTS, specify it here. Typically this may be used to specify java memory limits to use, for example -Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
- Type: String
buildFile
If your build requires a custom -buildfile, specify it here. By default Ant will use the build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
- Type: String
properties
Properties needed by your ant build can be specified here (in standard properties file format):
```
# comment
name1=value1
name2=$VAR2
```
These 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=
- Type: String

$class: 'ApiFortressBuilder'

mode
When running in single test mode, once specific test will run. When running in automatch mode, a collection of tests will run.
- Type: String
hook
The API Hook URL.
API Hooks are unique urls connected to projects. They provide access to API Fortress automation API and will allow you to run tests.
You can create one in the API Fortress Company dashboard.
- Type: String
id
Test ID
When running in Single Test mode, you have to provide the ID of the test you want to run. You can find this information in the interstitial page of the test.
Automatch URL
When running in Automatch mode, introduce here the URL of the resource that you are willing to test.
Tag
When running in tag mode, introduce the tag of the tests you want to run.
Project
When running in project mode, no value is required.
- Type: String
blocking
Set this flag is a test failure must determine a build failure.
- Type: boolean
dryrun
Set this flag if you don't want the event to be stored in API Fortress.
- Type: boolean
silent
Set this flag if a failure should not generate API Fortress alerts.
- Type: boolean
param1name
- Type: String
param1value
- Type: String
param2name
- Type: String
param2value
- Type: String
param3name
- Type: String
param3value
- Type: String

$class: 'AppClone'

Clones an app template to a new Heroku app.

apiKey
- Type: String
appName
The name of the new app to create from the template.
- Type: String
templateAppName
The name of the template app to clone.
- Type: String

appscan

scanner
- dynamic_analyzer
- mobile_analyzer
- static_analyzer
name
- Type: String
type
- Type: String
application
- Type: String
credentials
- Type: String
email (optional)
- Type: boolean
failBuild (optional)
- Type: boolean
failBuildNonCompliance (optional)
- Type: boolean
failureConditions (optional)
- failureType
  - Type: String
- threshold
  - Type: int
target (optional)
- Type: String
wait (optional)
- Type: boolean

$class: 'AppScanSourceBuilder'

disableScan
- Type: boolean
applicationFile
- Type: String
acceptSSL
- Type: 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.
- Type: String
installation (optional)
- Type: String

$class: 'AppScanStandardBuilder'

startingURL
Insert the URL that you want AppScan Standard to start scanning from.
Spiders will find the remaining URLs in the domain to be included for scanning.
- Type: String
installation
- Type: String

additionalCommands (optional)

Provide additional and optional commands to run on AppScan Standard CLI.

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

Type: String

authScan (optional)
Checking this option will allow AppScan Stardard to spider and scan a website using authentication, optimizing the results obtained in the report.
If the website contains private information accessed only by logging in this option should be checked and credentials provided to increase dynamic security coverage.
- Type: boolean
authScanPw (optional)
Provide the password corresponding to the account's user name inserted above.
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
- Type: String
authScanRadio (optional)
Check "Recorded Login Sequence" if you have one for the website, this is, for the majority of the cases, the most reliable option for authenticated scanning.
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.
- Type: boolean
authScanUser (optional)
Provide the user name of an account with access to the private functionalities of the website.
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
- Type: String
generateReport (optional)
Check this option if you want AppScan Standard to generate a report after scannning.
The report is available in HTML and PDF.

The HTML report generated is ready to be integrated with the HTML Publisher Plugin.
- Type: boolean
htmlReport (optional)
This report can be integrated with the HTML Publisher Plugin.
- Type: boolean
includeURLS (optional)
This is used to include URLs for scanning,
Some URLs might not be found by AppScan Standard's spiders, include them to get the best possible coverage.
- Type: String
pathRecordedLoginSequence (optional)
Provide the full path to the recorded login sequence file (.login). More info. at: (9.0.3.2 User Guide) Login Management view - Chapter 4 - Configuring - Page 45 http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
- Type: String
pdfReport (optional)
A PDF report is generated.
- Type: boolean
policyFile (optional)
Provide the Path to a Test Policy File (.policy) to determine which type of flaws to scan for.
A Test Policy File can be created following these steps:

"Scan" > "Scan Configuration" > "Test Policy" > "Export".
- Type: String
reportName (optional)
Provide the name to save the report with.
To configure HTML Publisher Plugin properly, the names in the configuration must match.
- Type: String
verbose (optional)
Selecting this option will enable AppScan Standards' verbose, printing the full scan output in Jenkins log.
- Type: boolean

xooa

name
Xooa Jenkins
- Type: String
appId
- Type: String

$class: 'AppUploaderBuilder'

buildFilePath
Please specify the absolute path or relative to the app(.apk or .ipa) file to be uploaded.
The app_url of the uploaded app can be accessed from the environment variable BROWSERSTACK_APP_ID.
- Type: String

applatix

axUrl
The URL of Applatix system. For example: https://applatix.yourcompany.com
- Type: String
axUsername
Applatix credential: username
- Type: String
axPassword
Applatix credential: password
- Type: String
axServiceTemplateName
- Type: String
axServiceTemplateRepository
The repository where your Service Template is.
- Type: String
axServiceTemplateBranch
The branch where your Service Template is.
- Type: String
axServiceTemplateParameters
The parameters of your Service Template at Applatix system. It is optional. It is in JSON format, for example: {"service": "service_name", "iterations": 3 }
- key
  - Type: String
- value
  - Type: String

$class: 'ApprendaBuilder'

appAlias
The Applicaton Alias to be used.
- Type: String
appName
The Applicaton Name to be used.
- Type: String
versionAlias
The application Version Alias to target.
- Type: String
stage
The desired Apprenda Application lifecycle Stage.
- Type: String
artifactName
The filename of the Apprenda Application Package. For example myapplication.zip.
- Type: String
credentialsId
- Type: String
prefix
The Version Alias prefix to be used. Apprenda will append a number to the prefix to complete the Version Alias.
- Type: String
advVersionAliasToBeForced
The complete Version Alias, including the Version prefix and Version number to be used. For example v23.
- Type: String
advancedNewVersionOption
- Type: String
customPackageDirectory
The full path to the folder that contains the Apprenda Application Package defined in the Artifact Name.
- Type: String
applicationPackageURL
The complete URL to the Apprenda Application Package, starting with http:// or https://.
- Type: String
archiveUploadMethod
- Type: String
buildWithParameters
Check this box if you are using a parameterized project and want the Apprenda build step to do the substitution of variables from parameters.
- Type: boolean

aqua

locationType
- Type: String
registry
Name of a Docker registry that is defined in the Aqua Management Console. E.g. Docker Hub.
- Type: String
register
- Type: boolean
localImage
Path of local Docker image, including tag. E.g. my_ubuntu:latest
- Type: String
hostedImage
Path of Docker image on registry, including tag. E.g. google/mysql:latest
- Type: String
onDisallowed
- Type: String
notCompliesCmd
A shell command to execute when image does not comply with Aqua security policy
- Type: String
hideBase
- Type: boolean
showNegligible
- Type: boolean
policies
Comma separated names of image assurance policies. Available for only for local images and with scanner cli > v3.2.
- Type: String
customFlags
- Type: String

aquaMicroscanner

imageName
- Type: String
onDisallowed
- Type: String
notCompliesCmd
A shell command to execute when image does not comply with Aqua security policy
- Type: String
outputFormat
- Type: String

aquaServerlessScanner

onDisallowed
- Type: String
notCompliesCmd
- Type: String
codeScanPath
- Type: String
customFlags
- Type: String

arachniScanner

url
URL of the system under scan.
- Type: String
checks
Here you can specify a comma separated list with the checks to load. Or leave it blank to load all checks.
- Type: String
scope
- pageLimit
  Set the scope property page_limit. See Arachni Security Scanner Wiki for more information.
  - Type: int
- excludePathPattern
  Set the scope property exclude_path_patterns. See Arachni Security Scanner Wiki for more information.
  - Type: String
userConfig
- filename
  Name of the file with your own configuration in json format. Specify an absolute path or a relative to workspace.
  - Type: String
format
- Type: String

$class: 'ArtifactPromotionBuilder'

groupId
- Type: String
artifactId
- Type: String
classifier
- Type: String
version
- Type: String
extension
- Type: String
stagingRepository
- Type: String
stagingUser
- Type: String
stagingPW
- Type: String
releaseUser
- Type: String
releasePW
- Type: String
releaseRepository
- Type: String
promoterClass
- Type: String
debug
- Type: 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.
- Type: 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:

GroupId: This is generally unique amongst an organization or a project.
ArtifactId: The artifactId is generally the name that the project is known by.
Version: The version of the artifact to be resolved. The dynamic definitions 'RELEASE' (the latest release) and 'LATEST' (the latest build) are allowed too.
Classifier: It is some optional and arbitrary string that - if present - is appended to the artifact name just after the version number.
Extension: This is the extension of the artifact to be resolved. Important: this is not always the same as 'packaging' in maven! (although it might be the same e.g. for 'jar')
Target file name: should the file have a different name after downloading? You can also define a subdirectory.

artifacts
- groupId
  - Type: String
- artifactId
  - Type: String
- version
  - Type: String
- classifier (optional)
  - Type: String
- extension (optional)
  - Type: String
- targetFileName (optional)
  - Type: String
enableRepoLogging (optional)
- Type: boolean
failOnError (optional)
- Type: boolean
releaseChecksumPolicy (optional)
- Type: String
releaseUpdatePolicy (optional)
- Type: String
snapshotChecksumPolicy (optional)
- Type: String
snapshotUpdatePolicy (optional)
- Type: String
targetDirectory (optional)
- Type: String

$class: 'ArtifactsUploadBuilder'

projectName
Name of source project for uploading of artifact(s).
If a Maven project is specified, artifacts from all of its modules will be uploaded. Enter JOBNAME/MODULENAME here to upload from a particular module; you may copy/paste this from the URL for that module when browsing Jenkins. Example: MyMavenJob/my.group$MyModule
If a multiconfiguration (matrix) project is specified, artifacts from all of its configurations will be uploaded, each into a subdirectory with the name of the configuration as seen in its URL when browsing Jenkins. Example: If target directory is given as fromMatrix then the upload could create $WORKSPACE/fromMatrix/label=slaveA/dist/mybuild.jar and $WORKSPACE/fromMatrix/label=slaveB/dist/mybuild.jar.
To upload from a particular configuration, enter JOBNAME/AXIS=VALUE,.. as seen in the URL for that configuration. Example: MyMatrixJob/jdk=Java6u17
To upload artifacts from one matrix project to another, use a parameter to select the matching configuration in the source project. Example: OtherMatrixJob/jdk=$jdk
- Type: String
parameters
Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.
- Type: String
selector
- $class: 'ParameterizedBuildSelector'
- $class: 'PermalinkBuildSelector'
- $class: 'SavedBuildSelector'
- $class: 'SpecificBuildSelector'
- $class: 'StatusBuildSelector'
- $class: 'TriggeredBuildSelector'
- $class: 'WorkspaceSelector'
filter
Relative paths to artifact(s) to upload or leave blank to upload all artifacts. Check the /artifact/ browser of a build to see the relative paths to use here, as the build page typically hides intermediate directories. Can use wildcards like module/dist/**/*.zip, and use comma (followed by optional whitespace) to separate multiple entries. See the @includes of Ant fileset for the exact format. May also contain references to build parameters like $PARAM.
- Type: String
target
- Type: String
flatten
- Type: boolean
optional
- Type: boolean
fingerprintArtifacts
- Type: 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.
- Type: String

assertthatBddFeatures

projectId
Jira project id.
- Type: String
credentialsId
- Type: String
outputFolder

Output folder for feature files withing workspace. Default ./features/.
By default features are downloaded to the root of the workspace.
- Type: String
jql
- Type: String
mode
- Type: String

$class: 'AssetBuilder'

name
- Type: String
description
- Type: String
version
- Type: String
vendor
- Type: String
platform
- Type: String
architecture
- Type: String
bits
- Type: String
cpu
- Type: int
memory
- Type: int
storage
- Type: int
installationScriptFilePath
- Type: String
mediaFilePaths
- path
  - Type: String
licenseFilePath
- Type: String
documentationFilePath
- Type: String

associateTag

nexusInstanceId
- Type: String
tagName
The tag which will be applied to components matching the specified search criteria
- Type: String
search
The search criteria used to locate components on the target Nexus Repository Manager server. For more details, please see Search API
- key
  - Type: String
- value
  - Type: String

$class: 'AstreeBuilder'

dax_file
Absolute path to the DAX file containing the analysis specification and configuration.
Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
Paths and environment variables are evaluated on the machine running Jenkins.
- Type: String
analysis_id
ID of an existing, preconfigured analysis on the Astrée server that serves as a revisioning base for the analyses of the current Jenkins project. The analysis, as configured via the supported DAX file, of a build is imported as a new revision into the project with this ID on the server, if such a project exists. The new revision will become a child revision of the last existing revision. If no project with this ID exists on the server, the analysis will become the first revision of a new project with the specified ID.
Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
- Type: String
output_dir
Absolute path to the folder into which the Summary Reports are to be generated. If left empty, reports will be generated into the project's Workspace directory and will be accessible from the Jenkins web interface.
Note: In this setting, environment variables can be expanded. Expansion will affect all occurrences of the pattern ${name} where name is a valid environment variable name consisting solely of underscores, digits, and alphabetics from the portable character set and where the first character is not a digit.
- Type: String
skip_analysis
This switch can be used to deactivate the Astrée analysis build step. This switch provides a more convenient method to temporarily deactivate analysis runs than removing the entire build step and reconfiguring the Astrée analysis run from scratch when later adding the build step again.
- Type: boolean
genXMLOverview
- Type: boolean
genXMLCoverage
- Type: boolean
genXMLAlarmsByOccurence
- Type: boolean
genXMLAlarmsByCategory
- Type: boolean
genXMLAlarmsByFile
- Type: boolean
genXMLRulechecks
- Type: boolean
dropAnalysis
When this option is activated, the analysis is not stored on the Astrée server, instead it is automatically deleted after the analysis run of the build step.
This option is very helpful if the analysis run is only specified by a DAX file and it is not intended to archive each analysis run on the server.
Please be aware that using this option in an analysis run only specified by an analysis ID will result in deleting the analysis with that ID on the Astrée server.
This option corresponds to adding a --drop to a command line call to Astrée.
- Type: boolean
genPreprocessOutput
- Type: boolean
failonswitch
This option allow Astrée to fail a build depeneding on the types of detected code defects. The following settings are available:
- Only Errors
  ... lets Astrée fail a build if an Error (Definite Type A Alarm) is reported.
  This is the preferred setting for most use cases. A build is failed if Astrée can formally show the presence of a severe code defect in a (analysis) context.
- Errors and Alarms
  ... lets Astrée fail a build if an Error or Alarm (Definite Type A Alarm or Potential Alarm of Type B or Type C) is reported.
  This is the preferred setting in case the absence of runtime errors in an application is to be formally shown. A build is failed if Astrée reports potential runtime errors.
- Errors, Alarms, and Data-Flow Anomalies
  ... lets Astrée fail a build if and only if any type of alarm (definite/potential Type A, B, C or D) is reported.
  This setting fails builds on any reported potential code defect or anomaly.
- failon
  - Type: String

$class: 'AutEnvironmentBuilder'

autEnvironmentModel
- almServerName
  - Type: String
- almUserName
  - Type: String
- almPassword
  - Type: String
- almDomain
  - Type: String
- almProject
  - Type: String
- clientType
  Client type should be provided if your server is ALM version 12.60 or above.
  - Type: String
- autEnvironmentId
  Assign ID of an AUT Environment that exists in the ALM project you selected.
  - Type: String
- useExistingAutEnvConf
  - Type: boolean
- existingAutEnvConfId
  - Type: String
- createNewAutEnvConf
  - Type: boolean
- newAutEnvConfName
  - Type: String
- autEnvironmentParameters
  - name
    The name must be set in the same hierarchical structure as it defined in ALM ( 'Parameters' tab of the AUT Environment)
    For example: 'Parameters/DB_Setting/Oracle/username'
    - Type: String
  - value
    If you are using a 'From JSON' type, specify here the path for the element you would like to get.
    Make sure you are using JsonPath style for defining it.
    - Type: String
  - paramType
    Manual - the value you'll assign for 'Parameter value' field will be used as is.
    Environmnet - the value you'll assign for 'Parameter value' will be looked for in the environment parameters and the resolved value will be used. If you named your parameter 'my_parameter' put here 'my_parameter' (exactly the same value).
    From JSON - the value you'll assign for 'Parameter value' will be looked for in the JSON file you specified for the 'Path to JSON file' entry.
    - Type: String
  - shouldGetOnlyFirstValueFromJson
    - Type: boolean
- pathToJsonFile
  A path to the JSON file that will be loaded in order to assign values to all the AUT Environment Parameters of 'From JSON' type.
  - Type: String
- outputParameter
  The name of the build environment parameter that will get the ID of the updated/created AUT Environment Configuration. It then can be used as a parameter for following build steps.
  The parameter must be a String Parameter.
  If you named your parameter 'output_parameter' put here 'output_parameter' (exactly the same value).
  - Type: String

$class: 'AutoConfigBuilder'

name
- Type: String
discobitUrl
- Type: String
discobitUser
- Type: String
discobitPassword
configurations
- Type: String
cuuid
- Type: String

$class: 'AwsBatchBuilder'

jobname
- Type: String
jobdefinition
- Type: String
command
- Type: String
jobqueue
- Type: String
vcpu
- Type: String
memory
- Type: String
retries
- Type: String

azureCLI

principalCredentialId
The Service Principal credentials required to connect to your Azure account.
More information can be found here: https://github.com/Azure/azure-devops-utils#user-content-create-service-principal
If you want to add an Azure credential click "Add" and select "Microsoft Azure Service Principal" from the Kind drop-down.
If you want to remove existing Azure credentials you must go to the Credentials Dashboard.
- Type: String
commands
- script
  - Type: String
- exportVariablesString
  Export the output of the command to environment variables
  The format: /"variable from JSON" | "desired environment variable name"
  For example: Output: { "id": "/subscriptions/some-guid/resourceGroups/test", "location": "northeurope", "managedBy": null, "name": "test", "properties": { "provisioningState": "Succeeded" }, "tags": null } Environment Variable String: /location|LOCATION , /name|NAME
  - Type: String

azureDownload

storageCredentialId
- Type: String
downloadType
- Type: String
buildSelector (optional)
- downstream
- lastWithArtifacts
- lastCompleted
- $class: 'MultiJobBuildSelector'
- buildParameter
- permalink
- $class: 'PromotedBuildSelector'
- latestSavedBuild
- specific
- lastSuccessful
- upstream
- workspace
containerName (optional)
Enter a storage container name.
Environment variables can also be referenced.
For example: ${JOB_NAME}
- Type: String
deleteFromAzureAfterDownload (optional)
If checked, the file copy on Azure will be removed after it's downloaded to local.
- Type: boolean
downloadDirLoc (optional)
Enter a download path. If not specified, the files will be downloaded into the job's workspace.
Environment variables can also be referenced, for example: ${JOB_NAME} If "Flatten Directories" is checked, this directory will contain all outputs.
- Type: String
excludeFilesPattern (optional)
Enter a pattern of blobs to exclude from the download. Ant fileset syntax. Leaving blank will download the entire container. Environment variables can also be referenced.
For example: ${JOB_NAME}
- Type: String
fileShare (optional)
Enter a Azure File Storage Share name.
Environment variables can also be referenced.
For example: ${JOB_NAME}
- Type: String
flattenDirectories (optional)
If checked, all files specified for download will be flattened to the single download directory. If two files are named the same in different directories, only one will remain.
- Type: boolean
includeArchiveZips (optional)
The archive zip files generated (archive.zip in the root of the container/virtual path) are typically excluded from download. Check this to enable downloading of the archive zip.
- Type: boolean
includeFilesPattern (optional)
Enter a pattern of blobs to download. Ant fileset syntax. Environment variables can also be referenced.
For example: ${JOB_NAME}
- Type: String
projectName (optional)
The name of the project to download the managed artifact from.
- Type: String

$class: 'BDSBuilder'

projectFile
- Type: String
switches
- Type: String
installationName
- Type: String

$class: 'BapFtpBuilder'

Send files over FTP as a build step during the build

publishers

Array/List

Nested Object

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.
- Type: String
verbose
Select to enable logging of all commands sent to, and responses received from the FTP server in the Jenkins console.
- Type: boolean

transfers

Array/List

Nested Object

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.
- Type: 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)
- Type: 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.
- Type: 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.
- Type: 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.
- Type: boolean

remoteDirectorySDF

Select this to include the timestamp in the remote directory.

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`

Type: 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.
- Type: boolean
cleanRemote

Select to delete all files and directories within the remote directory before transferring files.
- Type: boolean
noDefaultExcludes
- Type: 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.
- Type: 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.
- Type: 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
- Type: 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.
- Type: 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
  The number of times to retry this server in the event of failure
  - Type: int
- retryDelay
  The time to wait, in milliseconds, before attempting another transfer
  - Type: 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
  - Type: String
ftpCredentials
Set the username and password to use with this connection.
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
  - Type: String
- password
  - Type: String

continueOnError
- Type: boolean
failOnError
- Type: boolean
alwaysPublishFromMaster
- Type: boolean
masterNodeName
- Type: String
paramPublish
- parameterName
  The name of the parameter or environment variable that will contain the expression for matching the labels.
  - Type: String

$class: 'BapSshBuilderPlugin'

Send files or execute commands over SSH as a build step during the build

publishers

Array/List

Nested Object

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.
- Type: String
verbose
Select to enable an obscene amount of information to the Jenkins console - only really useful to help track down problems
- Type: boolean

transfers

Array/List

Nested Object

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.
- Type: 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)
- Type: 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.
- Type: 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.
- Type: String

remoteDirectorySDF

Select this to include the timestamp in the remote directory.

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`

Type: 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.
- Type: boolean
cleanRemote
- Type: boolean
noDefaultExcludes
- Type: 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.
- Type: 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.
- Type: 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.
- Type: String
execTimeout (optional)

Timeout in milliseconds for the Exec command

Set to zero to disable.
- Type: 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.

Type: 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.

Type: 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
- Type: 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.
- Type: 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
  The number of times to retry this server in the event of failure
  - Type: int
- retryDelay
  The time to wait, in milliseconds, before attempting another transfer
  - Type: 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
  - Type: String
sshCredentials
Set the credentials to use with this connection.
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
  The username to connect with.
  - Type: String
- encryptedPassphrase
  The passphrase for the private key, or the password for password authentication if no Key or Path to key is configured.
  Leave blank if the key is not encrypted.
  - Type: String
- key
  
  The private key.
  
  Paste the private key here, or provide the path to the file containing the key in Path to key.
  - Type: 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
  - Type: String

continueOnError
- Type: boolean
failOnError
- Type: boolean
alwaysPublishFromMaster
- Type: boolean
masterNodeName
- Type: String
paramPublish
- parameterName
  The name of the parameter or environment variable that will contain the expression for matching the labels.
  - Type: String

batchFile

command
- Type: String

$class: 'BeaglePlugin'

apptoken

Generate your Application Token From Beagle

Home -> Applications -> Select your Application -> Settings -> Application Token
usertoken

Generate your User Token From Beagle User Settings

Settings -> Access Token -> Generate Your New Personal Access Token

$class: 'BeakerBuilder'

jobSource
- $class: 'FileJobSource'
- $class: 'StringJobSource'
downloadFiles
- Type: boolean

benchmark

filepath
Please insert a filepath.
- Type: String

$class: 'BitbucketPublisher'

serverUrl (optional)
Bitbucket Server Url.
- Type: String
credentialsId (optional)
Credentials for bitucket server. The user must have access to create project and repository.
- Type: String
projectKey (optional)
Input the project key for the bitbucket.
- Type: String
createProject (optional)
Check this if you want to create the bitbucket project.
- projectName
  - Type: String
- projectUsers
  - Type: String
- projectGroups
  - Type: String
createJenkinsJobs (optional)
Check this if you want to use the bitbucket post commit external hook to call.
- ciServer
  - Type: String
projectName (optional)
Input name of the Bitbucket project.
- Type: String

$class: 'BlueprintLaunch'

projectName

Project selection is mandatory.
- Type: String
blueprintName

Blueprint selection is mandatory.
- Type: 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.
- Type: String
appProfileName

Application Profile selection is mandatory.
- Type: 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.
- Type: 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.
- Type: String
waitForSuccessFulLaunch
- Type: boolean
blueprintDescription

Description is fetched from the selected Calm blueprint
- Type: String

$class: 'BootPluginBuilder'

tasks
Provide a valid boot task, this could be a built in task or a user defined. Try 'boot help' for list of tasks.
- Type: String
jvmOpts
Specify JVM Options to be used within boot tasks.
- Type: String

$class: 'BranchDestructionStep'

project
- Type: String
branch
- Type: String

$class: 'BranchGenerationStep'

projectConfig
- pipelineConfig
  - destructor
    - Type: boolean
  - authorisations
    - Type: String
  - branchSCMParameter
    - Type: boolean
  - branchParameters
    - Type: String
  - generationExtension
    - Type: String
  - pipelineGenerationExtension
    - Type: String
  - disableDslScript
    - Type: boolean
  - scriptDirectory
    - Type: String
  - namingStrategy
    - projectFolderPath
      - Type: String
    - branchFolderPath
      - Type: String
    - projectSeedName
      - Type: String
    - projectDestructorName
      - Type: String
    - branchSeedName
      - Type: String
    - branchStartName
      - Type: String
    - branchName
      - Type: String
    - ignoredBranchPrefixes
      - Type: String
  - eventStrategy
    - delete
      - Type: boolean
    - auto
      - Type: boolean
    - trigger
      - Type: boolean
    - commit
      - Type: String
- project
  - Type: String
- scmType
  - Type: String
- scmUrl
  - Type: String
- scmCredentials
  - Type: String
- triggerIdentifier
  - Type: String
- triggerType
  - Type: String
- triggerSecret
  - Type: String

$class: 'BuildBuilder'

dbFolder
- value
  - Values: vcsroot, subfolder, scaproject
- subfolder
  - Type: String
- projectPath
  - Type: String
packageid
Enter an ID for the build artifact you want to build. Typically, this will be the same as your database name.
- Type: String
tempServer
- value
  - Type: String
- serverName
  - Type: String
- dbName
  - Type: String
- serverAuth
  - value
    - Type: String
  - username
    - Type: String
  - password
    - Type: String
options
- Type: String
filter
- Type: String
packageVersion
Optionally, set a custom package version. If this is left blank, the version 1.0.${BUILD_NUMBER} will be used.
- Type: String
dlmDashboard
- dlmDashboardHost
  - Type: String
- dlmDashboardPort
  - Type: String
sqlChangeAutomationVersionOption
- value
  - Values: Latest, Specific
- specificVersion
  - Type: String

buildDescription

Normally, build description is empty, but it can be changed by setting what name new build gets. This field can contain macros.

descriptionTemplate
- Type: String

buildName

Normally, builds are named by their sequential numbers, but you can change that here by setting what name new build gets. This field can contain macros.

nameTemplate
- Type: String

$class: 'BuildNameUpdater'

This plugin updates build name and description during the build process. Values to set could be stored in a file in the build workspace or in an environment variable.

fromFile
- Type: boolean
buildName
- Type: String
fromMacro
- Type: boolean
macroTemplate
- Type: String
macroFirst
- Type: boolean

crxBuild

packageId (optional)
Specify a list of package IDs to replicate from each specified Base URL. Each package ID string must occupy its own line.

A Package ID consists of the group, the name, and the version of a package, separated by colons (':'), as in: "group:name:version". The version may be omitted.

This field supports parameter tokens.
- Type: String
baseUrl (optional)
Specify the base URL of the Adobe Granite server, including hostname and port. The CRX Package Manager service path will be appended to this value for all requests. For example, http://localhost:4502 or https://author.mycorp.com, etc.

If login credentials for the server are different than those configured in the Connection Options section, you may override them in the Base URL by inserting username[:password]@ between the scheme and the hostname.

For example, to override the Username without changing the associated password or private key, you may use the following form:

http:// deployer@localhost:4502

To override the credentials completely, provide a username and password (which may be provided by an encrypted parameter) by separating them with a colon, as shown below:
http:// deployer:Password123@localhost:4502

This field supports parameter tokens.
- Type: String
credentialsId (optional)
Select the login credentials for authenticating requests to the CRX server.

[Signature] credentials may be used if the target server supports HTTP Signature Authentication using the keyId format, /$username/keys/$fingerprint.

Select "-none-" to use the default credentials set in the global CRX Content Package Deployer - HTTP Client configuration.
- Type: String
download (optional)
Check this box to download the package after building it.
- Type: boolean
localDirectory (optional)
Specify a path relative to the workspace where the package will be downloaded (if the "Download" box is checked).

This field supports parameter tokens.
- Type: String
requestTimeout (optional)
Specify the timeout in milliseconds to wait for a response for each individual request. Specify a value of 0 to use default behavior.
- Type: long
serviceTimeout (optional)
Specify the timeout in milliseconds to wait for PackageManager service availability between sending POST requests. Specify a value of 0 to use default behavior.
- Type: long
waitDelay (optional)
Specify a delay in milliseconds before calls to check for Package Manager service availability. Increase this value if a /crx/packmgr node is sometimes created in the repository by this step, indicating that the Package Manager servlet was brought down for bundle installation AFTER a successful check for service availability, but BEFORE the next POST request was sent. What happens is that the SlingPostServlet takes over when the crx-packagemgr bundle is refreshed and creates nodes for any POST requests that it handles. Increasing this delay gives more time for the bundle refresh process to begin on the server.
- Type: long
wspFilter (optional)
Specify a package workspace filter in a simple text format that will be applied to the package before build. This defines what content will be captured by the package.

Simple spec is defined simply as a line-by-line format where:
- each line consists of significant text before an optional comment character (#)
- each line that begins with a "/" begins a new filter root.
- the first non-empty, non-comment line must define a new filter root
- each non-empty, non-comment line after a filter root that begins with a "+" or "-" defines an include or exclude rule, respectively. Everything following the "+" or "-" must be a valid regular expression
Content is "covered" by a filter root if the content path starts with, or is the same as the filter root path. Once the "covering" filter root is identified, its include/exclude rules are evaluated from top to bottom, by matching the content path against each rule pattern (which is a Java regular expression). The last rule whose pattern matches the content path defines whether that content is included (line starts with "+") or excluded (line starts with "-"). If no rules are defined, all content covered by that root path is included

For example, to include everything under /etc except for packages:
```
        /etc                 # define /etc as the filter root
        +/etc(/.*)?          # include everything under /etc
        -/etc/packages(/.)?  # exclude package paths
    
```
To 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 code
    
```
This field supports parameter tokens.
- Type: String

$class: 'BuildScanner'

Trigger automated Acunetix scans as part of your web application's build process

profile
The Scan Type used to scan the target
- Type: String
target
The Scan Target on which to run a scan (excludes Targets requiring Manual Intervention)
- Type: String
repTemp
Generate a Report after the scan completes. The report download link will be provided in the job console output
- Type: String
threat
The Threat Level (High, Medium, Low) to fail the build on
- Type: String
stopScan
If selected, the scan will be stopped if the build fails (Threat Level is reached)
- Type: boolean

$class: 'BuildStepBuilder'

sourceFolderMode
- Type: String
subfolder
- Type: String
packageId
- Type: String
serverType
- Type: String
server
- Type: String
authenticationType
- Type: String
userName
- Type: String
password
database
- Type: String
compareOptions (optional)
- Type: String

$class: 'BuildStepWithTimeout'

buildStep
$class: 'BuildStepsFromJsonBuilder'
$class: 'BuildoutBuilder'

pythonName
- Type: String
buildoutCfg
- Type: String
nature
- Type: String
command
- Type: String
ignoreExitCode
- Type: boolean

byteguardGreet

token
- Type: String
task_id
- Type: String

$class: 'CFLaunchBuilder'

cfComposition
- Type: String
setCFVars
- vars
  - Variable
    - Type: String
  - Value
    - Type: String

$class: 'CFLintBuilder'

This build step can be used to invoke CFLint analysis

folder
Configure the base folder to run the CFLint analysis
- Type: String
cflintFolder
Configure the CFLint installation folder
- Type: String
cflintExcludesFile
Enter the name of the cflintexcludes json file (default : cflintexclude.json)
- Type: String
otherArgs
- Type: String

$class: 'CIMessageBuilder'

providerData (optional)
- activeMQPublisher
- activeMQSubscriber
- fedmsgPublisher
- fedmsgSubscriber

$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
- activeMQSubscriber
- fedmsgPublisher
- fedmsgSubscriber

$class: 'CToolBuilder'

Executes a tool of the CMake-suite with arbitrary command-line arguments.
Useful to run cmake in script mode ( cmake -P <script file>) or command mode ( cmake -E <command>).

installationName
- Type: String
arguments (optional)
- Type: String
ignoredExitCodes (optional)
- Type: String
toolId (optional)
- Type: String
workingDir (optional)
- Type: String

generateCache

Generate ECU-TEST file caches (A2L, ELF, Bus, Model and Service caches are supported).

caches
- type
  - Values: A2L, ELF, BUS, MODEL, SERVICE
- filePath
  - Type: String
- dbChannel
  - Type: String
- clear
  - Type: boolean

$class: 'CallOtherJenkinsBuilder'

hostName
- Type: String
jobName
- Type: String
span
- Type: String
retry
- Type: String
userName
- Type: String
password
- Type: String
parameters
- Type: String

$class: 'CaptureIOSDeviceScreenshot'

Captures a screen shot from each connected iOS device. The image will be stored in a TIFF file matching the device's UDID (e.g. 3c701dda15e238cf3f2831346067751a5c942297.tiff).

url
- Type: String
cloudTestServerID
Select the server to download iOSAppInstaller.zip from.
- Type: String
additionalOptions
If you need to pass any other command line options to the iOSAppInstaller utility, specify them here. You can separate options with new lines as well as whitespaces.
- Type: String

castecho

installationName
- Type: String
sourcePath
- Type: String
applicationName
- Type: String
displayLog (optional)
- Type: boolean
logPath (optional)
- Type: String
outputPath (optional)
- Type: String
qualityGate (optional)
- Type: String

changeAsmVer

versionPattern
- Type: String
assemblyCompany (optional)
- Type: String
assemblyCopyright (optional)
- Type: String
assemblyCulture (optional)
- Type: String
assemblyDescription (optional)
- Type: String
assemblyFile (optional)
Set the file name to search. If the value is empty the default filename is : **/AssemblyInfo.cs. You can use an ant fileset pattern.
- Type: String
assemblyProduct (optional)
- Type: String
assemblyTitle (optional)
- Type: String
assemblyTrademark (optional)
- Type: String
regexPattern (optional)
Regex Pattern in which version is stated. Specify this value if you want to use for versioning other than assembly files (e.g. visual studio extensions .vsix). For assembly (.dll) versioning you do not need to specify anything here.
- Type: String
replacementPattern (optional)
Version value specified in regexPattern will be replaced by this. Use if you want versioning other than assembly files. e.g. "Version(\"%s\")" where %s will be new version number. For assembly (.dll) versioning keep this field blank.
- Type: String

$class: 'ChangesetEvaluator'

basePath (optional)
- Type: String
changeLogFile (optional)
- Type: String
changeLogParameters (optional)
- Type: String
classpath (optional)
- Type: String
contexts (optional)
- Type: String
credentialsId (optional)
- Type: String
databaseEngine (optional)
- Type: String
defaultSchemaName (optional)
- Type: String
driverClassname (optional)
If the list of included drivers doesn't contain a suitable driver, you may define the driver classname here. You'll most likely need to define a value for "classpath" as well.
- Type: String
dropAll (optional)
- Type: boolean
labels (optional)
- Type: String
liquibasePropertiesPath (optional)
You may opt to place all you configuration in a file whose location is defined here.
- Type: String
password (optional)
- Type: String
tagOnSuccessfulBuild (optional)
- Type: boolean
testRollbacks (optional)
- Type: boolean
url (optional)
- Type: String
useIncludedDriver (optional)
- Type: boolean
username (optional)
- Type: String

chatterPost

credentialsId
Utilizes the Credentials Plugin's Username with Password credentials storage to communicate with Chatter.
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.
- Type: String
body
The body text for your Chatter post
- Type: String
buildUrlTitle (optional)
The buildUrlTitle for your Chatter post. If left blank, the title will be set to your job/pipeline name and number (JOB_NAME BUILD_DISPLAY_NAME)
- Type: String
recordId (optional)
Id of record to chatter to (e.g. a group, or a custom object), leave blank to chatter to user's wall.
- Type: String
server (optional)
If left blank will connect to production, if you want to connect to a sandbox or have the my domains feature enabled, enter URL of alternative login server, e.g. https://test.salesforce.com
- Type: String

$class: 'CheckGate'

pipelineId
- Type: String
stageName
- Type: String
versionId
- Type: String
fatal
- Type: String

$class: 'CheckGateBuilder'

project
Select project.
- Type: String
gate
- Type: String

$class: 'ChefBuilderConfiguration'

url
- Type: String
sinatraurl
- Type: String
filter
- Type: String
username
- Type: String
port
- Type: int
command
- Type: String
privatekey
- Type: String
parallel
- Type: boolean
fail
- Type: boolean

chlAtuoAction

content
- Type: String
browserString
- Type: String
runScriptOnly
- Type: boolean
rootPath
- Type: String
libPath
- Type: String

$class: 'ChrootBuilder'

chrootName
- Type: String
ignoreExit
The build will always succeed.
- Type: boolean
additionalPackages
Additional packages to install into the chroot environment by 'apt-get'. These packages are persisted in the tarball to speed up subsequent builds. If you don't want this bahaviour use the 'Clear' option.
- Type: String
packagesFile
Enter a list of comma separated relative paths to files in the workspace, which contain additionals packages for apt-get to install. Such files might be placed in a git repository wich is previously checked out.
- Type: String
clear
Uses a fresh copied chroot tarball without packages installed from previous runs. The build will take longer but the build results will be more meaningful.
- Type: boolean
command
- Type: String
loginAsRoot
When this box is unchecked the subsequent commands are run inside chroot as a user with the same uid and gid as jenkins does. Whenever possible leave this box unchecked, but e. g. for testing installations it might be important to be root.
- Type: boolean
noUpdate
When this option is enabled, the repository indices are only updated if extra packages are going to be installed. When disabling repository updates, self contained builds, which do not have to install packages, will run faster. Because packages can also be installed from commands within the buildstep, by default, the package indices are always updated.
- Type: boolean
forceInstall
This option allows to force the installation of the specified packages. The underlying container will do whatever it can do to fulfill this request. This allows actions like downgrading, installing untrusted packages, etc.
- Type: boolean

$class: 'CifsBuilderPlugin'

publishers
- configName
  - Type: String
- verbose
  - Type: boolean
- transfers
  - sourceFiles
    - Type: String
  - excludes
    - Type: String
  - remoteDirectory
    - Type: String
  - removePrefix
    - Type: String
  - remoteDirectorySDF
    - Type: boolean
  - flatten
    - Type: boolean
  - cleanRemote
    - Type: boolean
  - noDefaultExcludes
    - Type: boolean
  - makeEmptyDirs
    - Type: boolean
  - patternSeparator
    - Type: String
- useWorkspaceInPromotion
  - Type: boolean
- usePromotionTimestamp
  - Type: boolean
- retry
  - retries
    - Type: int
  - retryDelay
    - Type: long
- label
  - label
    - Type: String
continueOnError
- Type: boolean
failOnError
- Type: boolean
alwaysPublishFromMaster
- Type: boolean
masterNodeName
- Type: String
paramPublish
- parameterName
  - Type: String

$class: 'ClangScanBuildBuilder'

Use this option to execute clang scan-build against and XCode project.

target
Provide the exact name of the XCode target you wish to have compiled and analyzed. You can use targets for all versions of XCode. This field is not required if you are using XCode and providing workspace and scheme.
- Type: String
targetSdk
This should be set the simulator version of a currently installed SDK. For later versions of XCode, you can set this value to 'iphonesimulator' to automatically use the latest available version of the SDK. If this does not work, you can identify a specific version by issuing the following command in Terminal:

xcodebuild -showsdks

It should typically look like 'iphonesimulator4.2' where the version number may change depending on your XCode installation.
- Type: String
config
Provide the XCode config you wish to execute scan-build against. It is recommended that you always use 'Debug' because this will allow clang to use assertions to eliminate false positives.
- Type: String
clangInstallationName
- Type: String
xcodeProjectSubPath
If your XCode project is located in a sub-folder of this job's workspace, provide the path here relative to the workspace. e.g. myProj/subfolder
- Type: String
workspace
In XCode 4 and later, you are able to configure named workspaces which are basically containers for multiple XCode projects. If your build requires a workspace, please provide its name in this field. When you provide a workspace you are XCode requires that you also provide a scheme.
- Type: String
scheme
If you are leveraging XCode workspaces and schemes, provide the name of your scheme here.
- Type: String
scanbuildargs
This field can be used to pass additional arguments to clang scan-build. The arguments will appear before the xcodebuild sub command. You can view the assembled command by viewing the job's build console.

scan-build uses the 'clang' executable relative to itself for static analysis by default.
--use-analyzer Xcode using the 'clang' packaged with Xcode (on OS X)
--use-analyzer [path to clang] to use the 'clang' from 'path to clang' or $PATH if no path specified.
- Type: String
xcodebuildargs
This field can be used to pass additional arguments to clang scan-build. The arguments will appear after the xcodebuild sub command. You can view the assembled command by viewing the job's build console.

-derivedDataPath $WORKSPACE/build is to save build products and other derived data to build directory under current workspace
- Type: String
outputFolderName
- Type: String

googleStorageUpload

credentialsId
- Type: String
bucket
- Type: String
pattern
- Type: String
pathPrefix (optional)
- Type: String
sharedPublicly (optional)
- Type: boolean
showInline (optional)
- Type: boolean

examCleanTarget

$class: 'ClifBuilder'

clifName
- Type: String
clifOpts
- Type: String
testPlanFile
- Type: String
reportDir
- Type: String

$class: 'CloudBuildBuilder'

This build step invokes Google Cloud Build.

input
- credentialsId
  - Type: String
- request
  - file
  - inline
- source (optional)
  - local
  - repo
  - storage
- substitutionList (optional)
  - items
    User-defined substitutions to be added to the build request. The set of user-defined substitutions referenced in the build request must exactly match the set of substitutions defined here. For details, see Build Requests - User-defined substitutions.
    - key
      The name of the user-defined substitution. This must begin with an underscore ( _) 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.
      - Type: String
    - value
      The value of the user-defined substitution. This must not expand to longer than 100 characters. For details, see Build Requests - User-defined substitutions.
      - Type: String
- substitutions (optional)

$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.
  - Type: String
- description
  - Type: String
- cloudFormationRecipe
  - Type: 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.
  - Type: String
- timeout
  Number of seconds to wait before giving up creating a stack. Minimum time is 5 mins.
  - Type: long
- awsAccessKey
  The Amazon API Access Key. You can pass environment variables into this field.
  - Type: String
- awsSecretKey
  The Amazon API Secret Key. You can pass environment variables into this field.
  - Type: String
- awsRegion
  Select the region you wish to run the cloudformation on.
  - Values: 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
  Number of seconds to wait before continuing to the next step(minimum is 0 sec)
  - Type: long

pushToCloudFoundry

target
- Type: String
organization
- Type: String
cloudSpace
- Type: String
credentialsId
- Type: String
manifestChoice (optional)
- appName (optional)
  - Type: String
- appPath (optional)
  - Type: String
- buildpack (optional)
  - Type: String
- command (optional)
  - Type: String
- domain (optional)
  - Type: String
- envVars (optional)
  - key
    - Type: String
  - value
    - Type: String
- hostname (optional)
  - Type: String
- instances (optional)
  - Type: String
- manifestFile (optional)
  - Type: String
- memory (optional)
  - Type: String
- noRoute (optional)
  - Type: String
- servicesNames (optional)
  - name
    - Type: String
- stack (optional)
  - Type: String
- timeout (optional)
  - Type: String
- value (optional)
  - Type: String
pluginTimeout (optional)
- Type: String
selfSigned (optional)
- Type: String
servicesToCreate (optional)
- name
  - Type: String
- type
  - Type: String
- plan
  - Type: String
- resetService (optional)
  - Type: boolean

$class: 'CloudShellConfig'

buildStep
- $class: 'StartSandbox'

$class: 'CmakeBuilder'

installationName
- Type: String
buildDir (optional)
- Type: String
buildType (optional)
- Type: String
cleanBuild (optional)
- Type: boolean
cmakeArgs (optional)
- Type: String
generator (optional)
- Type: String
preloadScript (optional)
- Type: String
sourceDir (optional)
- Type: String
steps (optional)
- args (optional)
  Specify arguments to pass to the build tool or cmake (separated by spaces). Arguments may contain spaces if they are enclosed in double quotes (will be handled like a Unix shell does),
  HINT: If you plan to archive the artifacts, specify DESTDIR=${WORKSPACE}/artifacts all install here to instruct the tool to copy the artifacts to DESTDIR. At least the make and the ninja tool allow overriding the installation directory that way.
  - Type: String
- envVars (optional)
  Specify extra environment variables to pass to the build tool as key-value pairs here.
  Each entry must be on its own line, for example:
  DESTDIR=${WORKSPACE}/artifacts/dir KEY=VALUE
  Please note that macros (e.g. ${WORKSPACE}) will not be resolved by a pipeline script.
  - Type: String
- withCmake (optional)
  Whether to run the actual build tool directly (by expanding $CMAKE_BUILD_TOOL) or to have cmake run the build tool (by invoking cmake --build <dir>).
  - Leave unchecked for minimal performance overhead.
  - Check this, if you selected one of the Visual Studio or Xcode generators above AND if you run CMake v. 2.8.11 or newer.
  - Type: boolean

$class: 'CocoaPodsBuilder'

cleanpods
If checked the "pod" folder will be deleted before updating the pods
- Type: boolean

$class: 'CodeAnalysisBuilder'

connection

An Oracle connection string used for connecting to the database.
user/password@host:port/service
- Type: 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.
  - Type: 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.
  - Type: String
- type
  - 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.
  - Type: String
- filter
  Filter directory files by name or extension.
  - Type: String
- recurse
  - Type: boolean
report
- name
  
  The base name of the reports, without an extension. If empty no reports will be generated.
  - Type: String
- html
  - Type: boolean
- json
  - Type: boolean
- xls
  - Type: boolean
- xml
  - Type: boolean
ruleSet
- Type: int
failConditions
- halstead
  
  Halstead level which will cause the code analysis to fail, exclude to ignore.
  - Type: int
- maintainability
  
  Maintainability index level which will cause the code analysis to fail, exclude to ignore.
  - Type: int
- mcCabe
  
  McCabes level which will cause the code analysis to fail, exclude to ignore.
  - Type: int
- TCR
  
  Toad Code Rating level which will cause the code analysis to fail, exclude to ignore.
  - Type: int
- ruleViolations
  
  If enabled, code analysis will fail on any violation for the selected rule set.
  - Type: boolean
- syntaxErrors
  
  If enabled, code analysis will fail on any syntax error.
  - Type: boolean
- ignoreWrappedPackages
  
  If enabled, code analysis will fail when a wrapped package is found.
  - Type: boolean

$class: 'CodeBuilder'

credentialsType
- Type: String
credentialsId
- Type: String
proxyHost
- Type: String
proxyPort
- Type: String
awsAccessKey
- Type: String
awsSecretKey
awsSessionToken
- Type: String
region
- Type: String
projectName
- Type: String
sourceVersion
- Type: String
sseAlgorithm
- Type: String
sourceControlType
- Type: String
localSourcePath
- Type: String
workspaceSubdir
- Type: String
gitCloneDepthOverride
- Type: String
reportBuildStatusOverride
- Type: String
secondarySourcesOverride
- Type: String
secondarySourcesVersionOverride
- Type: String
artifactTypeOverride
- Type: String
artifactLocationOverride
- Type: String
artifactNameOverride
- Type: String
artifactNamespaceOverride
- Type: String
artifactPackagingOverride
- Type: String
artifactPathOverride
- Type: String
artifactEncryptionDisabledOverride
- Type: String
overrideArtifactName
- Type: String
secondaryArtifactsOverride
- Type: String
envVariables
- Type: String
envParameters
- Type: String
buildSpecFile
- Type: String
buildTimeoutOverride
- Type: String
sourceTypeOverride
- Type: String
sourceLocationOverride
- Type: String
environmentTypeOverride
- Type: String
imageOverride
- Type: String
computeTypeOverride
- Type: String
cacheTypeOverride
- Type: String
cacheLocationOverride
- Type: String
cloudWatchLogsStatusOverride
- Type: String
cloudWatchLogsGroupNameOverride
- Type: String
cloudWatchLogsStreamNameOverride
- Type: String
s3LogsStatusOverride
- Type: String
s3LogsLocationOverride
- Type: String
certificateOverride
- Type: String
serviceRoleOverride
- Type: String
insecureSslOverride
- Type: String
privilegedModeOverride
- Type: String
cwlStreamingDisabled
- Type: String
exceptionFailureMode
- Type: String

$class: 'CodeCoverageBuilder'

connectionId
- Type: String
credentialsId
- Type: String
analysisPropertiesPath
- Type: String
analysisProperties
- Type: String

$class: 'CodeScanBuilder'

projectKey
- Type: String
commitOverride
- Type: String
version
- Type: 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
- Type: String
analysisMode
- Type: String
projectBranch
- Type: String
blocking
- Type: boolean

codescene

credentialsId
Select username/password credentials defined in Jenkins configuration. This is a safe way to use credentials in Jenkins plugin. See Injecting Secrets into Jenkins Build Jobs for more details.
- Type: String
deltaAnalysisUrl
- Type: String
repository
- Type: String
analyzeBranchDiff (optional)
- Type: boolean
analyzeLatestIndividually (optional)
Commits not seen in previous successful builds will be used for separate delta analyses.
- Type: boolean
baseRevision (optional)
- Type: String
couplingThresholdPercent (optional)
- Type: int
failOnDecliningCodeHealth (optional)
Check this option to mark the build as unstable if the Code Health of a hotspot declines.
- Type: boolean
failOnFailedGoal (optional)
Check this option to mark the build as unstable if a goal -- as defined by CodeScene's Intelligent Notes -- is violated. This could be a supervised hotspot that suddenly declines in Code Health, or a module indicated as No Problem that starts to accumulate complex code, etc.
- Type: boolean
letBuildPassOnFailedAnalysis (optional)
By default we fail the build if CodeScene couldn't run an analysis (e.g. couldn't update the repository). This behaviour can be overridden here.
- Type: boolean
markBuildAsUnstable (optional)
- Type: boolean
originUrl (optional)
- Type: String
riskThreshold (optional)
- Type: int
useBiomarkers (optional)
- Type: boolean

$class: 'CodeStreamBuilder'

serverUrl
vRealize Automation host.
- Type: String
userName
User name
- Type: String
password
Password
- Type: String
tenant
Tenant
- Type: String
pipelineName
CodeStream pipeline name. Please not only latest version of this pipeline will be executed.
- Type: String
waitExec
- Type: boolean
pipelineParams
- value
  - Type: String
- name
  - Type: String

$class: 'CodefreshPipelineBuilder'

selectPipeline
Check this if there's no SCM defined for current job or you would like to trigger a different service pipeline.
- cfPipeline
  - Type: String
- cfBranch
  - Type: String
setCFVars
- vars
  - Variable
    - Type: String
  - Value
    - Type: String

$class: 'CompareBuilder'

Compare two different schemas (from database, repository or snapshot). Based on it you can do in the next steps further actions (like generating report or alter script)

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:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}/dir.
- Type: String
srcInputType
- Type: String
tgtInputType
- Type: String
srcInputFileOrFolder
Specify input folder/file that will be used as source side input for compare. Following inputs are expected.
- Database - input is exported connection file
- File System Synchronization - input is folder mapped through Toad Edge file system synchronization
- Snapshot - input is snapshot file
Folder/file location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- Type: String
tgtInputFileOrFolder
Specify input folder/file that will be used as target side input for compare. Following inputs are expected.
- Database - input is exported connection file
- File System Synchronization - input is folder mapped through Toad Edge file system synchronization
- Snapshot - input is snapshot file
Folder/file location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- Type: 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:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Type: String

$class: 'CompareWithBaselineBuilder'

Compare your current schema with the baseline. In case that the schema is different the build step will fail.

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:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- Type: String
srcInputType
- Type: String
tgtInputType
- Type: String
srcInputFileOrFolder
Specify input folder/file that will be used as source side input for baseline compare. Following inputs are expected.
- Database - input is exported connection file
- File System Synchronization - input is folder mapped through Toad Edge file system synchronization
- Baseline - input is baseline snapshot file
Folder/file location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- Type: String
tgtInputFileOrFolder
Specify input folder/file that will be used as target side input for baseline compare. Following inputs are expected.
- Database - input is exported connection file
- File System Synchronization - input is folder mapped through Toad Edge file system synchronization
- Baseline - input is baseline snapshot file
Folder/file location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- Type: 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:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Type: String

$class: 'CompoundBuilder'
$class: 'ConditionalBuilder'

runCondition
- $class: 'AlwaysRun'
- $class: 'And'
- $class: 'BatchFileCondition'
- $class: 'BooleanCondition'
- $class: 'CauseCondition'
- $class: 'DayCondition'
- $class: 'ExpressionCondition'
- $class: 'ExtendedCauseCondition'
- $class: 'FileExistsCondition'
- $class: 'FilesMatchCondition'
- $class: 'LegacyBuildstepCondition'
- $class: 'NeverRun'
- $class: 'NodeCondition'
- $class: 'Not'
- $class: 'NumericalComparisonCondition'
- $class: 'Or'
- $class: 'ShellCondition'
- $class: 'StatusCondition'
- $class: 'StringsMatchCondition'
- $class: 'TextFinderCondition'
- $class: 'TimeCondition'
- $class: 'VariableExistsCondition'
runner
If the evaluation of a run condition fails, should the build fail, be marked unstable, run the build step ...
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'

Adds config vars to a Heroku app. Existing config vars with the same name will be overridden. Config vars are available to the app as environment variables.

apiKey
- Type: String
appName
- Type: String
configVars
Key-value pairs of config vars to be set. The syntax follows that of Java Properties files. Values are expanded against the Jenkins environment, but not against each other.
- Type: String

$class: 'ConfigFileBuildStep'

Make globally configured files available in your local workspace. All files configured via the config-file-provider plugin are available and can be referenced.

managedFiles
- fileId
  Name of the file.
  - Type: String
- replaceTokens (optional)
  Decides whether the token should be replaced using macro.
  - Type: boolean
- targetLocation (optional)
  Name of the file (with optional file relative to workspace directory) where the config file should be copied.
  - Type: String
- variable (optional)
  Name of the variable which can be used as the reference for further configuration.
  - Type: String

$class: 'ConfluenceReleaseNotesPublisher'

jiraCredentialsID
These jira credentials and project will be used to operate on.
- Type: String
confluenceCredentialsID
This confluence together with the credentials will be used to publish the page.
- Type: String
spaceKey
The key of the space on which the new page will be published
- Type: String
jqlFilter
A JQL filter used to select the tickets that will be shown on the newly created page. See the JIRA documentation for more information on how to use JQL.
- Type: String
pageTitle
The title of the new page that will be published.
- Type: String
parentPageTitle
If specified the entire content tree of the space is searched for a page with this title. The new release notes page will be then published as a child page of this one.
- Type: String

$class: 'ConsulBuilder'

installationName
- Type: String
operationList
- $class: 'ConsulGetKV'
- $class: 'ConsulServiceDiscoveryOperation'
- $class: 'ConsulSetKV'
consulSettingsProfileName
- Type: String

$class: 'ConsulKVBuilder'

hostUrl
Host URL should contain protocol (HTTP/HTTPS)://<HOST_NAME>.
- Type: String
key
Key is used in GET/PUT requests to lookup the value from, or right the key/value pair to the Consul key/value store.
- Type: String
aclToken (optional)
Token is used to supply UUID token for Consul ACL token calls. Token can be supplied by build parameters.
- Type: String
apiUri (optional)
URL Override is used to override the K,V API URL.
- Type: String
debugMode (optional)
Enable Debug messages for more verbose logging.
- Values: ENABLED, DISABLED
envVarKey (optional)
ENV Varaible Key is used to store the retrieved value in the build ENV variables to be used downstream.
- Type: String
ignoreGlobalSettings (optional)
- Type: boolean
keyValue (optional)
Value is used in PUT calls to insert/update a key/value pair.
- Type: String
requestMode (optional)
Request Mode set to READ will execute a GET to lookup the value, WRITE will execute a PUT to insert/update the value.
- Values: READ, WRITE, DELETE
timeoutConnection (optional)
Connection timeout in milliseconds, default is 10000.
- Type: int
timeoutResponse (optional)
Response timeout in milliseconds, default is 30000.
- Type: int

assessContainerImage

failOnPluginError (optional)
Enable this option to fail the build if the plugin encountered any errors.
- Type: boolean
imageId (optional)
Provide a Docker image ID or name which can be referenced by the Docker daemon (e.g. my-repo/my-image:my-tag).
- Type: String
nameRules (optional)
- packageName
- vulnerabilityCategory
- vulnerabilityTitle
- vulnerablePackageName
thresholdRules (optional)
- criticalVulnerabilities
- cvssV2Score
- exploitableVulnerabilities
- vulnerabilitiesWithMalwareKits
- moderateVulnerabilities
- packageRiskScore
- riskScore
- severeVulnerabilities
- totalVulnerabilities
treatWarningsAsErrors (optional)
Enable this option to treat warnings as errors, which will fail the build.
- Type: boolean
workspaceDir (optional)
- Type: String

contentReplace

configs (optional)
- filePath
  A relative or absolute file path
  - Type: String
- fileEncoding
  - Type: String
- configs
  - search
    - Type: String
  - replace
    - Type: String
  - matchCount
    - Type: int

$class: 'ContinuousReleaseProperties'

properties

$class: 'CoordinatorBuilder'

Add/Remove node, add/remove jobs, rename, check, right click to switch on Serial or Parallel pattern and have fun!

executionPlan

$class: 'CopadoBuilder'

stepName
- Type: String
webhookUrl
Enter the Copado URL for the test that you want to run on this build step. The Copado URLs (webhooks) that are available for Copado can be found using this url http://docs.copa.do.
- Type: String
api_key
Enter your Copado API Key. A personal API Key is generated from the Account Summary tab in Copado. This makes it easy to use the API.

To obtain a new personal API Key, navigate in Copado to the Account Summary tab - API Key and press the "Generate new API Key" button if you haven't done it already.

Please note that resetting/changing the API will require these values here to be updated too.
- Type: String
timeout
Enter timeout in seconds for your Copado jobs to complete. After the Copado task is triggered, this plugin will repeatedly poll the Copado API (approx. 10 every second) for the result. If the time it takes to complete the test exceeds this timeout value, this build step will abort and fail.
- Type: int

copy

You can use the step copy files from master to current slaver.

dstFile (optional)
- Type: String
keepMeta (optional)
- Type: boolean
recursive (optional)
- Type: boolean
srcFile (optional)
- Type: String

$class: 'CreateBaselineBuilder'

Set the current state of your schema as the baseline to detect any changes that has been made into the schema since now.

outputFile
Path to the file that should be used to store baseline.

File location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}file or without prefix i.e. file.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}file.
- Type: String
inputFileOrFolder
Specify input folder/file for creating baseline. It should depend on input type you have selected.
- Database - input is exported connection file
- File System Synchronization - input is folder mapped through Toad Edge file system synchronization
Folder/file location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- Type: String

$class: 'CreateFingerprint'

Create Fingerprints of specified files during a build process

targets
- Type: 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:

You are using the BuildMaster Jenkins Build Importer Build Step which imports build artifacts from Jenkins: the post build action is required.
You are using a standard BuildMaster build step and importing files from a folder that you've placed the artifacts into from the Jenkins build (eg using ArtifactDeployer Plugin): either the post build or build step actions will be fine.
You use an external artifact repository such as Nexus, Artifactory or ProGet: either the post build or build step actions will be fine.

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)
The Id of the BuildMaster application to trigger the build for. Defaults to the BUILDMASTER_APPLICATION variable populated by the "Select BuildMaster Application" action.
- Type: String
deployToFirstStage (optional)
Will trigger the deployment to the first stage, and any subsequent stages where the stage is configured to automatically deploy to the next stage.
- waitUntilDeploymentCompleted
  If checked waits until BuildMaster has completed the deployment, otherwise will exits immediately after triggering the deployment to the first stage.
  - Type: boolean
- printLogOnFailure (optional)
  If checked will print the BuildMaster log for the deployment to the Jenkins console if the build fails - but only if the "Wait until deployment completed" option is also checked.
  - Type: 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.
  - Type: 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
- Type: String
packageVariables (optional)

Set build level variables.
- variables
  Provide a list of variables to pass to BuildMaster.
  - A variable must be in the format "variable=value"
  - Additional variables must be declared on separate lines
  - Lines starting with # are treated as comments
  - When using pipeline script and you want to pass several variables use one of these formats:
    
    Separate variables using newline character. Generated script will resemble: variables: 'var1=one\nvar2=two'
    
    Separate variables using multi-line string. Generated script will resemble: variables: '''var1=one
    var2=two'''
  - Type: 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.
  - Type: boolean
releaseNumber (optional)
The BuildMaster release number to trigger the build for. Defaults to the BUILDMASTER_RELEASE_NUMBER variable populated by the "Select BuildMaster Application" action. The job will fail if there is no active BuildMaster release.
- Type: String

$class: 'CreateSnapshotBuilder'

Save your database schema to a file to have the possibility to return to it any time later.

outputFile
Path to the file that should be used to store snapshots.

File location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}file or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}file.
- Type: String
inputFileOrFolder
Specify input folder/file for creating snapshot. It should depend on input type you have selected.
- Database - input is exported connection file
- File System Synchronization - input is folder mapped through Toad Edge file system synchronization
Folder/file location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- Type: String

createTag

nexusInstanceId
- Type: String
tagName
Tag name is required and must be unique. Name can only contain letters, numbers, underscores, hyphens and dots and cannot start with an underscore or dot. The name cannot exceed 256 characters
- Type: String
tagAttributesJson (optional)
Optional metadata for the tag in JSON format. These attributes will be merged with those contained in the attributes file if both are provided. Attributes in this field will override those present in the file
- Type: String
tagAttributesPath (optional)
The file path (environment-aware) to the optional metadata for the tag, using the workspace as the base path
- Type: String

$class: 'CreateTemplate'

cloud
- Type: String
workspace
The workspace in ElasticBox.
- Type: String
instanceTags
- Type: String
templateName
- Type: String
provider
- Type: String
datacenter
- Type: String
folder
- Type: String
datastore
- Type: String
claimFilter
- Type: String
policyName
- Type: String
claims
- Type: String

$class: 'CreateTunnelBuilder'

srfTunnelName
- Type: 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
Your command.
- Type: String
token
- Type: String

$class: 'CucumberSlackBuildStepNotifier'

channel
- Type: String
json
- Type: String
hideSuccessfulResults
- Type: boolean

$class: 'CustomPythonBuilder'

home
- Type: String
nature
- Type: String
command
- Type: String
ignoreExitCode
- Type: boolean

$class: 'CxScanBuilder'

credentialsId
This option is for users that may already have Jenkins credentials, as defined in Jenkins, and would like to use them with the CxSAST Jenkins plugin. Select your credentials from the drop-down list.
NOTE: If your credentials do not exist in the system, you can add them by clicking Add and selecting Jenkins (see Adding Jenkins Credentials to the CxSAST Jenkins Plugin, for more information).
- Type: String
buildStep
- Type: String
teamPath
- Type: String
sastEnabled
- Type: boolean
exclusionsSetting
- Type: String
failBuildOnNewResults
Enables the option to fail the build according to the defined severity (or higher). This option works in addition to the regular thresholds (e.g. if "x" total high vulnerabilities were found OR at least 1 new vulnerability, fail the build). This option is only available if the "Enable vulnerability threshold" parameter is enabled.
- Type: boolean
failBuildOnNewSeverity
- Type: String
osaArchiveIncludePatterns

Comma separated list of archive wildcard patterns to include their extracted content for the scan. eg. *.zip, *.jar, *.ear
Supported archive types are: jar, war, ear, sca, gem, whl, egg, tar, tar.gz, tgz, zip, rar
Leave empty to extract all archives
- Type: String
osaInstallBeforeScan
Select this option in order to be able to scan packages from various dependency managers (NPM, Nugget, Python and more.) as part of the CxOSA scan
- Type: boolean
useOwnServerCredentials (optional)
- Type: boolean
serverUrl (optional)
Checkmarx server url or ip address with or without port. Syntax: http(s)://server-name:port. Example: http://checkmarx-server, https://10.0.0.255:9495
- Type: String
username (optional)
Login username
- Type: String
password (optional)
Login password
- Type: String
projectName (optional)
A full absolute name of a project. The full Project name includes the whole path to the project, including Server, service provider, company, and team. Example: "CxServer\SP\Company\Users\bs_java" If project with such a name doesn't exist in the system, new project will be created. May reference build parameters like ${PARAM}.
- Type: String
projectId (optional)
- Type: long
groupId (optional)
Fully qualified team name for the project.
- Type: String
preset (optional)
Scan preset. When not specified, will use the predefined preset for an existing project, and Default preset for a new project.
- Type: String
jobStatusOnError (optional)
Determines how to act when a triggered Checkmarx scan in synchronous mode fails and returns an error message (i.e. no scan results, not to be confused with valid scan results that exceed the threshold).
- FAILURE is equivalent to a Job error that fails the entire build.
- UNSTABLE is equivalent to a Job warning that allows the build to proceed normally but provides an unstable status upon completion.
- Use the global setting implies that this project uses the value either FAILURE or UNSTABLE defined globally by the CxSAST Jenkins plugin.
- Values: GLOBAL, FAILURE, UNSTABLE
presetSpecified (optional)
- Type: boolean
excludeFolders (optional)
Comma separated list of folders to exclude from scan. Entries in this list are automatically converted to exclude wildcard patterns and appended to the full pattern list provided in the advanced section. May reference build parameters like ${PARAM}.
Conversion is done as follows:
fold1, fold2 fold3
is converted to:
!**/fold1/**/*, !**/fold2/**/*, !**/fold3/**/*,
- Type: String
filterPattern (optional)
Comma separated list of include or exclude wildcard patterns. Exclude patterns start with exclamation mark "!".
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.separators 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").
- Type: String
incremental (optional)
Run incremental scan instead of full scan.
- Type: boolean
fullScansScheduled (optional)
- Type: boolean
fullScanCycle (optional)
Incremental scans are faster, but with time they become less accurate.
Therefore, after a number of incremental scans it is recommended to perform a full scan.
Here you can schedule periodic full scans to be executed after a certain number of incremental scans.

Alternatively, if you want to run full scans on weekends, you can create 2 separate jobs.
First job - to run incremental scans on weekdays and second job - to run full scans on weekends.
- Type: int
sourceEncoding (optional)
Source code character encoding.
- Type: String
comment (optional)
Free text comment. May reference build parameters like ${PARAM}.
- Type: String
skipSCMTriggers (optional)
Do not perform Checkmarx scan when the build was triggered by SCM Change.
- Type: boolean
waitForResultsEnabled (optional)
In synchronous mode, Checkmarx build step will wait for Checkmarx scan to complete, then retrieve scan results and optionally check vulnerability thresholds. When disabled, the build step finishes after scan job submissions to Checkmarx server.
- Type: boolean
vulnerabilityThresholdEnabled (optional)
Mark the build as unstable if the number of high severity vulnerabilities is above the specified threshold.
- Type: boolean
highThreshold (optional)
High severity vulnerability threshold. If set, the threshold is crossed if number of high severity vulnerabilities exceeds it.
- Type: int
mediumThreshold (optional)
Medium severity vulnerability threshold. If set, the threshold is crossed if number of medium severity vulnerabilities exceeds it.
- Type: int
lowThreshold (optional)
Low severity vulnerability threshold. If set, the threshold is crossed if number of low severity vulnerabilities exceeds it.
- Type: int
osaEnabled (optional)
- Type: boolean
osaHighThreshold (optional)
OSA high severity vulnerability threshold. If set, the threshold is crossed if number of high severity vulnerabilities exceeds it.
- Type: int
osaMediumThreshold (optional)
OSA medium severity vulnerability threshold. If set, the threshold is crossed if number of medium severity vulnerabilities exceeds it.
- Type: int
osaLowThreshold (optional)
OSA low severity vulnerability threshold. If set, the threshold is crossed if number of low severity vulnerabilities exceeds it.
- Type: int
generatePdfReport (optional)
Downloads a PDF report with scan results from the Checkmarx server. The report is available via a link on "Checkmarx Scan Results" page.
- Type: boolean
enableProjectPolicyEnforcement (optional)
Mark the build as failed or unstable if the project's policy is violated.
Notes:
1. Assigning a policy to a project is done from within CxSAST
2. OSA Scan must be selected in the build job configuration
- Type: boolean
thresholdSettings (optional)
- Type: String
vulnerabilityThresholdResult (optional)
- Type: 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").
- Type: String
excludeOpenSourceFolders (optional)
Comma separated list of folders to exclude from scan.
- Type: String
avoidDuplicateProjectScans (optional)
If there is a scan of this project in the queue in status working or queued do not send a new scan request to Checkmarx
- Type: boolean
generateXmlReport (optional)
Generate full XML and HTML CxSAST scan reports. These reports will contain additional information about the detected vulnerabilities
- Type: boolean
thisBuildIncremental (optional)
- Type: boolean

osfBuilderSuiteForSFCCDataImport

hostname (optional)
- Type: String
bmCredentialsId (optional)
- Type: String
tfCredentialsId (optional)
- Type: String
ocCredentialsId (optional)
- Type: String
ocVersion (optional)
- Type: String
archiveName (optional)
- Type: String
sourcePath (optional)
- Type: String
includePatterns (optional)
- includePattern
  - Type: String
excludePatterns (optional)
- excludePattern
  - Type: String
importStrategy (optional)
- Type: String
tempDirectory (optional)
- Type: String

$class: 'DatabaseDocBuilder'

outputDirectory (optional)
- Type: String
basePath (optional)
- Type: String
changeLogFile (optional)
- Type: String
changeLogParameters (optional)
- Type: String
classpath (optional)
- Type: String
contexts (optional)
- Type: String
credentialsId (optional)
- Type: String
databaseEngine (optional)
- Type: String
defaultSchemaName (optional)
- Type: String
driverClassname (optional)
- Type: String
labels (optional)
- Type: String
liquibasePropertiesPath (optional)
- Type: String
password (optional)
- Type: String
url (optional)
- Type: String
useIncludedDriver (optional)
- Type: boolean
username (optional)
- Type: String

$class: 'DaticalDBBuilder'

daticalDBProjectDir
The Datical DB Project Directory is the path location of your Datical DB Project folder. This will contain a datical.project file.

Typically, this will be a relative path as it will be created by Jenkins during source code checkout. If you Datical DB Project is stored in the db folder under the root of your source tree and is named "My Project", you should enter ./db/My Project.
- Type: String
daticalDBServer
The Datical DB Server Name is the name of the server you wish to manage with Datical DB. You can determine this value by opening Datical DB and choosing a server listed in your Deployment Plan. Directory is the path location of your Datical DB Project folder. This will contain a datical.project file.
- Type: String
daticalDBAction
The Datical DB Action is the action you wish Datical DB to perform.

This can include the following:
Forecast - provides a report detail the changes, if any, that will be applied to your database along with impact analysis. This does NOT commit changes to your database. This file will be stored in your build workspace. Requires DB Server specification.
Snapshot - reverse engineers your database schema to a Datical DB XML file. This file will be stored in your build workspace. Requires DB Server specification.
Deploy - executes any changes required as detailed in your Project. This will generate a report detailing the chnages and be stored in your build workspace. Requires DB Server specification.
Status - provides the current status of the database in relation to your Project. DB Server specification is optional.
Status (Detailed) - details the current status of the database in relation to your Project. DB Server specification is required.
Check Drivers - validates the appropriate JDBC driver is available to Datical DB for your specific Project. The location of the drivers is specified in the Jenkins global config. (Jenkins --> Manage Jenkins --> Configure System --> Datical DB)
Check Rules - validates the Rules located in your Datical DB project.
Generate Change Log from Differences - generates a new Change Log representing the difference between two databases in your Datical DB project. Two Servers are required (e.g., Source Target). diffChangelog reference db target db --output path. Output is optional.
Generate Report from Differences - like the previous Action, generates a report representing the difference between two databases in your Datical DB project. Two Servers are required (e.g., Source Target). diff reference db target db.
History - provides a history report of changes applied to your database(s).
Rollback - Roll the target database back to a given revision, date or by number of steps.
Deploy with Auto Rollback - Identical to "Deploy" but will Automatically Rollback to previous state in event of error.
Create Datical Project - Creates a new Datical Project in the Project Directory. Useful for when you are only provided the changelog.xml file.
Create New Database Definition - Adds a new Database Definition to an existing Datical Project. (e.g., DbDefClass MysqlDbDef name Dev username datical password password hostname localhost port 3306 database dev)
Install License - Installs a license file. Requires the path to the new license file.
Set Property - Set a Datical DB Property in daticaldb.properties.
Create Datical Project (project_creatory.groovy) - Creates a Datical Project using Provisiong Files. See project_creator.groovy in repl/scripts.
Baseline Datical Project (project_baseline.groovy) - Baselines a Datical Project. See project_baseline.groovy in repl/scripts

Type: String

daticalDBCmdProject

The Datical DB Command is the fully qualified location of the Datical DB CLI command. It will override the Global Datical DB Command. This is typically not needed.

This should be a fully qualified file path such as C:\DaticalDB\repl\hammer.bat or /opt/DaticalDB/repl/hammer.

Type: String

daticalDBExportSQL

When checked for Deploy and Forecast actions, Datical DB will export SQL to be run against the target server.

Type: String

daticalDBExportRollbackSQL

When checked for Deploy and Forecast actions, Datical DB will export Rollback SQL to be run against the target server. When checked for Rollback, will only export SQL and NOT perform a Rollback.

Type: String

daticalDBScriptDir

The Datical DB Script Directory is the fully qualified location of the Datical DB Scripts.

This should be a fully qualified file path such as file:/C:\DaticalDB\repl\scripts or /opt/DaticalDB/repl/scripts.

Type: String

$class: 'DebianPackageBuilder'

pathToDebian
- Type: String
nextVersion
- Type: String
generateChangelog
Warning: multiple SCM Locations should not be checked out to single directory.
- Type: boolean
signPackage
- Type: boolean
buildEvenWhenThereAreNoChanges
Check this if you want automated builds (timer- and SCM-triggered) to carry on even if there were no changes in the built package.
- Type: 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.
- Type: 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.
- Type: 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.
- Type: 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.
- Type: String
debianDirLocation (optional)

The location of the debian/ directory, relative to workspace root

This may also be set globally
- Type: 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.
- Type: 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"
- Type: 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.
- Type: 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
- Type: 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.
- Type: 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.
- Type: String

$class: 'DeleteApplication'

serverName
Select the a server from the list of servers configured in Jenkins Global Configuration.
- Type: String
appName
Name of the gear to be deleted.
- Type: String
domain
Select the user domain containing the application.
- Type: String

$class: 'DeleteChartBuildStep'

id
- Type: String
kubeName
- Type: String
namespace
- Type: String
chartsRepo
- Type: String
chartName
- Type: String

deleteComponents

nexusInstanceId
- Type: String
tagName
Components associated with this tag will be deleted
- Type: String

$class: 'DeleteEnvironmentBuilder'

systemId
- Type: int
environmentName
- Type: String

$class: 'DeleteVirtualizeBuilder'

serverType
- Type: String
serverHost
- Type: String
serverName
- Type: String

dependencyCheck

additionalArguments (optional)
- Type: String
odcInstallation (optional)
- Type: String
skipOnScmChange (optional)
- Type: boolean
skipOnUpstreamChange (optional)
- Type: boolean

$class: 'DeployApplication'

This plugin creates a container on the OpenShift PaaS and deploys the application into the container.

serverName
Select the a server from the list of servers configured in Jenkins Global Configuration.
- Type: String
appName
Select a name for the application. If the application doesn't exist, it will be created before the deployment.
- Type: 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:
- jbossas-7
- jbosseap-6
- nodejs-0.10
- perl-5.10
- php-5.3
- php-5.4
- zend-6.1
- python-2.6
- python-2.7
- python-3.3
- ruby-1.8
- ruby-1.9
- ruby-2.0
- jbossews-1.0
- jbossews-2.0
- 10gen-mms-agent-0.1
- mongodb-2.4
- mysql-5.1
- mysql-5.5
- phpmyadmin-4
- postgresql-8.4
- postgresql-9.2
- Type: String
domain
Select the user domain for the application. Note that the domain needs to be created before hand. The plugin will not create it if it doesn't exist.
- Type: String
gearProfile
Select the gear profile to be used when creating the application
- Type: String
deploymentPackage
The location of the deployment package can be specified as a directory path or a URL (e.g. to Nexus). The packages can be of type .WAR or .EAR in case of GIT deployment and .TAR.GZ archive for BINARY deployment. Examples:
- target/
- http://www.myrepo.com/org/keycloak/keycloak-server/1.0.2.Final/keycloak-server-1.0.2.Final.war
- https://repository.jboss.org/nexus/service/local/artifact/maven/redirect?r=central&g=org.keycloak&a=keycloak-server&v=1.0.2.Final&e=war
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.
- Type: 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
- Type: String
autoScale
- Type: boolean
deploymentType
Type of deployment the application accepts ('git' or 'binary')
- Values: GIT, BINARY
openshiftDirectory
The .openshift directory is a directory where a user can create action hooks, set markers, and create cron jobs. Check OpenShift User Guide for further details.
- Type: String

$class: 'DeployBox'

id
- Type: String
cloud
- Type: String
workspace
The workspace in ElasticBox to look for box to launch.
- Type: String
box
The box in the selected workspace to launch.
- Type: String
boxVersion
The version of the selected box. If Latest is selected then the version will be the box itself or the last version depending on how the box is shared in the selected workspace.
- Type: String
instanceName
- Type: String
profile
- Type: String
claims
- Type: String
provider
- Type: String
location
- Type: String
instanceEnvVariable
Define an environment variable for the instance deployed by this build step. The variable will hold the instance ID.
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
- Type: String
tags
Comma-separate tags to be added to the instance. These tags will be used to look up for the instance to determine whether the instance already exists. Build parameters or environment variables can be specified in tag with the format ${VARIABLE_NAME}
- Type: String
variables
- Type: String
expiration
Select whether the deployed instance will be expired via termination or shutdown in a specific number of hours from now or at a specific date and time in the future.
- $class: 'AlwaysOn'
- $class: 'ShutDown'
- $class: 'Terminate'
autoUpdates
- Type: String
alternateAction
- Type: String
waitForCompletion
- Type: boolean
waitForCompletionTimeout
Timeout in minutes to wait for this Deploy Box build step to complete. This field is ignored if Wait for completion is unchecked.
- Type: int
boxDeploymentType
- Type: String

samDeploy

settings
- credentialsId
  - Type: String
- region
  - Type: String
- s3Bucket
  The name of the S3 bucket where this command uploads the artifacts that are referenced in your template.
  S3 bucket will be created automatically if it does not exist.
  - Type: String
- stackName
  The name of the AWS SAM stack you're deploying to. If you specify an existing stack, the command updates the stack. If you specify a new stack, the command creates it.
  - Type: String
- templateFile
  The path, relative to the workspace directory, where your AWS SAM template is located.
  
  Examples:
  template.yaml
  app/template.json
  - Type: String
- kmsKeyId (optional)
  The ID of an AWS KMS key that the command uses to encrypt artifacts that are at rest in the S3 bucket. If not specified, SSE-AES256 is used.
  - Type: String
- outputTemplateFile (optional)
  The path to the file (relative to the workspace directory) where the build step writes the output AWS SAM template.
  template-#jobId.yaml by default.
  - Type: String
- parameters (optional)
  A list of key-value pairs that specify input parameters for the change set.
  - key
    - Type: String
  - value
    - Type: String
- roleArn (optional)
  The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS SAM assumes when executing the change set.
  - Type: String
- s3Prefix (optional)
  A prefix name that the command adds to the artifacts' name when it uploads them to the S3 bucket. The prefix name is a path name (folder name) for the S3 bucket.
  - Type: String
- tags (optional)
  A list of tags to associate with the stack that is created or updated. AWS SAM also propagates these tags to resources in the stack.
  - key
    - Type: String
  - value
    - Type: String

$class: 'DeployChartBuildStep'

id
- Type: String
kubeName
- Type: String
namespace
- Type: String
chartsRepo
- Type: String
chartName
- Type: String
deleteChartWhenFinished
If checked, the deployed Chart will be deleted once the job has finished.
- Type: boolean

crxDeploy

Deploy CRX Content Package files from the workspace to a configured Adobe Granite repository via the CRX Package Manager.

Only package files with .zip or .jar extensions will be identified and deployed.

packageIdFilters (optional)
Specify a list of package ID filters and path filters to match against identified Vault packages located in the workspace. Each filter string must occupy its own line.

A Package ID consists of the group, the name, and the version of a package, separated by colons (':').
Package ID filters must follow one of three patterns:
- group:name:version
- group:name
- name
Each segment in the package ID filter may be either ommitted or replaced with an asterisk ('*') to represent a wildcard.

This step now supports path filters as well. A path filter is a path suffix relative to the localDirectory ending in '.zip' or '.jar', which may include '**', '*', and '?' wildcard characters.

For example, this pattern will match all zip files under the Local Directory:
```
        **/*.zip
    
```
This pattern will only match packages located directly under the Packages folder whose filenames begin with 'acme-':
```
        Packages/acme-*.zip
    
```
Matching 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.

This field supports parameter tokens.
- Type: String
baseUrls (optional)
Specify the base URL of the Adobe Granite server, including hostname and port. The CRX Package Manager service path will be appended to this value for all requests. For example, http://localhost:4502 or https://author.mycorp.com, etc.

Multiple urls can be specified, one per line. All specified packages will be deployed to one server before beginning deployments to the next one.

If login credentials for one of the servers are different than those configured in the Connection Options section, you may override them in the Base URL by inserting username[:password]@ between the scheme and the hostname.

For example, to override the Username without changing the associated password or private key, you may use the following form:

http:// deployer@localhost:4502

To override the credentials completely, provide a username and password (which may be provided by an encrypted parameter) by separating them with a colon, as shown below:

http:// deployer:Password123@localhost:4502

This field supports parameter tokens.
- Type: String
acHandling (optional)
Change the way content ACL's included in the package filter scope are handled during installation.

Defer to Package

Allow package to specify AC Handling mode. (This can be dangerous. Consider using a Validate CRX Content Packages step to check packages for destructive AC Handling rules before you deploy them.)

Ignore

Ignores the packaged access control and leaves the target unchanged.

MergePreserve

Merge access control in the content with the one provided with the package by adding the access control entries of principals not present in the content (i.e. content first). It never alters access control entries already existing in the content.

Merge

Merge access control provided with the package with the one in the content by replacing the access control entries of corresponding principals (i.e. package first). It never alters access control entries of principals not present in the package.

Overwrite

Applies the access control provided with the package to the target. This also removes existing access control.

Clear

Clears all access control on the target system.
- Type: String
autosave (optional)
Specify the number of changes to batch before saving the JCR session during package installation.
- Type: int
behavior (optional)
Specify the behavior when a package exists on the target server that has the same package ID as one you are trying to deploy.
- Type: String
credentialsId (optional)
Select the login credentials with which content packages will be deployed to the CRX server.

[Signature] credentials may be used if the target server supports HTTP Signature Authentication using the keyId format, /$username/keys/$fingerprint.

Select "-none-" to use the default credentials set in the global CRX Content Package Deployer - HTTP Client configuration.
- Type: String
disableForJobTesting (optional)
Check this box to disable package deployment during Jenkins Job testing. For example, it is often necessary to test changes to artifact resolution configuration or to test Vault package identification. By checking this box, you can be sure that no installation will occur on any Granite server, and you will also see additional debug messaging in the console log describing the results of identification of Vault packages in the workspace.
- Type: boolean
localDirectory (optional)
Specify a path relative to the workspace in which to scan for packages.

This field supports parameter tokens.
- Type: String
recursive (optional)
Check this box to install any sub-packages along with the deployed package.
- Type: boolean
replicate (optional)
Check this box to replicate each package after installation. This will not be attempted if the package installation fails, and only packages which have actually been installed by this step (rather than simply uploaded or skipped) will be replicated. This happens asynchronously, so you won't really know if the replication was successful or not unless you manually check your replication agent logs. For this reason, it might be better instead to deploy to each replication target directly.
- Type: boolean
requestTimeout (optional)
Specify the timeout in milliseconds to wait for a response for each individual request. Specify a value of 0 to use default behavior.
- Type: long
serviceTimeout (optional)
Specify the timeout in milliseconds to wait for PackageManager service availability between sending POST requests. Specify a value of 0 to use default behavior.
- Type: long
waitDelay (optional)
Specify a delay in milliseconds before calls to check for Package Manager service availability. Increase this value if a /crx/packmgr node is sometimes created in the repository by this step, indicating that the Package Manager servlet was brought down for bundle installation AFTER a successful check for service availability, but BEFORE the next POST request was sent. What happens is that the SlingPostServlet takes over when the crx-packagemgr bundle is refreshed and creates nodes for any POST requests that it handles. Increasing this delay gives more time for the bundle refresh process to begin on the server.
- Type: long

$class: 'DeployPromotionBuilder'

hosts

$class: 'DeployScriptBuilder'

Execute any arbitrary SQL script on a selected database.

out
Specify full path to target connection file.

File location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}file or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}file.
- Type: String
in
Specify path to file that contains SQL script.

File location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}file or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}file.
- Type: 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)
The BuildMaster Application Id to trigger the build for. If the field is empty then assumes the "Select BuildMaster Application" action has been used to provide the value and will look this up using the expression "${BUILDMASTER_APPLICATION_ID}".
This setting would only be altered if not using the "Select BuildMaster Application" action.
- Type: String
deployVariables (optional)

Set deployment level variables.
- variables
  Provide a list of variables to pass to BuildMaster.
  - A variable must be in the format "variable=value"
  - Additional variables must be declared on separate lines
  - Lines starting with # are treated as comments
  - When using pipeline script and you want to pass several variables use one of these formats:
    
    Separate variables using newline character. Generated script will resemble: variables: 'var1=one\nvar2=two'
    
    Separate variables using multi-line string. Generated script will resemble: variables: '''var1=one
    var2=two'''
  - Type: String
packageNumber (optional)
The BuildMaster release number to trigger the build for. If the field is empty then assumes the "Select BuildMaster Application" action has been used to provide the value and will look this up using the expression "${BUILDMASTER_RELEASE_NUMBER}".
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.
- Type: String
printLogOnFailure (optional)
If checked will print the BuildMaster log for the deployment to the Jenkins console if the build fails - but only if the "Wait until deployment completed" option is also checked.
- Type: boolean
releaseNumber (optional)
The BuildMaster release number to trigger the build for. Defaults to the BUILDMASTER_RELEASE_NUMBER variable populated by the "Select BuildMaster Application" action. The job will fail if there is no active BuildMaster release.
- Type: String
stage (optional)

Optional. If not supplied, the next stage in the pipeline will be used.
- Type: String
waitUntilDeploymentCompleted (optional)
If checked waits until BuildMaster has completed the deployment, otherwise will exits as soon as successfully triggered the build creation.
- Type: boolean

$class: 'Deployer'

stack
The GitHub repository where the stack is stored, in the form <owner>/<name> (no spaces!).
- Type: String
dryRun
Whether to deploy in dry-run mode.
- Type: boolean
branch
The repository branch to deploy.
- Type: String
apiKey
The Stack Hammer API key, copied from the stack settings dialog in the Stack Hammer user interface.
- Type: String

$class: 'DeploymentBuilder'

url
Enter the Convertigo server url here. COnvertigo server url is in this form
http://<server>:<port>/convertigo
- Type: String
userId
Enter the Convertigo server administration console userid here..
- Type: String
password
Enter the Convertigo server administration console password here.
- Type: String
enableZipFile
- Type: boolean
enableAutoDeploy
- Type: boolean
enableTestCase
- testcaseblock
  - projectname
    Select in this list here a project name you want to test. This list is retrieved from the target Convertigo server each time you add a new Test block.
    - Type: String
  - testcasename
    Select in this list here a test case you want to run.
    - Type: String
  - xpath
    By clicking the Execute Testcase button you will have the data resulting from a testcase. Reading this data you will be able to enter assertions in this text box your assertions. Supported Syntax is :
    
    assert ok
    xpath expression1
    xpath expression2
    ...
    xpath expressionn
    
    assert nok
    xpath expression1
    xpath expression2
    ...
    xpath expressionn
    
    All Xpath expressions below assert ok must match to have this test to be a success.
    One Xpath expressions below assert nok must match to have this test to be a failure.
    
    You can test you assertions by clicking the Validate XPath button. The test result will display beneath this text box.
    - Type: 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
If configured, the regular expression will be applied to each line in the build log. A description will be set based on the first match.
To select the version of a Maven release, you can use this regular expression:
```
\[INFO\] Uploading project information for [^\s]* ([^\s]*)
```
- Type: String
description
The description to set on the build.
- If a regular expression is configured, every instance of \n will be replaced with the n-th group of the regular expression match.
- If the description is empty, the first group selected by the regular expression will be used as description.
- If no regular expression is configured, the description is taken verbatim.
- Type: String

devSpacesCreate

azureCredentialsId
- Type: String
aksName (optional)
- Type: String
kubeconfigId (optional)
- Type: String
resourceGroupName (optional)
- Type: String
sharedSpaceName (optional)
The name of the parent dev space of the current dev space.
- Type: String
spaceName (optional)
- Type: 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
Set to true to override the default global connection setting to CA DevTest registry for the particular project
- Type: boolean
host
The correct hostname or registry name needs to be entered
- Type: String
port
Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
- Type: String
marFilePath
Path to MAR file that will be uploaded to the VSE. Needs to be relative path to MAR file in job workspace.
- Type: String
testType
Choose whether mar file contains test or test suite.
- Type: 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".
- Type: String
secured
Set to true if the CA DevTest API are set to accept only https connections
- Type: 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
Set to true to override the default global connection setting to CA DevTest registry for the particular project
- Type: boolean
host
The correct hostname or registry name needs to be entered
- Type: String
port
Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
- Type: String
vseName
Use the name of the VSE to which you want this build step to apply
- Type: String
marFilesPaths
Path to MAR file that will be uploaded to the VSE. The field supports multiple strings delimited by a separate line or comma.
Possibilities:
for files in job workspace you can specify:
- relative path to MAR file in job workspace (example: dir/test.mar)
- path to MAR files using ant glob syntax (example: **/*.mar)
for files on the DevTest machine you can specify:
- absolute path to file (example: file:///C:/something/test.mar)
- http location of MAR file (example: http://something/test.mar)
- Type: 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".
- Type: String
secured
Set to true if the CA DevTest API are set to accept only https connections
- Type: 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
Set to true to override the default global connection setting to CA DevTest registry for the particular project
- Type: boolean
host
The correct hostname or registry name needs to be entered
- Type: String
port
Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
- Type: String
vseName
Use the name of the VSE to which you want this build step to apply
- Type: String
vsNames
Names of Virtual Services existing on provided VSE delimited by a separate line or comma.
- Type: 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".
- Type: String
secured
Set to true if the CA DevTest API are set to accept only https connections
- Type: 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
Set to true to override the default global connection setting to CA DevTest registry for the particular project
- Type: boolean
host
The correct hostname or registry name needs to be entered
- Type: String
port
Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
- Type: String
vseName
Use the name of the VSE to which you want this build step to apply
- Type: String
vsNames
Names of Virtual Services existing on provided VSE delimited by a separate line or comma.
- Type: 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".
- Type: String
secured
Set to true if the CA DevTest API are set to accept only https connections
- Type: 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
Set to true to override the default global connection setting to CA DevTest registry for the particular project
- Type: boolean
host
The correct hostname or registry name needs to be entered
- Type: String
port
Enter the port on which the registry is running. The default port is 1505. If you changed it, you can find the port in the LISA properties file as lisa.webserver.port followed by the port number
- Type: String
vseName
Use the name of the VSE to which you want this build step to apply
- Type: String
vsNames
Names of Virtual Services existing on provided VSE delimited by a separate line or comma.
- Type: 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".
- Type: String
secured
Set to true if the CA DevTest API are set to accept only https connections
- Type: boolean

importDeveloperProfile

profileId
- Type: String
developerProfileId (optional)
- Type: String
importIntoExistingKeychain (optional)
- Type: boolean
keychainName (optional)
- Type: String
keychainPath (optional)
- Type: String
keychainPwd (optional)

$class: 'DiawiUploader'

token
- Type: String
fileName
- Type: String
proxyHost
- Type: String
proxyPort
- Type: int
proxyProtocol
- Type: 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
  - Type: String
libLocations
- libDir
  - Type: 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.
- Type: 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
- Type: 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".
- Type: boolean

$class: 'DockerBuilderControl'

option
- $class: 'DockerBuilderControlOptionProvisionAndStart'
- $class: 'DockerBuilderControlOptionRun'
- $class: 'DockerBuilderControlOptionStart'
- $class: 'DockerBuilderControlOptionStop'
- $class: 'DockerBuilderControlOptionStopAll'

$class: 'DockerBuilderNewTemplate'

Adds specified image configuration to all Docker Clouds.

dockerTemplate
- dockerTemplateBase
  - $class: 'DockerTemplateBase'
- 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.
  
  Attach Docker container
  
  This method runs a container, then connects to it using 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.
  
  Connect with JNLP
  
  The container will only be passed an initial 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.
  
  Connect with SSH
  
  The specified image is expected to run an SSH server. Then, it will treat that computer like it usually does for any SSH connected agent: the master will log into it, copy the remoting agent, then start it.
  - attach
  - jnlp
  - ssh
- labelString
  Labels to give these nodes (for limiting your builds)
  - Type: 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.
  - Type: String
- disabled (optional)
  - disabledByChoice (optional)
    - Type: boolean
  - enabledByChoice (optional)
    If not ticked then this functionality will be disabled.
    This can be used to e.g. take a cloud or template out of action for maintenance etc.
    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.
    - Type: boolean
- mode (optional)
  - Values: NORMAL, EXCLUSIVE
- name (optional)
  Name prefix to use for all the Jenkins nodes created from this template.
  Jenkins will append a unique ID to this name in order to create individual node names.
  If blank or just whitespace, a default of "docker" will be used.
  - Type: String
- nodeProperties (optional)
- pullStrategy (optional)
  Pull strategy during provisioning before image run.
  - Values: PULL_ALWAYS, PULL_LATEST, PULL_NEVER
- pullTimeout (optional)
  Timeout, in seconds, to apply when expecting data from the Docker API when performing the docker pull operation. 0 means no time limit, but this is not recommended (if your docker API locks up, some aspects of Jenkins can also lock up).
  i.e. you probably want this set to as long as it takes to pull the entire image onto a fresh docker server. e.g. a few minutes.
  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).
  - Type: int
- remoteFs (optional)
  Root directory within your image for the Jenkins user to use
  - Type: String
- removeVolumes (optional)
  Remove the volumes associated to the container during container remove.
  - Type: boolean
- retentionStrategy (optional)
  
  Specify the strategy when docker containers shall be started and stopped:
  
  Docker Once Retention Strategy (default)
  
  For each job in the queue, an own docker container is started. Once the job has finished, the container is shut down.
  
  Docker Cloud Retention Strategy (experimental)
  
  Based on the workload provided by the queue (load average), new docker containers are started on demand. After the job(s) have finished, the container is not shut down immediately. If no new job was executed on this slave/container during the period of the Idle delay, the container is shut down.
  
  Keep this slave on-line as much as possible (experimental)
  
  Starts as many containers as specified in the Instance Capacity (obeying the Container Cap) and tries to keep them always running (i.e. a new container is started in case another one belonging to this template was shut down).
  
  Take this slave on-line according to a schedule (experimental)
  
  Based on a cron-schedule slaves are brought on-line and will keep running. Once the specified period in the schedule is over, the slaves will be shut down.
  
  Take this slave on-line when in demand and off-line when idle (experimental)
  
  Containers are started if there are jobs waiting for execution in the queue. They are only started, if the jobs are waiting a certain threshold of time there (In demand delay). After the jobs have finished, the container is not shut down immediately. If no new job was executed on this slave/container during the period of the Idle delay, the container is shut down.
  - idleMinutes
    Number of minutes of idleness after which to kill the slave; serves a backup in case the strategy fails to detect the end of a task
    - Type: int

$class: 'DockerBuilderPublisher'

Build step that sends a Dockerfile for building to docker host that used for this build run.

dockerFileDirectory
- Type: String
fromRegistry
- url
  URL to the Docker registry you are using. May be left blank to use the public DockerHub registry (currently https://index.docker.io/v1/).
  - Type: String
- credentialsId
  - Type: String
cloud
Cloud to do the build on - or, if empty, use the cloud that the build was performed on.
- Type: String
tagsString
Repository name (and optionally a tag) to be applied to the resulting image in case of success.
Multiple entries are permitted if separated by newlines.
Environment variable substitution is performed on the strings so you can use e.g. ${BUILD_NUMBER} as part of each entry.
Each entry must be of the form IMAGE[:TAG] as per the docker tag command.
- Type: String
pushOnSuccess
If enabled (and the docker image builds successfully), the resulting docker image will be pushed to the registry (or registries) specified within the "Image" field.
- Type: boolean
pushCredentialsId
Credentials to push to a private registry.
- Type: String
cleanImages
- Type: boolean
cleanupWithJenkinsJobDelete
- Type: boolean

$class: 'DockerComposeBuilder'

useCustomDockerComposeFile
- Type: boolean
dockerComposeFile
- Type: String
option
- $class: 'ExecuteCommandInsideContainer'
- $class: 'StartAllServices'
- $class: 'StartService'
- $class: 'StopAllServices'
- $class: 'StopService'

$class: 'DockerPullImageBuilder'

registry
- url
  URL to the Docker registry you are using. May be left blank to use the public DockerHub registry (currently https://index.docker.io/v1/).
  - Type: String
- credentialsId
  - Type: String
image
Image ID on DockerHub. When set in combination with DockerHub trigger, a build will run when dockerhub builds a new image.
- Type: String

dockerShell

connector (optional)
- $class: 'CloudNameDockerConnector'
- $class: 'DockerConnector'
containerLifecycle (optional)
- createContainer (optional)
  - bindAllPorts (optional)
    - Type: boolean
  - bindPorts (optional)
    Bind ports from inside the container to outside of the host, scheme is hostport:containerport. Same effect as the "-p" or "-P" option on the CLI. Docker documentation
    - Type: String
  - command (optional)
    The command to run for this image, replaced by Jenkins Launchers
    - Type: String
  - cpuShares (optional)
    Similarly the operator can increase the priority of this container. By default (no value), all containers run at the same priority and get the same proportion of CPU cycles, but you can tell the kernel to give more shares of CPU time to one or more containers when you start them via Docker.
    
    Consult https://docs.docker.com/engine/reference/run/#cpu-share-constraint for further information.
    - Type: int
  - cpusetCpus (optional)
    Please follow format described at https://docs.docker.com/engine/reference/run/#cpuset-constraint
    - Type: String
  - cpusetMems (optional)
    https://docs.docker.com/engine/reference/run/#cpuset-constraint
    - Type: String
  - devicesString (optional)
    Add host device to container. For format please refer to Add host device to container (--device) documentation
    - Type: String
  - dnsString (optional)
    Set the DNS servers to use within your images, if not set Docker will use DNS settings of the host
    - Type: String
  - dockerLabelsString (optional)
    - Type: String
  - entrypoint (optional)
    - Type: String
  - environmentString (optional)
    - Type: String
  - extraHostsString (optional)
    A list of new line separated hostnames/IP mappings to be added to the container’s /etc/hosts file. Specified in the form "hostname:IP".
    - Type: String
  - hostname (optional)
    - Type: String
  - linksString (optional)
    Add link to another container. Only the form container:alias is supported (e.g. the_db_container:db).
    Consult https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/#communication-across-links for further information.
    - Type: String
  - macAddress (optional)
    Container MAC address (e.g. 92:d0:c6:0a:29:33)
    - Type: String
  - memoryLimit (optional)
    The operator can constrain the memory available to a container. If the host supports swap memory, then the setting can be larger than physical RAM.
    
    Consult Docker Run Documentation for further information.
    - Type: long
  - networkMode (optional)
    Set the Network mode for the container:
    - Empty: undefined, docker daemon defaults
    - 'bridge': creates a new network stack for the container on the docker bridge
    - 'none': no networking for this container
    - 'container:<name | id>': reuses another container network stack
    - 'host': use the host network stack inside the container. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
    - Type: String
  - privileged (optional)
    - Type: boolean
  - restartPolicy (optional)
    - policyName
      - Values: NO, UNLESS_STOPPED, ALWAYS, ON_FAILURE
    - maximumRetryCount
      - Type: int
  - shmSize (optional)
    - Type: long
  - tty (optional)
    - Type: boolean
  - user (optional)
    - Type: String
  - volumesFromString (optional)
    New line separated list of volumes to inherit from another container. Specified in the form <container name>[:<ro|rw>]
    If accessmode not specified, then default rw will be used.
    - Type: String
  - volumesString (optional)
    New line separated list of host volume mounts : <host/path>[<container/path>[<:mode>]]
    
    container/path create empty volume container/path
    
    host/path:container/path will mount host/path from host to container's container/path, read/write
    
    host/path:container/path:rw will mount host/path from host to container's container/path, read/write
    
    host/path:container/path:ro will mount host/path from host to container's container/path, read-only
    
    Note: if access mode not specified, then default rw will be used.
    - Type: String
  - workdir (optional)
    - Type: String
- image (optional)
  The hash or tagged name of the image that you wish docker to run (e.g "docker run -i -t /bin/bash")
  - Type: String
- pullImage (optional)
  - connector (optional)
    - $class: 'CloudNameDockerConnector'
    - $class: 'DockerConnector'
  - credentialsId (optional)
    Credentials for pulling docker image. Supported only "Docker Registry Auth" type.
    - Type: String
  - pullStrategy (optional)
    - Values: PULL_ALWAYS, PULL_ONCE, PULL_LATEST, PULL_NEVER
  - registriesCreds (optional)
    - registryAddr
      - Type: String
    - credentialsId
      - Type: String
- removeContainer (optional)
  - force (optional)
    Force the removal of a running container (uses SIGKILL)
    - Type: boolean
  - removeVolumes (optional)
    Remove the volumes associated with the container
    - Type: boolean
- stopContainer (optional)
  - connector (optional)
    - $class: 'CloudNameDockerConnector'
    - $class: 'DockerConnector'
  - timeout (optional)
    Sending SIGTERM and then SIGKILL after a grace period
    - Type: int
executorScript (optional)
- Type: String
longConnector (optional)
- $class: 'CloudNameDockerConnector'
- $class: 'DockerConnector'
shellScript (optional)
- Type: String

$class: 'DoktorStep'

server
- Type: String
markdownIncludePatterns
- value
  - Type: String
markdownExcludePatterns
- value
  - Type: String
asciidocIncludePatterns
- value
  - Type: String
asciidocExcludePatterns
- value
  - Type: String

$class: 'DotNetCoreRunner'

targetCode

Your c# code to execute, the plugin will rebuild your code if detect some change. These are some examples of the target code for this plugin:

Simple example:

            //Simple Example
            public class JenkinsPlugin
            {
                public static void ScriptMain()
                {
                    Console.WriteLine("Hello World from c#!!!");
                }
            }

Saving environment variables:

            // 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());
                }
            }

You can use this two methods from the DotNetTools.Jenkins.JenkinsManager class:

            public void SetSessionEnv(string key, string value);
            public string GetSessionEnv(string key);

Type: String

additionalPackages
A json object that represents the additional packages required to compile the c# code:
Examples:
- { "Nancy": "2.0.0-clinteastwood", "System.ValueTuple": "4.3.0"}
- { "Nancy": null}
Note that if you specify a null value for a package version then the latest one will be used.
- Type: String

downloadProgetPackage

Downloads a universal ProGet package to specified folder and will optionally unpack it for you.

Download options are:

Package - Download ProGet universal package (ZIP file with extension of 'upack')
Content as ZIP - Download content as ZIP file
Content as TGZ - Download content as TGZ file
Unpack Content - Extract the package content once downloaded

In all cases except 'Unpack Content' the environment variable PROGET_FILE will be populated with the name of the downloaded file

See Inedo documentation.

feedName
- Type: String
groupName
- Type: String
packageName
- Type: String
version
- Type: String
downloadFormat
- Type: String
downloadFolder
The folder to download the package to. The path can include environment variables in the format ${VAR} or $VAR.
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}

See the list of available environment variables.
- Type: String

crxDownload

Download CRX Content Package files from a configured Adobe Granite repository into the workspace via the CRX Package Manager.

packageIds (optional)
Specify a list of package IDs to download to the workspace. Each package ID string must occupy its own line.

A Package ID consists of the group, the name, and the version of a package, separated by colons (':'), as in: "group:name:version".

This field supports parameter tokens.
- Type: String
baseUrl (optional)
Specify the base URL of the Adobe Granite server, including hostname and port. The CRX Package Manager service path will be appended to this value for all requests. For example, http://localhost:4502 or https://author.mycorp.com, etc.

If login credentials for the server are different than those configured in the Connection Options section, you may override them in the Base URL by inserting username[:password]@ between the scheme and the hostname.

For example, to override the Username without changing the associated password or private key, you may use the following form:

http:// deployer@localhost:4502

To override the credentials completely, provide a username and password (which may be provided by an encrypted parameter) by separating them with a colon, as shown below:

http:// deployer:Password123@localhost:4502

This field supports parameter tokens.
- Type: String
credentialsId (optional)
Select the login credentials with which content packages will be downloaded from the CRX server.

[Signature] credentials may be used if the target server supports HTTP Signature Authentication using the keyId format, /$username/keys/$fingerprint.

Select "-none-" to use the default credentials set in the global CRX Content Package Deployer - HTTP Client configuration.
- Type: String
ignoreErrors (optional)
Check this box to ignore errors during download such that the build continues after completion of this step.
- Type: boolean
localDirectory (optional)
Specify a path relative to the workspace to which packages will be downloaded.

This field supports parameter tokens.
- Type: String
rebuild (optional)
Check this box to rebuild each package before downloading it. If rebuilding a package fails, the job will fail, unless Ignore Errors is also checked. If there are errors during rebuild, but it is ultimately reported as successful, then the job will be marked as unstable and the download step will continue.
- Type: boolean
requestTimeout (optional)
Specify the timeout in milliseconds to wait for a response for each individual request. Specify a value of 0 to use default behavior.
- Type: long
serviceTimeout (optional)
Specify the timeout in milliseconds to wait for PackageManager service availability between sending POST requests. Specify a value of 0 to use default behavior.
- Type: long
waitDelay (optional)
Specify a delay in milliseconds before calls to check for Package Manager service availability. Increase this value if a /crx/packmgr node is sometimes created in the repository by this step, indicating that the Package Manager servlet was brought down for bundle installation AFTER a successful check for service availability, but BEFORE the next POST request was sent. What happens is that the SlingPostServlet takes over when the crx-packagemgr bundle is refreshed and creates nodes for any POST requests that it handles. Increasing this delay gives more time for the bundle refresh process to begin on the server.
- Type: long

googleStorageDownload

credentialsId
- Type: 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.
- Type: String
localDirectory
The local directory that will store the downloaded files. The path specified is considered relative to the build's workspace. Example value:
- path/to/dir
- Type: 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.
- Type: String

$class: 'DoxygenBuilder'

doxyfilePath
- Type: String
installationName
- Type: String
continueOnBuildFailure
- Type: boolean
unstableIfWarnings
- Type: boolean

$class: 'DrMemoryBuilder'

executable
- Type: String
arguments
- Type: String
logPath
- Type: String
treatFailed
Enable this if dr-memory command line interface returns a non-zero return value even when the program creates a proper analysis
- Type: boolean

$class: 'DrupalInstanceBuilder'

db
Specify the database connection string, e.g. mysql://user:password@localhost/db
- Type: String
root
Specify a local directory for the Drupal root (relative to the workspace root). If left empty, the workspace root itself will be used.
- Type: String
profile
Specify an installation profile. Drupal 7 natively includes three installation profiles: 'minimal', 'standard' and 'testing'.
- Type: 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.
- Type: boolean
updb
If checked, every build will run update.php. This option only makes sense if 'Create a fresh installation for every build' is unchecked.
- Type: 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
- Type: boolean
comment
- Type: boolean
sql
- Type: boolean
security
- Type: boolean
i18n
- Type: boolean
root
Specify a local directory for the Drupal root (relative to the workspace root). If left empty, the workspace root itself will be used.
- Type: String
logs
Specify a local directory to dump code review results (relative to the workspace root). Use the Checkstyle plugin to interpret results in a post-build action.
- Type: 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.
- Type: 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.
- Type: boolean

$class: 'DrupalTestsBuilder'

uri
URI of the Drupal site. Simpletest requires this option to be set.
- Type: String
root
Specify a local directory for the Drupal root (relative to the workspace root). If left empty, the workspace root itself will be used.
- Type: String
logs
Specify a local directory to dump test results (relative to the workspace root). Use the JUnit plugin to interpret results in a post-build action.
- Type: String

exceptGroups

Specify Simpletest groups that should not be tested. For instance if you want to run tests only on custom code then you might want to exclude core groups:

  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-RPC

Multiple groups can be separated by a comma.

Type: String

exceptClasses

Specify Simpletest classes that should not be tested, for instance 'UserLoginTestCase'.

Multiple classes can be separated by a comma.
- Type: String

$class: 'ECXCDMBuilder'

name
Enter the ECX user name.
- Type: String
password
Enter the ECX password.
- Type: String
url
Enter the ECX URL and then press the Test Connection button to ensure this job can contact the ECX server.
- Type: String
job
Enter a job id that can be found in the list above and in square brackets.
- Type: String
production
Select this checkbox if using ECX in production with a valid certificate.
- Type: boolean
maxWaitTime
Enter the amount of time in seconds to wait for an ECX job to complete.
- Type: int

$class: 'EclipseBuckminsterBuilder'

installationName
- Type: String
commands
- Type: String
logLevel
- Type: String
params
- Type: String
targetPlatformName
- Type: String
userTemp
- Type: String
userOutput
- Type: String
userCommand
- Type: String
userWorkspace
- Type: String
globalPropertiesFile
- Type: String
equinoxLauncherArgs
- Type: String

azureIoTEdgeBuild

azureCredentialsId (optional)
- Type: String
defaultPlatform (optional)

In your .template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.
- Type: 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
- Type: String
resourceGroup (optional)
- Type: String
rootPath (optional)
- Type: String

azureIoTEdgeDeploy

azureCredentialsId (optional)
- Type: String
resourceGroup (optional)
- Type: 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.
- Type: String
deploymentFilePath (optional)
- Type: 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
- Type: String
deploymentType (optional)
- Type: String
deviceId (optional)
- Type: String
iothubName (optional)
- Type: 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
- Type: String
targetCondition (optional)

A target condition to determine which devices will be targeted with this deployment. Example tags.environment='test', properties.reported.devicemodel='4000x'
- Type: String

azureIoTEdgeGenConfig

azureCredentialsId (optional)
- Type: String
defaultPlatform (optional)

In your .template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.
- Type: String
deploymentFilePath (optional)
- Type: 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
- Type: String
resourceGroup (optional)
- Type: String
rootPath (optional)
- Type: String

azureIoTEdgePush

azureCredentialsId (optional)
- Type: String
resourceGroup (optional)
- Type: String
acrName (optional)
- Type: 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"
- Type: String
defaultPlatform (optional)

In your .template.json, you can leave the modules platform unspecified. For these modules, the default platform will be used.
- Type: 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
- Type: String
dockerRegistryEndpoint (optional)
- url
  URL to the Docker registry you are using. May be left blank to use the public DockerHub registry (currently https://index.docker.io/v1/).
  - Type: String
- credentialsId
  - Type: String
dockerRegistryType (optional)
- Type: String
rootPath (optional)
- Type: String

$class: 'ElasticsearchQueryBuilder'

query
Elastic Search query to run
- Type: String
aboveOrBelow
Whether the threshold value is too high or too low. If set to gte counts greater than or equal to threshold will fail the build. If set to lte counts less than or equal to threshold with fail the build.
- Type: String
threshold
The count of query results in a given time to trigger build failure
- Type: long
since
How long ago to look back for results relative to the time the build executes must be greater than 0.
- Type: long
units
Time units for the since value
- Type: String

$class: 'EnvInjectBuilder'

propertiesFilePath
- Type: String
propertiesContent
- Type: String

$class: 'EnvPropagatorBuilder'

envVariableString
Provide build env variables in format PARAM1=VAL1:PARAM2=VAL2... Existing build env variables will be overwritten and the new ones will be added and made available to the next build steps.
- Type: String

$class: 'EnvironmentManagerBuilder'

systemId
- Type: int
environmentId
- Type: int
instanceId
- Type: int
copyToServer
- Type: boolean
newEnvironmentName
- Type: String
serverType
- Type: String
serverId
- Type: int
serverHost
- Type: String
serverName
- Type: String
copyDataRepo
- Type: boolean
repoType
- Type: String
repoHost
- Type: String
repoPort
- Type: int
repoUsername
- Type: String
repoPassword
- Type: String
abortOnFailure
- Type: boolean

$class: 'EnvironmentTagBuilder'

credentials
- Type: String
region
- Type: String

$class: 'EstimateBuilder'

name
The name field is used to specify the PaaSLane application that the artifacts mapped later will be associated with. For example, if the name of this field is "My Application" and you match 3 artifacts, there will be an application "My Application" with 3 modules that get profiled.
- Type: String
token
The "Authentication Token" field contains the PaaSLane token associated with a specific user in a specific tenant. This token can be gotten by logging into PaaSLane, clicking the username dropdown and selecting to "Get Token". Once you have clicked this option you should be presented with the time sensitive token.
- Type: String
archiveFilePath
This optional value specifies an offset from the workspace of where to start looking for artifacts to include in the application. This, paired with "Regular Expression for Selecting Modules" and "Exclude Regular Expressions" help to specify included artifacts.
- Type: String
regWhichIncludedModules
This value specifies the Ant style regular expression used to search for artifacts residing under "Path to Artifact(s)". For examples of Ant Style regular expressions, please see examples.
- Type: String
reportConfigName
Name of the Report Config to use when generating the Report. If you leave this field blank, PaaSLane will use the Default Report Config.

To see your existing Report Configs, go to the PaaSLane UI, click "Applications", and click "New Report" next to an existing application. Under the "Create Report" button, you will see a dropdown that contains a list of existing Report Configs. You can click "Advanced" to see details and further configure your report.
- Type: String
uri
The "PaaSLane URL" field specifies the root url, including the host, port and context that define the location of the PaaSLane profiling environment to use. For most SaaS customers, this will be https://agent.paaslane.com/paaslaneagentserver. However, customers utilizing distributed profiling, will want to get their URL from their administrator.
- Type: String
saasuri
The "PaaSLane SaaS URL" field specifies the root url, including the host, port and context that define the location of the PaaSLane profiling environment to use. For most customers, this will be https://app.paaslane.com/paaslane.
- Type: String
language
The "Language" selection specifies which language rules should be applied to the artifacts that are uploaded and profiled.
- Type: String
regexExclude
The "Exclude Regular Expressions" field contains a comma separated list of regular expression patterns that will be applied to every matched artifact. If any of the patterns match the path of the artifact being reviewed, then that artifact will not be sent to PaaSLane. Examples of these regular expressions can be found here.
- Type: String
testOnly
The "Test, but don't send files" field, when checked, will only display the files that would have been sent, based on the parameters. Use this field to get the parameters correct.
- Type: boolean
maxNumberOfViolations
"Fail when Alert count greater than..." checkbox is selected, then this field will dictate the maximum number of allowable alerts. Anything more than this number will cause a failure.
- Type: long
failBlockTotalVio
The "Fail when Total Alert count greater than..." selection specifies if builds should be failed based on the total number of Alerts found.
- If this is not selected, builds will never be failed based on the number of total alerts found.
- If this is selected, builds will be failed if they exceed the maximum number of total alerts provided.
- Type: boolean
maxNumberOfBlockerViolations
"Fail when Blocker Alert count greater than..." checkbox is selected, then this field will dictate the maximum number of allowable blocker alerts. Anything more than this number will cause a failure.
- Type: long
failBlockBlockerVio
The "Fail when Blocker Alert count greater than..." selection specifies if builds should be failed based on the number of Blocker Alerts found.
- If this is not selected, builds will never be failed based on the number of blocker alerts found.
- If this is selected, builds will be failed if they exceed the maximum number of blocker alerts provided.
- Type: boolean
maxNumberOfImportantViolations
"Fail when Important Alert count greater than..." checkbox is selected, then this field will dictate the maximum number of allowable important alerts. Anything more than this number will cause a failure.
- Type: long
failBlockImportantVio
The "Fail when Important Alert count greater than..." selection specifies if builds should be failed based on the number of Important Alerts found.
- If this is not selected, builds will never be failed based on the number of important alerts found.
- If this is selected, builds will be failed if they exceed the maximum number of important alerts provided.
- Type: boolean
maxNumberOfOptimizationViolations
"Fail when Optimization Alert count greater than..." checkbox is selected, then this field will dictate the maximum number of allowable optimization alerts. Anything more than this number will cause a failure.
- Type: long
failBlockOptimizationVio
The "Fail when Optimization Alert count greater than..." selection specifies if builds should be failed based on the number of Optimization Alerts found.
- If this is not selected, builds will never be failed based on the number of optimization alerts found.
- If this is selected, builds will be failed if they exceed the maximum number of optimization alerts provided.
- Type: boolean
maxNumberOfWarningViolations
"Fail when Warning Alert count greater than..." checkbox is selected, then this field will dictate the maximum number of allowable optimization alerts. Anything more than this number will cause a failure.
- Type: long
failBlockWarningVio
The "Fail when Warning Alert count greater than..." selection specifies if builds should be failed based on the number of Warning Alerts found.
- If this is not selected, builds will never be failed based on the number of warning alerts found.
- If this is selected, builds will be failed if they exceed the maximum number of warning alerts provided.
- Type: boolean

examTest_ExecutionFile

For projects that use EXAM as the test system. This causes Jenkins to invoke EXAM with the given options.

examName
- Type: String
pythonName
- Type: String
examReport
- Type: String
systemConfiguration (optional)
- Type: String
clearWorkspace (optional)
- Type: boolean
javaOpts (optional)
- Type: String
logging (optional)
- Type: boolean
loglevelLibCtrl (optional)
- Type: String
loglevelTestCtrl (optional)
- Type: String
loglevelTestLogic (optional)
- Type: String
pathExecutionFile (optional)
- Type: String
pathPCode (optional)
- Type: String
pdfMeasureImages (optional)
- Type: boolean
pdfReport (optional)
- Type: boolean
pdfReportTemplate (optional)
- Type: String
pdfSelectFilter (optional)
- Type: String
reportPrefix (optional)
- Type: String
testrunFilter (optional)
- name
  - Type: String
- value
  - Type: String
- adminCases
  - Type: boolean
- activateTestcases
  - Type: boolean

examTest_Model

For projects that use EXAM as the test system. This causes Jenkins to invoke EXAM with the given options.

examName
- Type: String
pythonName
- Type: String
examReport
- Type: String
executionFile (optional)
- Type: String
systemConfiguration (optional)
- Type: String
clearWorkspace (optional)
- Type: boolean
examModel (optional)
- Type: String
javaOpts (optional)
- Type: String
logging (optional)
- Type: boolean
loglevelLibCtrl (optional)
- Type: String
loglevelTestCtrl (optional)
- Type: String
loglevelTestLogic (optional)
- Type: String
modelConfiguration (optional)
- Type: String
pdfMeasureImages (optional)
- Type: boolean
pdfReport (optional)
- Type: boolean
pdfReportTemplate (optional)
- Type: String
pdfSelectFilter (optional)
- Type: String
reportPrefix (optional)
- Type: String
testrunFilter (optional)
- name
  - Type: String
- value
  - Type: String
- adminCases
  - Type: boolean
- activateTestcases
  - Type: boolean

$class: 'ExeBuilder'

exeName
- Type: String
cmdLineArgs
- Type: String
failBuild
- Type: boolean

executeCerberusCampaign

campaignName
Enter the campaign name.
- Type: String
environment
- Type: String
browser
either
- Robot
or
- Robot server ip + Robot server port + browser

If you enter a robot, no need to enter Robot server ip + Robot server port + browser
- Type: String
screenshot
- Type: String
verbose
- Type: String
pageSource
- Type: String
seleniumLog
- Type: String
timeOut
- Type: String
retries
- Type: String
priority
- Type: String
tag
Tag for the execution of this campaign. Tag is used to group and display all testcases execution of the campaign.
Use $[current_timestamp] to put the current timestamp to the job execution.
- Type: String
ss_p
either
- Robot
or
- Robot server ip + Robot server port + browser

If you enter a robot, no need to enter Robot server ip + Robot server port + browser
- Type: String
ssIp
either
- Robot
or
- Robot server ip + Robot server port + browser

If you enter a robot, no need to enter Robot server ip + Robot server port + browser
- Type: String
robot
either
- Robot
or
- Robot server ip + Robot server port + browser

If you enter a robot, no need to enter Robot server ip + Robot server port + browser
- Type: String
manualHost
- Type: String
manualContextRoot
- Type: String
country
If empty, the countries defined on the campaign will be used.
- Type: String
cerberusUrl
- Type: String
timeOutForCampaignExecution
- Type: int

jobDsl

additionalClasspath (optional)
Newline separated list of additional classpath entries for the Job DSL scripts. All entries must be relative to the workspace root, e.g. build/classes/main. Supports Ant-style patterns like lib/*.jar.
- Type: String
additionalParameters (optional)
failOnMissingPlugin (optional)
If checked, the build will be marked as failed if a plugin must be installed or updated to support all features used in the DSL scripts. If not checked, the build will be marked as unstable instead.
- Type: boolean
failOnSeedCollision (optional)
Fail build if generated item(s) have the same name as existing items already managed by another seed job. By default, this plugin will always regenerate all jobs and views, thus updating previously generated jobs and views even if managed by another seed job. Check this box if you wish to fail the job if a generated item name collision is detected.
- Type: boolean
ignoreExisting (optional)
Ignore previously generated jobs and views. By default, this plugin will always regenerate all jobs and views, thus updating previously generated jobs and views. Check this box if you wish to leave previous jobs and views as is.
- Type: boolean
ignoreMissingFiles (optional)
Ignore missing DSL scripts. If not checked, the build step will fail if a configured script is missing or if a wildcard does not match any files.
- Type: boolean
lookupStrategy (optional)
Determines how relative job names in DSL scripts are interpreted. You will only see a difference when the seed job is located in a folder.
- Jenkins Root When this option is selected relative job names are always interpreted relative to the Jenkins root.
- Seed Job If you choose this option relative job names in DSL scripts will be interpreted relative to the folder in which the seed job is located. Suppose you have a seed job which is located in a folder named seedJobFolder and a DSL script which creates a job named subfolder2/job. The job that is created by the seed job will be at the location /seedJobFolder/subfolder2/job.
- Values: JENKINS_ROOT, SEED_JOB
removedConfigFilesAction (optional)
- Values: IGNORE, DELETE
removedJobAction (optional)
Specifies what to do when a previously generated job is not referenced anymore.
- Values: IGNORE, DISABLE, DELETE
removedViewAction (optional)
Specifies what to do when a previously generated view is not referenced anymore.
- Values: IGNORE, DELETE
sandbox (optional)
If checked, runs the DSL scripts in a sandbox with limited abilities. You will also need to configure this job to run with the identity of a particular user. If unchecked, and you are not a Jenkins administrator, you will need to wait for an administrator to approve the scripts.
- Type: boolean
scriptText (optional)
DSL Script, which is groovy code. Look at documentation for details on the syntax.
- Type: String
targets (optional)
Newline separated list of DSL scripts, located in the Workspace. Can use wildcards like 'jobs/**/*.groovy'. See the @includes of Ant fileset for the exact format.
Scripts are executed in the same order as specified. The execution order of expanded wildcards is unspecified.
- Type: String
unstableOnDeprecation (optional)
If checked, marks the build as unstable when using deprecated features. If not checked, a warning will be printed to the build log only.
- Type: boolean
useScriptText (optional)
- Type: boolean

$class: 'ExecuteJobBuilder'

jobId
- Type: long
jobName
- Type: String
jobType
- Type: String
abortOnFailure
- Type: boolean
publish
- Type: boolean
projectId
- Type: long
buildId
- Type: String
sessionTag
- Type: String
appendEnv
- Type: boolean

$class: 'ExecuteKatalonStudioTask'

version
- Type: String
location
- Type: String
executeArgs
- Type: String
x11Display
- Type: String
xvfbConfiguration
- Type: String

execMan

requestType (optional)
- Type: String
altEMConfig (optional)
Optional alternative Execution Manager configuration. If provided, these parameters override those specified in Jenkins global configuration.
- url
  - Type: String
- credentials
  - Type: String
bookmark (optional)
Select this to run a predefined bookmark configured on the Execution Manager via the Management Studio.
- name
  - Type: String
- folder (optional)
  - Type: String
execParams (optional)
Optional execution request parameters. Both a key and value must be specified. The value can refer to Jenkins environment variables using this syntax - ${ JENKINS_ENV_VAR }. For example - ${BUILD_ID}.
- list (optional)
  - key
    - Type: String
  - value
    - Type: String
postExecute (optional)
Optional post execution action. To perform any post action, provide action name along with the need parameters.
- action
  - Type: String
- params
  - Type: String
processList (optional)
Select this to execute a list of Certify processes without creating a request or bookmark first.
- database
  Alias name of the Certify connection saved in Management Studio > Configuration > Certify Configuration.
  - Type: String
- project
  Certify project where processes reside.
  - Type: String
- processes
  List of the fully qualified path to each process.
  - processPath
    - Type: String
- folder
  Folder where Certify Results will be saved. If not specified, results go to the root results folder.
  - Type: String
- requestName
  Name given to the request execution.
  - Type: String
request (optional)
Select this to run a predefined request configured on the Execution Manager.
- name
  - Type: String
waitConfig (optional)
Optional execution request wait configuration. Both the polling interval and maximum run time must be specified in seconds.
- pollInterval
  - Type: String
- maxRunTime
  - Type: String

$class: 'ExecutorBuildStep'

frameworkType
The supported framework by this step are XCUITest (by Apple) and Espresso (by Google).
- Type: String
runningType
- Fast Feedback - will distribute the tests between the maximum pull of devices available. Every test will be execute once.
- Coverage - will execute all the tests on all of the selected devices. Every test will be execute on every selected device.
- Type: String
app
The application to test, in case of XCUITest should be an IPA file and in case of Espresso should be an APK file.
- Type: String
testApplication
The application contain the tests to execute, in case of XCUITest should be an IPA file and in case of Espresso should be an APK file.
- Type: String
deviceQueries
A query string that will enable to select the devices that will be used. For example:
- @serialnumber=’aabbccddee’
  Will select a specific device with a given serial number of udid.
- @os=’android’ and @versionnumber > 5.0
  Select android with a version that is bigger than 5.0
Other field that can be used:
- manufacture: device manufacture for example: samsung
- model: Device model, for example: SM-G935F
- modelName: Device marketing name: for example: Galaxy S7 Edge
- name
- os: Operating system.
- remote: If device is connected through SeeTestCloud or not (values are true/false).
- serialnumber: S/N of the device.
- version: The device's operating system version (for example 4.1.2).
- versionnumber: The device's operating system version number (for example 4.1).
- category: The device category. Currently supported in android devices. possible values- 'WATCH', 'PHONE' or 'TABLET'.
- Type: String
runTags
All tests that are part of this step will be ‘tagged’ with the provided key value. The tags will enable to filter your specific execution.
- Type: 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.
  - Type: 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.
  - Type: int
- ignoreTestsFile
  - iOS - xcscheme file
  - Android - text file with include full class name:
    - <class name 1>,<method name 1>
    - <class name 2>,<method name 2>
  - Type: String
- overallExecTimeout
  Set the step overall execution timeout. If the step execution time exceeded the given time, it will end with failure.
  - Type: int
- creationTimeout
  - Type: int

exportIpa

appURL (optional)
- Type: 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
```
- Type: String
assetPackManifestURL (optional)
- Type: String
compileBitcode (optional)
- Type: boolean
copyProvisioningProfile (optional)
- Type: boolean
developmentTeamID (optional)
- Type: String
developmentTeamName (optional)
- Type: String
displayImageURL (optional)
- Type: String
fullSizeImageURL (optional)
- Type: String
ipaExportMethod (optional)
- Type: String
ipaName (optional)
- Type: String
ipaOutputDirectory (optional)
- Type: String
keychainName (optional)
- Type: String
keychainPath (optional)
- Type: String
keychainPwd (optional)
- Type: String
manualSigning (optional)
- Type: boolean
packResourcesAsset (optional)
- Type: boolean
provisioningProfiles (optional)
- provisioningProfileAppId
  - Type: String
- provisioningProfileUUID
  - Type: String
resourcesAssetURL (optional)
- Type: String
signingMethod (optional)
- Type: String
stripSwiftSymbols (optional)
- Type: boolean
symRoot (optional)
- Type: String
thinning (optional)
- Type: String
unlockKeychain (optional)
- Type: boolean
uploadBitcode (optional)
- Type: boolean
uploadSymbols (optional)
- Type: boolean
xcodeName (optional)
- Type: String
xcodeProjectPath (optional)
- Type: String
xcodeSchema (optional)
- Type: String
xcodeWorkspaceFile (optional)
- Type: String

exportPackages

Exports ECU-TEST packages and their attributes to a test management system like RQM or ALM.

exportConfigs (optional)
- $class: 'ExportPackageAttributeConfig'
- $class: 'ExportPackageConfig'
- $class: 'ExportProjectAttributeConfig'
- $class: 'ExportProjectConfig'
- $class: 'ImportPackageAttributeConfig'
- $class: 'ImportPackageConfig'
- $class: 'ImportPackageDirConfig'
- $class: 'ImportProjectArchiveConfig'
- $class: 'ImportProjectAttributeConfig'
- $class: 'ImportProjectConfig'
- $class: 'ImportProjectDirConfig'

$class: 'ExportParametersBuilder'

filePath
The path of exported file. This can be relative path against the workspace. Proper file extension is added to the end of path. You can prevent it by adding "." to the end of path. If parameters are actually exported to file, The path is provided as a parameter EXPORT_PARAMS_FILE.
- Type: String
fileFormat
The format of exported file. You can select one of the followings.
- Properties (.properties)
- XML (.xml)
- JSON (.json)
- YAML (.yml)
If parameters are actually exported to file, The format name is provided as a parameter EXPORT_PARAMS_FORMAT.
- Type: String
keyPattern
You can specify the list of keys delimited by ",". A key is treated as prefix. If it matches the beginning of parameter's key, its parameter would be exported. If empty, all parameters would be exported.
- Type: String
useRegexp
Check if you want to use regular expression as key pattern.
- Type: boolean

exportProjects

Exports ECU-TEST projects and their attributes to a test management system like RQM or ALM.

exportConfigs (optional)
- $class: 'ExportPackageAttributeConfig'
- $class: 'ExportPackageConfig'
- $class: 'ExportProjectAttributeConfig'
- $class: 'ExportProjectConfig'
- $class: 'ImportPackageAttributeConfig'
- $class: 'ImportPackageConfig'
- $class: 'ImportPackageDirConfig'
- $class: 'ImportProjectArchiveConfig'
- $class: 'ImportProjectAttributeConfig'
- $class: 'ImportProjectConfig'
- $class: 'ImportProjectDirConfig'

$class: 'ExporterBuilder'

$class: 'ExtensiveTestingBuilder'

testPath
- Type: String
login
- Type: String
password
- Type: String
serverUrl
- Type: String
projectName
- Type: String
debug
- Type: boolean

downloadFeatureFiles

Downloads feature files from Test Management for Jira.

serverAddress
One of the preconfigured Jira instances. If you do not have any, please go to General Configuration and set up a new Jira instance.
- Type: String
projectKey
Jira project key to filter test cases.
- Type: String
targetPath
The path where the downloaded feature files will be placed.
- Type: String

$class: 'FigletBuilder'

message
Help file for fields are discovered through a file name convention. This file is help for the "name" field. You can have arbitrary HTML here. You can write this file as a Jelly script if you need a dynamic content (but if you do so, change the extension to .jelly).
- Type: String

fileOperations

fileOperations
- fileCopyOperation
- fileCreateOperation
- fileDeleteOperation
- fileDownloadOperation
- fileJoinOperation
- filePropertiesToJsonOperation
- fileRenameOperation
- fileTransformOperation
- fileUnTarOperation
- fileUnZipOperation
- fileZipOperation
- folderCopyOperation
- folderCreateOperation
- folderDeleteOperation
- folderRenameOperation

$class: 'FireLineBuilder'

fireLineTarget

Nested Object

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".
- Type: boolean
blockBuild

If there are some questions of block level detected from your project,FireLine plugin will make build fail when you select "Yes".
- Type: boolean

configuration

配置文件，可以通过该配置控制FireLine扫描规则、过滤文件等功能。访问火线(FireLine)官网查看更多详情。配置内容的写法如下：

          

                     <?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>

以上配置文件去掉了日志类的规则，所以火线扫描过程中就不会执行日志类规则的检查。

Type: String

reportPath
FireLine火线扫描后产生的结果报告路径。也可以使用jenkins环境变量，例如${WORKSPACE}。默认扫描报告文件名为testReport.html。
- Type: String
reportFileName
FireLine火线扫描后产生的结果报告文件名。默认扫描报告文件名为testReport.html。也可以使用jenkins环境变量，例如testReport_${buildID}.html
- Type: String
buildWithParameter

可通过配置使用build with parameter插件，在项目构建时灵活使用火线扫描。

例如：在项目配置中设置参数化构建参数。配置boolean类型参数fireline。

则在此输入框中填写${fireline}即可
- Type: String
jdk

JDK to be used for this FireLine analysis.

Tips:
JDK1.7 or 1.8 is compatible with FireLine.
- Type: String
jvm

合理设置JVM参数可以有效提高扫描效率，建议JVM最低配置如下：

"-Xms1g -Xmx1g -XX:MaxPermSize=512m"
- Type: String

$class: 'FitnesseBuilder'

options

$class: 'FixResultBuilder'

Set the build result (helps testing project configurations, notifications, promotions, upstream/downstream dependencies etc.)

defaultResultName
Set the build result for when the build number is not listed in the advanced options
- Type: String
success
A list of comma or space separated build numbers for which the result should be success
- Type: String
unstable
A list of comma or space separated build numbers for which the result should be unstable
- Type: String
failure
A list of comma or space separated build numbers for which the result should be failure
- Type: String
aborted
A list of comma or space separated build numbers for which the result should be aborted
- Type: String

flywayrunner

installationName
- Type: String
flywayCommand
- Type: String
url
- Type: String
locations
- Type: String
commandLineArgs
- Type: String
credentialsId
- Type: String

$class: 'FogbugzLinkBuilder'

fortifyCloudScan

buildId
- Type: String
useAutoHeap
- Type: boolean
xmx
- Type: String
rmiWorkerMaxHeap
- Type: String
buildLabel
- Type: String
buildProject
- Type: String
buildVersion
- Type: String
useSsc
- Type: boolean
sscToken
- Type: String
upToken
- Type: String
versionId
- Type: String
scanArgs
- Type: String
filter
- Type: String
noDefaultRules
- Type: boolean
disableSourceRendering
- Type: boolean
disableSnippets
- Type: boolean
quick
- Type: boolean
rules
- Type: String
useParallelAnalysis
- Type: boolean

frugalTesting

userId
- Type: String
testId
- Type: String
runTag
- Type: String
getJtl
- Type: boolean
serverUrl (optional)
- Type: String

$class: 'FtpRenameBuilder'

ftpServer
- Type: String
ftpPort

if you don't specify the port, the default port is 21.
- Type: int
ftpUser
- Type: String
ftpPassword
ftpPath

Specify the path to your artifact.
- Type: String
artifactName (optional)
- Type: String
newArtifactName (optional)
- Type: 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.
- Type: String

$class: 'FxCopBuilder'

toolName
- Type: 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 ]
- Type: String
outputXML

FxCop project or XML report output file.

Command Line Argument: /out:[ output file path ]
- Type: String
ruleSet

Rule set to be used for the analysis.

Command Line Argument: /ruleset:=[ Rule set file path ]
- Type: String
ignoreGeneratedCode

Suppress analysis results against generated code.

Command Line Argument: /ignoregeneratedcode
- Type: boolean
forceOutput

Write output XML and project files even in the case where no violations occurred.

Command Line Argument: /forceoutput
- Type: boolean
cmdLineArgs
- Type: String
failBuild
- Type: boolean

$class: 'GCloudSDKBuilder'

command
- Type: String

$class: 'GCloudSDKWithAuthBuilder'

credentialsId
- Type: String
command
- Type: String

$class: 'GatekeeperCommit'

commitUsername
User name in format: "Foo Bar ". Required.
- Type: String

$class: 'GatekeeperMerge'

commitUsername
User name in format: "Foo Bar ". Required.
- Type: String
releaseFilePath
Relative (inside of the repository) path to the release file would be added/replaced and committed if target release branch does not exist. Optional.
- Type: String
releaseFileContentTemplate
Mustache template to be rendered and put to release file. Optional. Available context:
- release - the number of release
UTF-8 encoding is expected.
- Type: String

$class: 'GatekeeperPush'

genexusb

gxInstallationId
GeneXus installation to use for building.
- Type: String
kbPath
Path to the Knowledge Base to build (eg: "${WORKSPACE}\KBname" or "C:\MyCustomPath\MyKb").
- Type: String
kbVersion
Name of the Version to build. If you leave it blank the 'Trunk' version will be selected by default.
- Type: String
kbEnvironment
Name of the Environment to build. If you leave it blank the first Environment will be selected by default.
- Type: String
forceRebuild
By default GeneXus specify and generate only the objects that were affected by changes since the last build. An object may be affected because it was directly modified or because any other object on which it depends was changed. Set this option if for any reason you want to force the build for all objects.
- Type: boolean

$class: 'GenerateChangeScriptBuilder'

Generate an alter SQL script based on a previous schema compare build step.

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:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- Type: String
out
Path to the file that should be used to store SQL change script.

File location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}file or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}file.
- Type: String

$class: 'GenerateCreateScriptBuilder'

Generate a create SQL script from your repository, saved snapshot or database.

outputFile
Path to the file that should be used to store create SQL script.

File location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}file or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}file.
- Type: String
inputFileOrFolder
Specify input folder/file for generating create SQL script. It should depend on input type you have selected.
- Database - input is exported connection file
- File System Synchronization - input is folder mapped through Toad Edge file system synchronization
- Snapshot - input is snapshot file
Folder/file location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- Type: 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:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- Type: String

$class: 'GenerateStandaloneReportBuilder'

Generate a HTML report based on a previous schema compare build step.

inputFolder
Specify path to input folder containing output from "Run Compare" build step.

Folder location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- Type: String
outputFolder
Specify path to folder where standalone report will be exported.

Folder location must be specified as:
- Absolute path to location on your Jenkins master node
- Relative path to your project's workspace. Either starting with ${WORKSPACE} prefix. i.e. ${WORKSPACE}dir or without prefix i.e. dir.
- Relative path to your job's run root directory. It must start with ${JOB_ROOT_DIR} prefix. i.e. ${JOB_ROOT_DIR}dir.
- Type: String

gitAutomerger

releaseBranchPattern
- Type: String
mergeRules
- path
  - Type: String
- resolution
  - Values: KEEP_OLDER, KEEP_NEWER, MERGE_OLDER_TOP, MERGE_NEWER_TOP
logLevel
- Values: TRACE, DEBUG, INFO, WARN, ERROR
remoteName
- Type: String
checkoutFromRemote
- Type: boolean

gitbisect

jobToRun
- Type: String
goodStartCommit
- Type: String
badEndCommit
- Type: String
searchIdentifier
- Type: String
revisionParameterName
- Type: String
retryCount
- Type: int
continuesBuild
- Type: boolean
minSuccessfulIterations
- Type: int
overrideGitCommand
- Type: boolean
gitCommand
- Type: String

gitHubPRStatus

statusMessage
- content
  Message content that will be posted. Support core variable expansion i.e. ${WORKSPACE}.
  If token-macro plugin enabled, then support token expansion.
  If email-ext plugin enabled, then support expanding groovy templates with ${SCRIPT, path="template.groovy"}.
  - Type: String

$class: 'GitHubSetCommitStatusBuilder'

contextSource (optional)
- $class: 'DefaultCommitContextSource'
- $class: 'ManuallyEnteredCommitContextSource'
statusMessage (optional)
- content
  Message content that will be expanded using core variable expansion i.e. ${WORKSPACE}
  and Token Macro Plugin tokens.
  - Type: 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
- Type: String
switches
- Type: String
fileNames
- Type: String
modeSwitches
- Type: String

gprbuild

This build step can be used to build GNAT project files by invoking GPRbuild.

installationName (optional)
Name of the GNAT installation to use as configured in Jenkins.
- Type: String
names (optional)
Main source files represent the sources to be used as the main programs. If they are not specified on the command line, GPRbuild uses the source files specified with the Main attribute in the project file. If none exists, then no executable will be built. It is also possible to specify absolute file names, or file names relative to the current directory.
- Type: String
proj (optional)
GPRbuild requires a project file, which may be specified on the command line either directly or through the -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.
- Type: String
switches (optional)

GPRbuild takes into account switches that may be specified on the command line or in attributes Switches(<main or language>) or Default_Switches (<language>) in package Builder of the main project.

Go to AdaCore documentation for switches.
- Type: String

gradle

buildFile (optional)
If your gradle build script is not named build.gradle, specify the gradle build name script.
- Type: String
gradleName (optional)
- Type: String
makeExecutable (optional)
- Type: boolean
passAllAsProjectProperties (optional)
- Type: boolean
passAllAsSystemProperties (optional)
- Type: boolean
projectProperties (optional)
- Type: String
rootBuildScriptDir (optional)
If your workspace has the top-level build.gradle in somewhere other than the module root directory, specify the path (relative to the module root) here, such as ${workspace}/parent/ instead of just ${workspace}. If left empty, defaults to build.gradle
- Type: String
switches (optional)
Specify a list of Gradle switches to be invoked, or leave it empty.
- Type: String
systemProperties (optional)
- Type: String
tasks (optional)
Specify a list of Gradle tasks to be invoked.
- Type: 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.
- Type: boolean
useWrapper (optional)
- Type: boolean
wrapperLocation (optional)
By default, the Gradle plugin tries to locate the wrapper executable (gradlew on Unix and gradlew.exe on Windows) next to the build script. If it is not there it will look in the workspace root. If your workspace has the wrapper somewhere else, specify the path to the directory (relative to workspace) containing the wrapper executable here, such as parent instead of just ${workspace}/parent.
- Type: String

$class: 'Groovy'

Executes a groovy script.

scriptSource
- $class: 'FileScriptSource'
- $class: 'StringScriptSource'
groovyName
Groovy installation which will execute the script. Specify the name of the Groovy installation as specified in the Global Jenkins configuration.
- Type: String
parameters
Parameters for the Groovy executable.
- Type: String
scriptParameters
These parameters will be passed to the script.
- Type: String
properties
Instead of passing properties using the -D parameter you can define them here.
- Type: 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.
- Type: String
classPath
Specify script classpath here. Each line is one class path item.
- Type: String

$class: 'GroovyRemoteBuilder'

remoteName
- Type: String
script
- Type: String

$class: 'GsshCommandBuilder'

disable
- Type: boolean
serverInfo
- Type: String
shell
- Type: String

$class: 'GsshFtpDownloadBuilder'

disable
- Type: boolean
serverInfo
- Type: String
remoteFile
- Type: String
localFolder
- Type: String
fileName
- Type: String

$class: 'GsshFtpUploadBuilder'

disable
- Type: boolean
serverInfo
- Type: String
localFilePath
- Type: String
remoteLocation
- Type: String
fileName
- Type: String

$class: 'GsshShellBuilder'

disable
- Type: boolean
serverInfo
- Type: String
shell
- Type: String

$class: 'HOTPlayer'

The Heat Orchestration Template (HOT) player allows to play HOT file to OpenStack.
The HOT player load the HOT file choose in the selectbox and generate dynamically the inputs.
If the Associate Env File is configured than the selectbox permits to choose one file env file. By default when you choose a HOT file, the selectbox Associate Env File tries to select the same env file name if it exits or the default env file.
The inputs are divided in 3 categories :

Properties
- Stack name : corresponding to the the name used in OpenStack
- Delete stack if already exists ? : if you want reuse the same name for a stack, the plugin destroys the stack if already exits.
- Debug mode ? : if it's checked than the console print all the differents values parameters
Tags
- Add tags: This category is for adding tags to the stacks. Input should be a string, multiple tags can be added separated by ","
Parameters
- This category is generated dynamically from the differents parameters present in the HOT.
Outputs
- This category is generated dynamically from the differents outputs present in the HOT.

You can use variable environment in each input. The variable must be start with "$" without "-".

project
- Type: String
bundle

habitat

task (optional)
- Type: String
directory (optional)
- Type: String
artifact (optional)
- Type: String
channel (optional)
- Type: String
origin (optional)
- Type: String
bldrUrl (optional)
- Type: String
authToken (optional)
- Type: String
lastBuildFile (optional)
- Type: String
format (optional)
- Type: String
searchString (optional)
- Type: String
command (optional)
- Type: String
binary (optional)
- Type: String
path (optional)
- Type: String
docker (optional)
- Type: boolean

healthAnalyzer

products
Choose the products that you would like to test that correspond to the relevant build step.
- $class: 'HealthAnalyzerLrStep'

$class: 'HttpRequest'

url
- Type: String
acceptType (optional)
- Values: NOT_SET, TEXT_HTML, TEXT_PLAIN, APPLICATION_FORM, APPLICATION_JSON, APPLICATION_JSON_UTF8, APPLICATION_TAR, APPLICATION_ZIP, APPLICATION_OCTETSTREAM
authentication (optional)
- Type: String
consoleLogResponseBody (optional)
- Type: boolean
contentType (optional)
- Values: NOT_SET, TEXT_HTML, TEXT_PLAIN, APPLICATION_FORM, APPLICATION_JSON, APPLICATION_JSON_UTF8, APPLICATION_TAR, APPLICATION_ZIP, APPLICATION_OCTETSTREAM
customHeaders (optional)
- name
  - Type: String
- value
  - Type: String
- maskValue
  - Type: boolean
httpMode (optional)
- Values: GET, HEAD, POST, PUT, DELETE, OPTIONS, PATCH
httpProxy (optional)
- Type: String
ignoreSslErrors (optional)
- Type: boolean
multipartName (optional)
- Type: String
outputFile (optional)
- Type: String
passBuildParameters (optional)
- Type: boolean
quiet (optional)
- Type: boolean
requestBody (optional)
- Type: String
timeout (optional)
- Type: int
uploadFile (optional)
- Type: String
useSystemProperties (optional)
- Type: boolean
validResponseCodes (optional)
- Type: String
validResponseContent (optional)
- Type: String

hugo

baseUrl (optional)
- Type: String
buildFuture (optional)
- Type: boolean
destination (optional)
- Type: String
environment (optional)
- Type: String
hugoHome (optional)
- Type: String
verbose (optional)
- Type: boolean

$class: 'HyperBuilder'

image
- Type: String
commands
- Type: 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)
- Type: 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.
- Type: 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
- Type: 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
- Type: 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.
- Type: 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.
- Type: 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.
- Type: 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.
- Type: String

$class: 'ImportFiles'

Imports one or more XML files into the CloudTest server.

url
- Type: String
cloudTestServerID
Select the server to import objects into.
- Type: String
files
Can use wildcards like 'clips/**/*.xml'. See the @includes of Ant fileset for the exact format. The base directory is the workspace.
- Type: String
excludes
Optionally specify the 'excludes' pattern, such as "foo/bar/**/*". A file that matches this mask will not be imported even if it matches the mask specified in 'File(s) to import' section.
- Type: String
mode
Specify how to handle importing an object that already exists.
- Type: String
additionalOptions
If you need to pass any other command line options to the SCommand utility, specify them here. You can separate options with new lines as well as whitespaces.
- Type: String

importPackages

Imports ECU-TEST packages and their attributes from a test management system like RQM or ALM.

importConfigs (optional)
- $class: 'ExportPackageAttributeConfig'
- $class: 'ExportPackageConfig'
- $class: 'ExportProjectAttributeConfig'
- $class: 'ExportProjectConfig'
- $class: 'ImportPackageAttributeConfig'
- $class: 'ImportPackageConfig'
- $class: 'ImportPackageDirConfig'
- $class: 'ImportProjectArchiveConfig'
- $class: 'ImportProjectAttributeConfig'
- $class: 'ImportProjectConfig'
- $class: 'ImportProjectDirConfig'

importProjects

Imports ECU-TEST projects and their attributes from an archive or a test management system like RQM or ALM.

importConfigs (optional)
- $class: 'ExportPackageAttributeConfig'
- $class: 'ExportPackageConfig'
- $class: 'ExportProjectAttributeConfig'
- $class: 'ExportProjectConfig'
- $class: 'ImportPackageAttributeConfig'
- $class: 'ImportPackageConfig'
- $class: 'ImportPackageDirConfig'
- $class: 'ImportProjectArchiveConfig'
- $class: 'ImportProjectAttributeConfig'
- $class: 'ImportProjectConfig'
- $class: 'ImportProjectDirConfig'

$class: 'InfluxDBPublisher'

userCredentialsID
- Type: String
dbUrl
- Type: String
dbName
- Type: String
content
- Type: String

influxDbQuery

checkName
Logical name for the check.
- Type: String
influxQuery
InfluxDB select query supposed to return 1 value. It can be a sum, count or function returning only one value. May use Jenkins tokens such as build number in the query. e.g.
- Type: String
expectedThreshold
Threshold for the value returned by query result. If exceeded and if Mark Build Unstable is selected, the build will be marked unstable.
- Type: double
markUnstable (optional)
Check if we should mark the build unstable if the threshold is exceeded.
- Type: boolean
retryCount (optional)
Max number of times to execute the query as a single post-build step.
- Type: int
retryInterval (optional)
Time to wait in between each query in seconds, default to 30s.
- Type: int
showResults (optional)
Check if we should should display the query results in the Jenkins console.
- Type: boolean

insightAppSec

region
The data storage region of the target InsightAppSec instance.
- Type: String
insightCredentialsId
- Type: String
appId
The App containing the Scan Config you wish to scan.
- Type: String
scanConfigId
The Scan Config you wish to scan.
- Type: String
buildAdvanceIndicator
This configuration option can be used to augment how the build advances based on the status of the scan submitted
- Scan has been submitted - Advance the build when the scan has been submitted successfully
- Scan has been started - Advance the build when the scan has been started successfully
- Scan has been completed - Advance the build when the scan has been completed successfully
- Vulnerability results query has returned no vulnerabilities - Advance the build when the scan has been completed and the vulnerability search query has returned no vulnerabilities
- Type: String
vulnerabilityQuery
- An InsightAppSec search query may be supplied to search vulnerabilities found by the scan.
- For example, if you wish to fail the build when high severity vulnerabilities have been found, use:
```
                       vulnerability.severity='HIGH'
            
```
- The query supplied will automatically be scoped to the scan
- For more information on vulnerability search queries, consult the InsightAppSec API search documentation here:
  https://help.rapid7.com/insightappsec/en-us/api/v1/docs.html#tag/Search
- If left blank, the build will fail when any vulnerabilities have been found in the scan
- Type: String
maxScanPendingDuration
A max scan pending duration may be provided so that the length of time the CI process takes to provide feedback can be controlled.
- This option is ignored if 'Scan has been submitted' has been selected as the build advance indicator
- The duration will take affect when the scan has been submitted
- Upon reaching the duration, the scan will be cancelled and the build will fail
The following format must be used for defining a duration:
```
       0d 5h 30m
    
```
- (d) - Days
- (h) - Hours
- (m) - Minutes
A quantity must be supplied for each of the above. e.g.
- 1 day: 1d 0h 0m
- 5 hours: 0d 5h 0m
- 3 hours, 30 minutes: 0d 3h 30m
- Type: String
maxScanExecutionDuration
A max scan execution duration may be provided so that the length of time the CI process takes to provide feedback can be controlled.
- This option is ignored if 'Scan has been submitted' has been selected as the build advance indicator
- This option is ignored if 'Scan has been started' has been selected as the build advance indicator
- The duration will take affect when the scan moves into scanning state
- Upon reaching the duration, the in-progress scan will be stopped and the build will advance as normal
The following format must be used for defining a duration:
```
       0d 5h 30m
    
```
- (d) - Days
- (h) - Hours
- (m) - Minutes
A quantity must be supplied for each of the above. e.g.
- 1 day: 1d 0h 0m
- 5 hours: 0d 5h 0m
- 3 hours, 30 minutes: 0d 3h 30m
- Type: String
enableScanResults

Flag to indicate if scan results should be viewable when a build has finished.

When enabled, a new action will be provided to view scan results, labeled 'InsightAppSec Scan Results'.

Note: All users with access to view the build job history will be able to view InsightAppSec scan results
- Type: boolean

$class: 'InstallBuilder'

apkFile
- Type: String
uninstallFirst
- Type: boolean
failOnInstallFailure
- Type: boolean

$class: 'IqPolicyEvaluatorBuildStep'

iqStage
Controls the stage the policy evaluation will be run against on the Nexus IQ Server.
- Type: String
iqApplication
- manualApplication
- selectedApplication
iqScanPatterns
A list of Ant-style patterns relative to the workspace root that denote the files/archives to be scanned, e.g. **/target/*.war or **/target/*.ear. If unspecified, the scan will default to the patterns **/*.jar, **/*.war, **/*.ear, **/*.zip, **/*.tar.gz.
- scanPattern
  - Type: String
iqModuleExcludes
A comma-separated list of Ant-style patterns relative to the workspace root that denote the module information files ( **/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
  - Type: String
failBuildOnNetworkError
Controls the build outcome if there is a failure in communicating with the Nexus IQ Server (e.g. network outage). If checked, the build will be marked as failed. Otherwise, the build is only marked as unstable.
- Type: boolean
jobCredentialsId
To use the IQ server credentials configured in Nexus global configuration for this job select - none -, otherwise select different credentials.
- Type: String
advancedProperties
Provide advanced properties to the IQ Server in <key>=<value> pairs, with each additional property appearing on a new line. eg:
key1=value1 key2=value2
- Type: String

$class: 'IspwRestApiRequest'

connectionId (optional)
- Type: String
consoleLogResponseBody (optional)
- Type: boolean
credentialsId (optional)
- Type: String
ispwAction (optional)
- Type: String
ispwRequestBody (optional)
- Type: String
skipWaitingForSet (optional)
- Type: boolean

$class: 'IssueFieldUpdateStep'

JiraIssueFieldUpdater can be used to update custom JIRA issue field.

issueSelector (optional)
- $class: 'DefaultIssueSelector'
- $class: 'ExplicitIssueSelector'
- $class: 'JqlIssueSelector'
- $class: 'P4JobIssueSelector'
fieldId (optional)
- Type: String
fieldValue (optional)
- Type: String

$class: 'IssueUpdatesBuilder'

restAPIUrl
- Type: String
userName
- Type: String
password
- Type: String
jql
Similar to:
'project="A project key as in Jira" and status="The name of the status as in Jira"'
or
'project="A project key as in Jira" and status="The name of the status as in Jira" and fixVersion="A fix version as in Jira"'
- Type: String
workflowActionName
The name of a workflow action to be executed, depending on your Jira/ Greenhopper workflow configuration. Examples:
In Testing
In Review
On Hold
Resolve Issue
Stop Progress
- Type: String
comment
- Type: String
customFieldId
The key of the custom field. Example:
customfield_10862
- Type: String
customFieldValue
The value to be set to custom field. Build variables and environment variables in format $SOMEVAR are supported. Examples:
ver $VERSION_NUMBER
- Type: String
resettingFixedVersions
If is checked, the existing fixed versions of the issues will be removed before the specified fixed versions be added (overwritten); otherwise the fixed versions will be added to the issues.
With this option checked, and "Fixed versions to be added" left empty will effectively remove all existing fixed versions of the issues.
- Type: boolean
createNonExistingFixedVersions
If is checked, the given fix versions will be created in the Projects before trying to add them to the Issues otherwise only existing fix versions will be added to the issues.
With this option checked, and "Fixed versions to be added" left empty will effectively remove all existing fixed versions of the issues.
- Type: boolean
fixedVersions
The human readable names (not ID) of the versions delimited by comma. Build variables and environment variables in format $SOMEVAR are supported. Examples:
Kanban Board, RC, v$VERSION_NUMBER
The versions are project specific, only the versions that are applicable to the issues are added, others are ignored, for details please consult Jenkins log.
- Type: String
failIfJqlFails
- Type: boolean
failIfNoIssuesReturned
- Type: boolean
failIfNoJiraConnection
- Type: boolean

$class: 'JBossBuilder'

operation
- value
  - Values: START_AND_WAIT, START, SHUTDOWN, CHECK_DEPLOY
- properties
  - Type: String
- stopOnFailure
  - Type: boolean
serverName
- Type: String

$class: 'JIRATicketEditor'

jiraCredentialsID
These jira credentials and project will be used to operate on.
- Type: String
newTicketsTemplates
Allows you to provide templates for new tickets which will be published on JIRA.
- performDuplicateCheck
  When checked, the ticket creation will be skipped if a ticket with equal summary already exists.
  If the the ticket is a sub-ticket, only tickets with the same parent are considered for the suplicate check.
  - Type: boolean
- parentJQL
  If the ticket type is a sub-task, specify here the JQL Query to select this new tickets parent. If the number of tickets matching this query is not exactly one, the build will fail. If the type is not a sub-task, this field is simply ignored.
  - Type: String
- title
  The title (also called summary) of the new ticket.
  - Type: String
- type
  The type of the new ticket, e.g. task or bug.
  - Type: String
- priority
  The priority of the new ticket, e.g. medium.
  - Type: String
- description
  A more detailed description of the issue represented by this ticket.
  - Type: String
- envVarName
  If not empty, the plugin will store the Ticket-Key of the generated Ticket in this variable.
  For example, entering "myissue".
  - Type: String
- fieldValues
  - fieldHumanReadableName
    The name of the field to be set. The field must have either the type string, number, or version. For versions, the name of the version to set must be given as value.
    - Type: String
  - valueToSet
    The value which will be assigned to the given field.
    - Type: String
modifyTicketsTemplates
Allows you to specify JQL filters along with modifications. The modifications will be applied on all Tickets matching the filter.
- jqlFilter
  The plugin will use this JQL-Query to select the tickets to modify from JIRA, see the documentation there on how to write such queries.
  - Type: String
- commitRegEx
  To make use of this option, the build must be triggered by the Github Pull Request builder plugin.
  When the build is then triggered for a certain pull request, the commit messages of all commits associated with this pull request are extracted and
  matched against the regular expression given in this field. All matches in every commit are then used as ticket keys to select the tickets to modify.
  To specify, what part of the regular expression is the actual ticket key, use a named capturing group with the name "key".
  For example, the regular expression "\[(?&ltkey>.*?)\]" will extract the contents specified in square brackets as Ticket keys.
  - Type: String
- ticketSource
  - Type: String
- modifications
  - $class: 'AddCommentModification'
  - $class: 'ModifyArrayFieldModification'
  - $class: 'PerformTransitionModification'
  - $class: 'SetFieldModification'

$class: 'JIRAVersionEditor'

jiraCredentialsID
These jira credentials and project will be used to operate on.
- Type: String
versionModifiactions
- versionName
  - Type: String
- replaceDescription
  - Type: boolean
- descriptionText
  - Type: String
- releaseState
  - Type: String
- failOnJQL
  - Type: boolean
- failQuery
  - Type: 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
- Type: 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
- Type: String
logfile

The file to output to in a Checkstyle XML format

Example: target/jslint.xml
- Type: 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' ] };
- Type: String

$class: 'JabberBuilder'

builderName
- Type: String

$class: 'JbpmUrlResourceBuilder'

url
- Type: String
processId
- Type: String

SoapUIPro

pathToTestrunner
- Type: String
pathToProjectFile
- Type: String
environment (optional)
- Type: String
projectPassword (optional)
- Type: String
testCase (optional)
- Type: String
testSuite (optional)
- Type: String

$class: 'JigomergeBuilder'

source
- Type: String
username
- Type: String
password
- Type: String
oneByOne
- Type: boolean
eager
- Type: boolean
validationScript
- Type: String
dryRun
- Type: boolean
verbose
- Type: boolean
ignoreMergePatterns
- Type: String
commitCommentPrefix
- Type: String

$class: 'JiraEnvironmentVariableBuilder'

Extracts JIRA information for the build to environment variables.

Available variables:

JIRA_ISSUES - A comma separated list of issues which are referenced in the version control system changelog
JIRA_URL - Primary URL for the JIRA server

Typical usage:

Add this build step
Use the "Progress JIRA issues by workflow action" or "Move issues matching JQL to the specified version" with JQL like:
```
issue in (${JIRA_ISSUES})
```

issueSelector
- $class: 'DefaultIssueSelector'
- $class: 'ExplicitIssueSelector'
- $class: 'JqlIssueSelector'
- $class: 'P4JobIssueSelector'

$class: 'JiraExtBuildStep'

issueStrategy
How to find the JIRA issues to update.
- $class: 'FirstWordOfCommitStrategy'
- $class: 'FirstWordOfUpstreamCommitStrategy'
- $class: 'MentionedInCommitStrategy'
- $class: 'SingleTicketStrategy'
extensions
- $class: 'AddComment'
- $class: 'AddFixVersion'
- $class: 'AddLabel'
- $class: 'AddLabelToField'
- $class: 'Transition'
- $class: 'UpdateField'

$class: 'JiraIssueUpdateBuilder'

Performs a JIRA workflow action for every issue that matches the JQL query. A common use might be to consider a ticket "confirmed" in the last build step of a job, or to mark an issue as "merged" if the job is used to merge changes from one SCM repository to another.

Optionally, include a comment that will be attached to those tickets that are modified as a result of this build step.

jqlSearch
Issues which match this JQL Query will be progressed using the specified workflow action.
This can contain $PARAM values which will be replaced by the build parameters.
Example:
```
project = JENKINS and fixVersion = "$RELEASE_VERSION" and status not in (Resolved, Closed)
```
or (e.g., combined with a JIRA Issue Parameter, selecting one issue from a JQL result set):
```
issue = $ISSUE_ID
```
- Type: String
workflowActionName
The workflow action to be performed on the selected JIRA issues.
Be mindful of the issues being selected by the JQL query, because not all actions are valid for all issue statuses.
NOTE: the Jenkins user must have access to perform the workflow step, as if the user were logged in and viewing the issue in a web browser.
- Type: String
comment
An optional comment to be added to the issue after updating the workflow. If left empty, no comment will be added.
This can contain $PARAM values which will be replaced by the build parameters.
- Type: String

$class: 'JiraReleaseVersionUpdaterBuilder'

jiraProjectKey

Specify the project key. A project key is the all capitals part before the issue number in JIRA.

(EXAMPLE-100)
- Type: String
jiraRelease
Specify the name of the parameter which will contain the release version. This can reference a build parameter.
- Type: String
jiraDescription
Optional
Specify a description of the release version. This can reference a build parameter.
- Type: String

$class: 'JiraVersionCreatorBuilder'

jiraVersion
Specify the name of the parameter which will contain the release version. This can reference a build parameter.
- Type: String
jiraProjectKey

Specify the project key. A project key is the all capitals part before the issue number in JIRA.

(EXAMPLE-100)
- Type: String

$class: 'JobConfigRebrander'

$class: 'JobDeleteBuilder'

target
Regular expression of the job to be deleted. Variable will be expanded.
- Type: String

$class: 'JobStrongAuthSimpleBuilder'

jobUsers
Set the users who approve the execution of a job.
- Type: String
useGlobalUsers
If checked, append global setting of `Users`.
- Type: boolean
jobMinAuthUserNum
Minimum number of User who approve, which continue the execution of a job.
- Type: int
useJobExpireTime
If checked, check the period which user approved in expire time from build started.
- Type: boolean
jobExpireTimeInHours
The period which treats the time of which as effective recognition from a start time.
It will not treat, if it is recognized when the time more than the expire time.
- Type: int

$class: 'JobcopyBuilder'

fromJobName
The name of the job used as the copy source. Variables will be expaneded.
- Type: String
toJobName
The name of the job that will be created or overwritten. Variables will be expanded.
- Type: String
overwrite
Whether to overwrite the job if it already exists.
- Type: boolean
jobcopyOperationList
Additional operations to copy a project.
- $class: 'DisableOperation'
- $class: 'EnableOperation'
- $class: 'ReplaceOperation'
additionalFilesetList
You can copy files additional to job main configuration file (config.xml). This is useful for the case some job configurations are stored in another files (e.g. Promoted Builds Plugin). Copy operations can be also applied, but operations are designed for main configuration files, so may not work correctly for other files.
- includeFile
  Specify files to copy. Multiple files can be specified with separating with comma(,). Wildcard is available like '**/*.xml'. See includes attribute of Ant FileSet Type for the exact format. The base directory is the job directory (${JENKINS_HOME}/jobs/JOBNAME).
  - Type: String
- excludeFile
  Specify files not to copy (even specified in Files field).
  - Type: String
- overwrite
  overwrite or skip the file if it already exists.
  - Type: boolean
- jobcopyOperationList
  - $class: 'DisableOperation'
  - $class: 'EnableOperation'
  - $class: 'ReplaceOperation'

Guided Tour

Tutorials

Resources

Recent Tutorial Blog Posts

Pipeline: Basic Steps

catchError: Catch error and set build result to failure

deleteDir: Recursively delete the current directory from the workspace

dir: Change current directory

echo: Print Message

error: Error signal

fileExists: Verify if file exists in workspace

isUnix: Checks if running on a Unix-like node

mail: Mail

pwd: Determine current directory

readFile: Read file from workspace

retry: Retry the body up to N times

sleep: Sleep

stash: Stash some files to be used later in the build

step: General Build Step

Warning:

Warning:

Naming

Patterns

Re-using existing expansion files

Generate your Application Token From Beagle

Home -> Applications -> Select your Application -> Settings -> Application Token

Generate your User Token From Beagle User Settings

Settings -> Access Token -> Generate Your New Personal Access Token

Warning:

Warning:

Test ID

Automatch URL

Tag

Project

Generate your Application Token From Beagle

Home -> Applications -> Select your Application -> Settings -> Application Token

Generate your User Token From Beagle User Settings

Settings -> Access Token -> Generate Your New Personal Access Token

Warning:

Warning:

Test ID

Automatch URL

Tag

Project

Generate your Application Token From Beagle

Home -> Applications -> Select your Application -> Settings -> Application Token

Generate your User Token From Beagle User Settings

Settings -> Access Token -> Generate Your New Personal Access Token

Pattern Syntax

`catchError`: Catch error and set build result to failure

`deleteDir`: Recursively delete the current directory from the workspace

`dir`: Change current directory

`echo`: Print Message

`error`: Error signal

`fileExists`: Verify if file exists in workspace

`isUnix`: Checks if running on a Unix-like node

`mail`: Mail

`pwd`: Determine current directory

`readFile`: Read file from workspace

`retry`: Retry the body up to N times

`sleep`: Sleep

`stash`: Stash some files to be used later in the build

`step`: General Build Step