The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.
For a list of other such plugins, see the Pipeline Steps Reference page.
step([$class: 'BuildStepsFromJsonBuilder']): Build Steps from JsonbuildStep
$class: 'A3Builder'project_file
Stringanalysis_ids
Stringpedantic_level
Stringexport_a3apxworkspace
Stringcopy_report_file
booleancopy_result_file
booleanskip_a3_analysis
boolean$class: 'ACSDeploymentBuilder'context
azureCredentialsId
StringresourceGroupName
StringcontainerService
StringsshCredentialsId
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.
StringconfigFilePaths
The path patterns for the specific cluster (Kubernetes, DC/OS, Docker Swarm) configurations you want to deploy, in the form of Ant glob syntax.
StringcontainerRegistryCredentials (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringdcosDockerCredenditalsPathShared (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.
booleandcosDockerCredentialsPath (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
StringenableConfigSubstitution (optional)
$VARIABLE or ${VARIABLE}) in the configuration with values from Jenkins environment variables.
This allows you to use dynamic values produced during the build in your Kubernetes or DC/OS configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.
booleansecretName (optional)
imagePullSecrets entry. Environment variable substitution are supported for the name input, so you can use available environment variables to construct the name dynamically, e.g., some-secret-$BUILD_NUMBER. The name should be in the pattern [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*, i.e., dot (.) concatenated sequences of hyphen (-) separated alphanumeric words. (See Kubernetes Names)
If left blank, the plugin will generate a name based on the build name.
The secret name will be exposed with the environment variable $KUBERNETES_SECRET_NAME. You can use this in your Kubernetes configuration to reference the updated secret when the "Enable Variable Substitution in Config" option is enabled.
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: nginx
spec:
replicas: 1
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: some.private.registry.domain/nginx
ports:
- containerPort: 80
imagePullSecrets:
- name: $KUBERNETES_SECRET_NAME
Note that once the secret is created, it will only be updated by the plugin. You have to manually delete it when it is not used anymore. If this is a problem, you may use fixed name so every time the job runs, the secret gets updated and no new secret is created.
StringsecretNamespace (optional)
StringswarmRemoveContainersFirst (optional)
booleanqualysAPIStaticAssessmentfreeUserType
booleanplatform (optional)
StringapiServer (optional)
StringcredsId (optional)
StringuseProxy (optional)
booleanproxyServer (optional)
StringproxyPort (optional)
intproxyCredentialsId (optional)
StringswaggerPath (optional)
StringapiId (optional)
StringisFailOnGrade (optional)
booleangrade (optional)
StringisFailOnSecurityGroup (optional)
booleansecurityGroupCount (optional)
StringsecurityCriticality (optional)
StringisFailOnDataGroup (optional)
booleandataGroupCount (optional)
StringdataCriticality (optional)
StringisFailOnViolationGroup (optional)
booleanviolationGroupCount (optional)
StringviolationCriticality (optional)
Stringtoken (optional)
StringcfyAzureArmazureCredentialsId (optional)
The ID of the credentials to use when accessing Azure. Parameters' expansion is supported when using freestyle jobs.
StringcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringdebugOutput (optional)
booleandeploymentId (optional)
StringechoEnvData (optional)
If checked, then the created environment's data will be printed to the job's log.
booleanechoInputs (optional)
booleanenvDataLocation (optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
Stringlocation (optional)
The Azure location where the created resource group should reside in. If omitted, the value of the azure_default_location Cloudify secret will be used.
Stringparameters (optional)
YAML/JSON of parameters to pass to the template.
java.util.Map<java.lang.String, java.lang.Object>parametersAsString (optional)
StringparametersFile (optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
StringresourceGroupName (optional)
Name of resource group to create for the template.
StringtemplateFile (optional)
Workspace-relative path of the ARM template file.
Stringtenant (optional)
String$class: 'AWSEBBuilder'extensions
awsRegion
GovCloud, US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, EU_WEST_1, EU_WEST_2, EU_CENTRAL_1, AP_SOUTH_1, AP_SOUTHEAST_1, AP_SOUTHEAST_2, AP_NORTHEAST_1, AP_NORTHEAST_2, SA_EAST_1, CN_NORTH_1, CN_NORTHWEST_1, CA_CENTRAL_1awsRegionText
StringcredentialsString
StringcredentialsText
StringapplicationName
StringversionLabelFormat
StringversionDescriptionFormat
StringfailOnError
booleanextensions
$class: 'AWSEBElasticBeanstalkSetup'$class: 'AWSEBS3Setup'bucketName
StringbucketRegion
StringkeyPrefix
StringrootObject
Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.
It could be either a path to a zip file or a directory.
If its a directory, includes and excludes are used to build the zip file
Stringincludes
Stringexcludes
StringoverwriteExistingFile
booleanuseTransferAcceleration
boolean$class: 'ByName'envNameList
String$class: 'ByUrl'urlList
StringenvLookup
$class: 'AWSEBElasticBeanstalkSetup'$class: 'AWSEBS3Setup'bucketName
StringbucketRegion
StringkeyPrefix
StringrootObject
Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.
It could be either a path to a zip file or a directory.
If its a directory, includes and excludes are used to build the zip file
Stringincludes
Stringexcludes
StringoverwriteExistingFile
booleanuseTransferAcceleration
boolean$class: 'ByName'envNameList
String$class: 'ByUrl'urlList
String$class: 'AWSEBDeploymentBuilder'config
class br.com.ingenieux.jenkins.plugins.awsebdeployment.AWSEBDeploymentConfigapplicationName (optional)
StringawsRegion (optional)
StringbucketName (optional)
S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
(Optional, will call createStorageLocation if blank)
StringcheckHealth (optional)
booleancredentialId (optional)
StringenvironmentName (optional)
Optional: AWS EB Environment name(s) to deploy to.
Can accept single or multiple comma-separated values. Examples:
When this value is set and each requested environment exists, an UpdateEnvironment call will be triggered as the Application Version is created.
Stringexcludes (optional)
Stringincludes (optional)
StringkeyPrefix (optional)
StringmaxAttempts (optional)
introotObject (optional)
Workspace-relative path of the artifact file to upload (if it's a file), or if it's a directory, the base directory to build the zip/war against
Examples:
target/mywebapp.war: The war file will be uploaded.' or 'target/war': A Zip file will be built and uploaded instead (using includes and excludes). StringskipEnvironmentUpdates (optional)
booleansleepTime (optional)
intversionDescriptionFormat (optional)
StringversionLabelFormat (optional)
StringzeroDowntime (optional)
booleanawsebReleasercredentialId
StringawsRegion
StringapplicationName
StringenvironmentId
StringversionLabel
StringabapCiabapPackagename (optional)
StringatcVariant (optional)
StringsapSystemLabel (optional)
StringrunAtcChecks (optional)
booleanrunUnitTests (optional)
booleantreatWarningAtcChecksAsErrors (optional)
booleanuseJenkinsProjectName (optional)
booleanwithCoverage (optional)
boolean$class: 'ActionHubPlugin'snActivatePlugincredentialsId (optional)
StringapiVersion (optional)
StringpluginId (optional)
Stringurl (optional)
String$class: 'AddComment'prefix
Stringnote
Stringlogfile
String$class: 'AddTestToSetStep'domain
Stringproject
StringtestPlanPath
StringtestSetPath
String$class: 'AmxEclipseAntBuilder'targets
Stringname
Jenkins supplies some environment variables that can be used from within the build script.
StringantOpts
StringbuildFile
Stringproperties
# comment name1=value1 name2=$VAR2These are passed to amx_eclipse_ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as amx_eclipse_ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname= Please refer to TIBCO Documentation for any detail
StringamxEclipseAntTra
StringbusinessStudioWs
Stringanchorename
Stringannotations (optional)
key
Stringvalue
StringautoSubscribeTagUpdates (optional)
booleanbailOnFail (optional)
booleanbailOnPluginFail (optional)
booleanengineCredentialsId (optional)
StringengineRetries (optional)
Stringengineurl (optional)
Stringengineverify (optional)
booleanforceAnalyze (optional)
booleanpolicyBundleId (optional)
String$class: 'AnsibleAdHocCommandBuilder'hostPattern
Stringinventory
$class: 'InventoryContent'content
Stringdynamic
boolean$class: 'InventoryDoNotSpecify'$class: 'InventoryPath'path
Stringmodule
Stringcommand
StringadditionalParameters (optional)
StringansibleName (optional)
StringbecomeUser (optional)
StringcolorizedOutput (optional)
booleancredentialsId (optional)
StringdisableHostKeyChecking (optional)
booleanextraVars (optional)
hidden (optional)
booleankey (optional)
Stringvalue (optional)
Stringforks (optional)
inthostKeyChecking (optional)
booleansudo (optional)
booleansudoUser (optional)
StringunbufferedOutput (optional)
booleanvaultCredentialsId (optional)
StringcfyAnsibleadditionalArgs (optional)
StringansibleEnvVars (optional)
StringcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringdebugLevel (optional)
intdebugOutput (optional)
booleandeploymentId (optional)
StringechoEnvData (optional)
booleanechoInputs (optional)
booleanenvDataLocation (optional)
StringoptionsConfig (optional)
StringplaybookPath (optional)
StringremergeSources (optional)
booleanrunData (optional)
StringsavePlaybook (optional)
booleanscpExtraArgs (optional)
StringsensitiveKeys (optional)
StringsftpExtraArgs (optional)
StringsourcePath (optional)
Stringsources (optional)
StringsshCommonArgs (optional)
StringsshExtraArgs (optional)
StringstartAtTask (optional)
Stringtenant (optional)
Stringtimeout (optional)
int$class: 'AnsiblePlaybookBuilder'playbook
Stringinventory
$class: 'InventoryContent'content
Stringdynamic
boolean$class: 'InventoryDoNotSpecify'$class: 'InventoryPath'path
StringadditionalParameters (optional)
StringansibleName (optional)
StringbecomeUser (optional)
StringcolorizedOutput (optional)
booleancredentialsId (optional)
StringdisableHostKeyChecking (optional)
booleanextraVars (optional)
hidden (optional)
booleankey (optional)
Stringvalue (optional)
Stringforks (optional)
inthostKeyChecking (optional)
booleanlimit (optional)
StringskippedTags (optional)
StringstartAtTask (optional)
Stringsudo (optional)
booleansudoUser (optional)
Stringtags (optional)
StringunbufferedOutput (optional)
booleanvaultCredentialsId (optional)
String$class: 'AnsibleTower'towerServer (optional)
StringjobTemplate (optional)
StringtowerCredentialsId (optional)
StringjobType (optional)
StringextraVars (optional)
StringjobTags (optional)
StringskipJobTags (optional)
Stringlimit (optional)
Stringinventory (optional)
Stringcredential (optional)
StringscmBranch (optional)
Stringverbose (optional)
booleanimportTowerLogs (optional)
StringremoveColor (optional)
booleantemplateType (optional)
StringimportWorkflowChildLogs (optional)
boolean$class: 'AnsibleTowerProjectRevisionFreestyle'towerServer (optional)
StringtowerCredentialsId (optional)
Stringproject (optional)
Stringrevision (optional)
Stringverbose (optional)
booleanthrowExceptionWhenFail (optional)
boolean$class: 'AnsibleTowerProjectSyncFreestyle'towerServer (optional)
StringtowerCredentialsId (optional)
Stringproject (optional)
Stringverbose (optional)
booleanimportTowerLogs (optional)
booleanremoveColor (optional)
boolean$class: 'AnsibleVaultBuilder'action (optional)
StringansibleName (optional)
Stringcontent (optional)
Stringinput (optional)
StringnewVaultCredentialsId (optional)
Stringoutput (optional)
StringvaultCredentialsId (optional)
StringantJenkins supplies some environment variables that can be used from within the build script.
targets
StringantName
StringantOpts
-Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
StringbuildFile
build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
Stringproperties
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
String$class: 'AntExec'scriptSource
StringextendedScriptSource
StringscriptName
Stringproperties
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname=
StringantName
StringantOpts
StringkeepBuildfile
booleanverbose
booleanemacs
booleannoAntcontrib
Disabling usage of Ant-Contrib Tasks in this build step.
booleanantwsJenkins supplies some environment variables that can be used from within the build script.
targets
StringantName
StringantOpts
-Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
StringbuildFile
build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
Stringproperties
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
String$class: 'ApiFortressBuilder'mode
Stringhook
Stringid
Stringblocking
booleandryrun
booleansilent
booleanparam1name
Stringparam1value
Stringparam2name
Stringparam2value
Stringparam3name
Stringparam3value
StringapprayappRayUrl
StringoutputFilePath
StringwaitTimeout
intriskScoreThreshold
intcredentialsId
Stringappscanscanner
dynamic_analyzertarget
StringhasOptions
booleanextraField (optional)
StringloginPassword (optional)
StringloginUser (optional)
Stringoptimization (optional)
StringpresenceId (optional)
StringscanFile (optional)
StringscanType (optional)
StringtestPolicy (optional)
Stringmobile_analyzertarget
StringhasOptions
booleanextraField (optional)
StringloginPassword (optional)
StringloginUser (optional)
StringpresenceId (optional)
Stringstatic_analyzertarget
StringhasOptions
booleanopenSourceOnly (optional)
booleanname
Stringtype
Stringapplication
Stringcredentials
Stringemail (optional)
booleanfailBuild (optional)
booleanfailBuildNonCompliance (optional)
booleanfailureConditions (optional)
failureType
Stringthreshold
inttarget (optional)
Stringwait (optional)
booleanappscanenterprisecredentials
Stringfolder
StringtestPolicy
Stringtemplate
StringjobName
StringaccessId (optional)
Stringagent (optional)
Stringapplication (optional)
Stringemail (optional)
booleanexploreData (optional)
StringfailBuild (optional)
booleanfailureConditions (optional)
failureType
Stringthreshold
intloginType (optional)
StringscanType (optional)
StringsecretKey (optional)
Stringtarget (optional)
StringtestOptimization (optional)
StringtrafficFile (optional)
Stringwait (optional)
boolean$class: 'AppScanSourceBuilder'disableScan
booleanapplicationFile
StringacceptSSL
booleancustomScanWorkspace
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.
Stringinstallation (optional)
String$class: 'AppScanStandardBuilder'startingURL
Spiders will find the remaining URLs in the domain to be included for scanning.
Stringinstallation
StringadditionalCommands (optional)
AppScanCMD exec|ex|e
Parameters:
[ /dest_scan|/dest|/d ]
[ /base_scan|/base|/b ]
[ /old_host|/ohost|/oh ]
[ /new_host|/nhost|/nh ]
[ /scan_template|/stemplate|/st ]
[ /login_file|/lfile|/lf ]
[ /multi_step_file|/mstepfile|/mf ]
[ /manual_explore_file|/mexplorefile|/mef ]
[ /policy_file|/pfile|/pf ]
[ /additional_domains|/adomains|/ad ]
[ /report_file|/rf ]
[ /report_type|/rt {xml} ]
[ /min_severity|/msev {informational} ]
[ /test_type|/tt ]
[ /report_template|/rtemplate|/rtm {CliDefault} ]
Flags:
[ /verbose|/v {false} ]
[ /scan_log|/sl {false} ]
[ /explore_only|/eo {false} ]
[ /test_only|/to {false} ]
[ /multi_step|/mstep|/ms {false} ]
[ /continue|/c {false} ]
[ /merge_manual_explore_requests|/mmer {false} ]
[ /include_responses|/ir {false} ]
[ /open_proxy|/oprxy|/opr /listening_port|/lport|/lp ]
Creates new scan with base_scan's configuration
saving dest_scan and creating report, if configured.
AppScanCMD report|rep|r
Parametrs:
/base_scan|/base|/b
/report_file|/rf
/report_type|/rt
[ /min_severity|/msev {informational} ]
[ /test_type|/tt ]
[ /report_template|/rtemplate|/rtm {CliDefault} ]
Flags:
[ /verbose|/v {false} ]
Creates a report for base_scan.
AppScanCMD close_proxy|cprxy|cpr
Closes AppScan proxy if was previously opened.
More info. at:
(9.0.3.2 User Guide) CLI - Chapter 15 - CLI - Page 315
http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
StringauthScan (optional)
If the website contains private information accessed only by logging in this option should be checked and credentials provided to increase dynamic security coverage.
booleanauthScanPw (optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
StringauthScanRadio (optional)
A login sequence may be recorded using AppScan Standard's GUI by following these steps:
"Scan" > "Scan Configuration" > "Login Management" > "Record" > [ record your login...] > "I am logged in to the site" > "Details" (Tab) > "Export" (small icon on the right side).
Check "Form Based Authentication" if you do not have a recorded login sequence, this option will require an user name and password combination and is not guaranteed to work for all scenarios.
booleanauthScanUser (optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
StringgenerateReport (optional)
The report is available in HTML and PDF.
The HTML report generated is ready to be integrated with the HTML Publisher Plugin.
booleanhtmlReport (optional)
booleanincludeURLS (optional)
Some URLs might not be found by AppScan Standard's spiders, include them to get the best possible coverage.
StringpathRecordedLoginSequence (optional)
StringpdfReport (optional)
booleanpolicyFile (optional)
A Test Policy File can be created following these steps:
"Scan" > "Scan Configuration" > "Test Policy" > "Export".
StringreportName (optional)
To configure HTML Publisher Plugin properly, the names in the configuration must match.
Stringverbose (optional)
booleanxooaname
StringappId
String$class: 'AppUploaderBuilder'buildFilePath
StringapplatixaxUrl
StringaxUsername
StringaxPassword
StringaxServiceTemplateName
StringaxServiceTemplateRepository
StringaxServiceTemplateBranch
StringaxServiceTemplateParameters
key
Stringvalue
StringsnApplyChangescredentialsId (optional)
StringapiVersion (optional)
StringappScope (optional)
application system ID is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
StringappSysId (optional)
application scope is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
StringbranchName (optional)
Stringurl (optional)
String$class: 'ApprendaBuilder'appAlias
StringappName
StringversionAlias
Stringstage
StringartifactName
StringcredentialsId
Stringprefix
StringadvVersionAliasToBeForced
StringadvancedNewVersionOption
StringcustomPackageDirectory
StringapplicationPackageURL
StringarchiveUploadMethod
StringbuildWithParameters
booleanaqualocationType
Stringregistry
Stringregister
booleanlocalImage
StringhostedImage
StringonDisallowed
StringnotCompliesCmd
StringhideBase
booleanshowNegligible
booleanpolicies
StringcustomFlags
StringtarFilePath (optional)
StringcontainerRuntime (optional)
StringscannerPath (optional)
StringaquaMicroscannerimageName
StringonDisallowed
StringnotCompliesCmd
StringoutputFormat
StringaquaServerlessScanneronDisallowed
StringnotCompliesCmd
StringcodeScanPath
StringcustomFlags
StringarachniScannerurl
Stringchecks
Stringscope
pageLimit
intexcludePathPattern
StringuserConfig
filename
Stringformat
String$class: 'ArtifactDeployerBuilder'includes
Can use wildcards like 'module/dist/**/*.zip'. See the @includes of Ant fileset for the exact format.
Artifacts are deployed from the workspace. You can change this basedir by specifying the basedir field under Advanced.
Stringbasedir
By default, the basedir is the job workspace.
Give a value to override the default value.
Path relative to workspace is permitted.
Stringexcludes
Optionally specify the 'excludes' pattern, such as "foo/bar/**/*". A file that matches this mask will not be deployed even if it matches the mask specified.
Stringremote
Artifacts will be deployed in the specified output directory.
The remote location must be accessible through the build machine (master/slave node).
If you want to have the ability to download deployed artifacts through the Jenkins dashboard, the location must be accessible from the Jenkins master.
Make sure the Jenkins process have the right permissions to write to the remote location.
For example with a shared NFS storage, '/nfs/build/deploy/${BUILD_ID}' can be a valid value on an Unix machine.
Stringflatten
Ignore the directory structure of the source files, and deploy all the artifacts into the output directory.
booleandeleteRemote
Delete the output directory before deploying artifacts.
booleandeleteRemoteArtifacts
booleanfailNoFilesDeploy
boolean$class: 'ArtifactPromotionBuilder'groupId
StringartifactId
Stringclassifier
Stringversion
Stringextension
StringstagingRepository
StringstagingUser
StringstagingPW
StringreleaseUser
StringreleasePW
StringreleaseRepository
StringpromoterClass
Stringdebug
booleanskipDeletion
'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.
booleanartifactResolverartifacts
groupId
StringartifactId
Stringversion
Stringclassifier (optional)
StringdeployToLocal (optional)
booleandeployToRemote (optional)
booleanextension (optional)
StringfailOnError (optional)
booleanpomFile (optional)
StringtargetFileName (optional)
StringenableRepositoryLogging (optional)
booleanenableTransferLogging (optional)
booleanrepositoryId (optional)
StringtargetDirectory (optional)
StringassertthatBddFeaturesprojectId
StringcredentialsId
StringoutputFolder
Stringjql
Stringtags
Stringmode
StringproxyURI
StringproxyUsername
StringproxyPassword
StringjiraServerUrl
String$class: 'AssetBuilder'name
Stringdescription
Stringversion
Stringvendor
Stringplatform
Stringarchitecture
Stringbits
Stringcpu
intmemory
intstorage
intinstallationScriptFilePath
StringmediaFilePaths
path
StringlicenseFilePath
StringdocumentationFilePath
String$class: 'AssociateItemToRelease'releasePrefix
StringitemPrefix
StringassociateTagnexusInstanceId
StringtagName
Stringsearch
key
Stringvalue
String$class: 'AstreeBuilder'dax_file
Stringanalysis_id
Stringoutput_dir
Stringskip_analysis
booleangenXMLOverview
booleangenXMLCoverage
booleangenXMLAlarmsByOccurence
booleangenXMLAlarmsByCategory
booleangenXMLAlarmsByFile
booleangenXMLRulechecks
booleandropAnalysis
booleangenPreprocessOutput
booleanfailonswitch
failon
StringauditcredentialsId (optional)
StringminScore (optional)
intplatformUrl (optional)
StringbranchName (optional)
StringlogLevel (optional)
StringrepositoryName (optional)
StringshareEveryone (optional)
String$class: 'AutEnvironmentBuilder'autEnvironmentModel
almServerName
StringalmUserName
StringalmPassword
StringalmDomain
StringalmProject
StringclientType
StringautEnvironmentId
StringuseExistingAutEnvConf
booleanexistingAutEnvConfId
StringcreateNewAutEnvConf
booleannewAutEnvConfName
StringautEnvironmentParameters
name
Stringvalue
StringparamType
StringshouldGetOnlyFirstValueFromJson
booleanpathToJsonFile
StringoutputParameter
String$class: 'AutoConfigBuilder'name
StringdiscobitUrl
StringdiscobitUser
StringdiscobitPassword
class hudson.util.Secretconfigurations
Stringcuuid
String$class: 'Autogen'element
Specify the name of the element in your CA Endevor® sandbox that you want to include in the autogeneration process, for example, RUNCOB01. The maximum length is 8 characters.
You can specify several specific comma-separated elements within the sandbox, for example, RUNCOB01, RUNCOB02.
You can use wildcards % and * to define the name patterns for the element names.
Examples:
Specify * to include all elements from the sandbox in the autonegeration process.
Specify RUNCOB* to include all element names that start with "RUNCOB".
Specify %%%COB* to include elements that contain the substring COB starting after position three.
Stringenvironment
Provide the environment for the CA Endevor® sandbox that you want to include in the autogeneration process, for example, DEV.
Stringsystem
Provide the system name for the environment in your CA Endevor® sandbox that you want to include in the autogeneration process, for example, APCTTC0.
Stringsubsystem
Provide the subsystem name for the environment in your CA Endevor® sandbox that you want to include in the autogeneration process, for example, TESTCICD.
Stringstage
Specify the environment stage in your CA Endevor® that you want to include in the autogeneration process, for example, 1.
Stringinstance
Specify the instance name of the environment that is associated with CA Endevor® Web services, for example, WEBSMFNE.
Stringsignout
Select this option to work with elements in CA Endevor® that might be currently worked on by another user.
Select the Override signout option only if you have the permission to override the signout of another user.
boolean$class: 'AwsBatchBuilder'jobname
Stringjobdefinition
Stringcommand
Stringjobqueue
Stringvcpu
Stringmemory
Stringretries
StringazureCLIprincipalCredentialId
Stringcommands
script
StringexportVariablesString
StringazureDownloadstorageCredentialId
StringdownloadType
StringbuildSelector (optional)
downstreamupstreamProjectName
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
StringupstreamBuildNumber
StringlastWithArtifactslastCompleted$class: 'MultiJobBuildSelector'buildParameterparameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
Stringpermalinkid
String$class: 'PromotedBuildSelector'level
intlatestSavedBuildspecificbuildNumber
StringlastSuccessfulstable (optional)
booleanupstreamallowUpstreamDependencies (optional)
booleanfallbackToLastSuccessful (optional)
booleanupstreamFilterStrategy (optional)
UseGlobalSetting, UseOldest, UseNewestworkspacecontainerName (optional)
StringdeleteFromAzureAfterDownload (optional)
booleandownloadDirLoc (optional)
StringexcludeFilesPattern (optional)
StringfileShare (optional)
StringflattenDirectories (optional)
booleanincludeArchiveZips (optional)
booleanincludeFilesPattern (optional)
StringprojectName (optional)
Stringverbose (optional)
Enabling this will provide more logging on downloading files.
boolean$class: 'BDSBuilder'projectFile
Stringswitches
StringinstallationName
String$class: 'BapFtpBuilder'publishers
configName
Select an FTP configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the FTP server.
Stringverbose
booleantransfers
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.
Stringexcludes
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)
StringremoteDirectory
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.
StringremovePrefix
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.
StringasciiMode
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.
booleanremoteDirectorySDF
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 |
booleanflatten
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.
booleancleanRemote
Select to delete all files and directories within the remote directory before transferring files.
booleannoDefaultExcludes
booleanmakeEmptyDirs
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.
booleanpatternSeparator
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.
StringuseWorkspaceInPromotion
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
booleanusePromotionTimestamp
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.
booleanftpRetry
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
intretryDelay
longftpLabel
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.
StringftpCredentials
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
Stringpassword
StringcontinueOnError
booleanfailOnError
booleanalwaysPublishFromMaster
booleanmasterNodeName
StringparamPublish
parameterName
String$class: 'BapSshBuilderPlugin'publishers
configName
Select an SSH configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the SSH server.
Stringverbose
booleantransfers
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.
Stringexcludes
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)
StringremoteDirectory
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.
StringremovePrefix
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.
StringremoteDirectorySDF
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 |
booleanflatten
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.
booleancleanRemote
booleannoDefaultExcludes
booleanmakeEmptyDirs
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.
booleanpatternSeparator
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.
StringexecCommand (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.
StringexecTimeout (optional)
Timeout in milliseconds for the Exec command.
Set to zero to disable.
intusePty (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.
booleanuseAgentForwarding (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.
booleanuseSftpForExec (optional)
Using SFTP protocol instead of SSH for Exec command.
Supported commands: mkdir, ln, symlink, rm, rmdir, cd, get, ls
booleanuseWorkspaceInPromotion
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.
booleanusePromotionTimestamp
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.
booleansshRetry
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
intretryDelay
longsshLabel
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.
StringsshCredentials
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
StringencryptedPassphrase
Key or Path to key is configured.
Stringkey
The private key.
Paste the private key here, or provide the path to the file containing the key in Path to key.
StringkeyPath
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
StringcontinueOnError
booleanfailOnError
booleanalwaysPublishFromMaster
booleanmasterNodeName
StringparamPublish
parameterName
StringbatchFilecommand
StringconfiguredLocalRules (optional)
retainOnlyVariablesLimit which environment variables are passed to a build step.
Environment variables passed to the build step are filtered, unless listed below.
The behavior of this filter depends on whether the environment variable is originally defined outside Jenkins:
JOB_URL, it will not be passed to the build step unless specified here.PATH, the behavior depends on the option Process environment variables handling: If that option is set to Retain, the original value will be passed to the build step, discarding any modifications inside Jenkins. If that option is set to Remove, the variable will not be passed to the build step. The following table shows the effect of filtering on an environment variable:
| Behavior | Originally defined outside Jenkins | Originally defined inside Jenkins |
|---|---|---|
| Process environment variables handling: reset | Variable is reset to original value | Variable is removed |
| Process environment variables handling: removed | Variable is removed | Variable is removed |
processVariablesHandling (optional)
RESET, REMOVEretainCharacteristicEnvVars (optional)
When checked, characteristic environment variables will be retained in addition to the variables listed above. These environment variables are job- and build-specific, defined by Jenkins, and are used to identify and kill processes started by this build step. See the documentation for more details on starting processes.
booleanvariables (optional)
Whitespace separated, case insensitive list of environment variables that will be retained, i.e. not removed from the environment of this build step or reset to their default.
StringunstableReturn (optional)
intsnBatchInstallcredentialsId (optional)
StringapiVersion (optional)
StringbatchName (optional)
Stringfile (optional)
The field is required if Use file is checked. If the field is not changed default value will be used: now_batch_manifest.json.
Stringnotes (optional)
Default: null
Stringpackages (optional)
[{
"id": "String",
"load_demo_data": Boolean,
"notes": "String",
"requested_customized_version": "String",
"requested_version": "String",
"type": "String"
}]
| id | Required. Sys_id of the application or identifier of the plugin to install. |
|---|---|
| load_demo_data | Flag that indicates whether demo data is loaded when installing the package. Valid values: true: Demo data should be loaded. false: Demo data should not be loaded. Default: false |
| notes | User specified notes about the package. Default: null |
| requested_customized_version | Only applicable when packages.type is set to application. Version of the store application customization package to install, such as 1.0.2 or 2.3. |
| requested_customized_version | Only applicable when packages.type is set to application. Version of the store application customization package to install, such as 1.0.2 or 2.3. Default: None. If this is not set, then the system does not look for customizations for the application. |
| requested_version | Required if type is set to application; ignored if set to plugin. Version of the package to install, such as 1.0.2 or 2.3. |
| type | Required. Type of package. Valid values:
|
Stringurl (optional)
StringuseFile (optional)
Default: false
booleansnBatchRollbackcredentialsId (optional)
StringapiVersion (optional)
StringrollbackId (optional)
sys_id) of the rollback installed before.
Stringurl (optional)
If ServiceNow Parameters are used, then the URL of installation instance will be used.
String$class: 'BeaglePlugin'apptoken
class hudson.util.Secretaccesstoken
class hudson.util.Secret$class: 'BeakerBuilder'jobSource
$class: 'FileJobSource'jobPath
String$class: 'StringJobSource'jobContent
StringdownloadFiles
boolean$class: 'BeginAnalysis'logLevel
OFF, INFO, DEBUG, WARN, ERRORbuildSessionId
StringappName
StringmoduleName
Stringbranch
StringenableMultipleBuildFiles
booleanoverrideJars
booleanmultipleBuildFiles
booleanlabId
StringtestStage
StringpackagesIncluded
StringpackagesExcluded
StringfilesIncluded
StringfilesExcluded
StringclassLoadersExcluded
Stringrecursive
booleanworkspacepath
StringbuildScannerJar
StringtestListenerJar
StringtestListenerConfigFile
StringautoRestoreBuildFile
booleansealightsMavenPluginInstallationArguments
StringbuildFilesPatterns
StringbuildFilesFolders
StringlogEnabled
booleanlogDestination
CONSOLE, FILElogFolder
StringbuildStrategy
ONE_BUILD, BUILD_EACH_MODULEslMvnPluginVersion
StringbuildName
$class: 'DefaultBuildName'$class: 'EmptyBuildName'$class: 'LatestBuildName'$class: 'ManualBuildName'insertedBuildName
String$class: 'UpstreamBuildName'upstreamProjectName
StringexecutionType
FULL, TESTS_ONLY, ONLY_LISTENERoverride_customerId
Stringoverride_url
Stringoverride_proxy
StringadditionalArguments
| Argument name | Description |
|---|---|
| token | The token provided to you by SeaLights (override the global 'token' value for this build). |
| tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
| buildsessionidfile | Set build session id file for this build. |
| createbuildsessionid | When set to 'true' - forces SeaLights Maven Plugin to create new build session id (true by default). |
| proxy | A valid URL to a proxy server. |
| agentpath | Override the path to SeaLights jar. |
| javapath | Override the path to the 'java' variable (default is 'java'). |
| filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
| sealightsJvmParams | Key value pairs of environments variables which will be added to both buildscanner and test listener ('$$$'- separated pairs, ':'- separated key and value. i.e: sealightsJvmParams=param:value$$$anotherparam:anothervalue) |
| buildScannerParams | Key value pairs of environments variables which will be added to buildscanner ('$$$'- separated pairs, ':'- separated key and value. i.e: buildScannerParams=param:value$$$anotherparam:anothervalue) |
| testListenerJvmParams | Key value pairs of environments variables which will be added to test listener ('$$$'- separated pairs, ':'- separated key and value i.e: testListenerJvmParams=param:value$$$anotherparam:anothervalue) |
StringincludeResources
booleanbenchmarkfilepath
String$class: 'BitbucketPublisher'serverUrl (optional)
StringcredentialsId (optional)
StringprojectKey (optional)
StringcreateProject (optional)
projectName
StringprojectUsers
StringprojectGroups
StringcreateJenkinsJobs (optional)
ciServer
StringprojectName (optional)
String$class: 'BladeBuilder'blades
$class: 'CodeScan'source
Stringexclude
StringnoCache
booleannoProxy
booleannoBlame
booleanruleset
StringseverityLevel
StringseverityThreshold
intautoUpdate (optional)
booleancredentialsId (optional)
Stringdebug (optional)
booleandirectory (optional)
Stringenvironment (optional)
StringforceVersion (optional)
StringignoreFailure (optional)
booleanonFailureCmd (optional)
Stringtimeout (optional)
int$class: 'ImageScan'image
Stringexclude
StringnoCache
booleannoProxy
booleannoBlame
booleanruleset
StringseverityLevel
StringseverityThreshold
intautoUpdate (optional)
booleancredentialsId (optional)
Stringdebug (optional)
booleandirectory (optional)
Stringenvironment (optional)
StringforceVersion (optional)
StringignoreFailure (optional)
booleanonFailureCmd (optional)
Stringtimeout (optional)
int$class: 'BlueprintLaunch'projectName
Project selection is mandatory.
StringblueprintName
Blueprint selection is mandatory.
StringapplicationName
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.
StringappProfileName
Application Profile selection is mandatory.
StringactionName
The field is mandatory
Select the required action need to run after the application launch from the list of actions, else please select none.
StringruntimeVariables
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.
StringwaitForSuccessFulLaunch
booleanblueprintDescription
Description is fetched from the selected Calm blueprint
String$class: 'BootPluginBuilder'tasks
StringjvmOpts
String$class: 'BranchDestructionStep'project
Stringbranch
String$class: 'BranchGenerationStep'projectConfig
pipelineConfig
destructor
booleanauthorisations
StringbranchSCMParameter
booleanbranchParameters
StringgenerationExtension
StringpipelineGenerationExtension
StringdisableDslScript
booleanscriptDirectory
StringnamingStrategy
projectFolderPath
StringbranchFolderPath
StringprojectSeedName
StringprojectDestructorName
StringbranchSeedName
StringbranchStartName
StringbranchName
StringignoredBranchPrefixes
StringeventStrategy
delete
booleanauto
booleantrigger
booleancommit
Stringproject
StringscmType
StringscmUrl
StringscmCredentials
StringtriggerIdentifier
StringtriggerType
StringtriggerSecret
StringdotnetBuilddotnet build command builds the project and its dependencies into a set of binaries. The binaries include the project's code in Intermediate Language (IL) files with a .dll extension. Depending on the project type and settings, other files may be included, such as:
configuration (optional)
Debug, but you can override the build configuration settings in your project.
Stringforce (optional)
booleanframework (optional)
StringnoDependencies (optional)
booleannoIncremental (optional)
booleannoRestore (optional)
booleannologo (optional)
booleanoption (optional)
Stringoptions (optional)
StringoptionsString (optional)
StringoutputDirectory (optional)
./bin/<configuration>/<framework>/. For projects with multiple target frameworks (via the TargetFrameworks property), you also need to specify a specific framework when you specify this option.
Stringproject (optional)
Stringproperties (optional)
java.util.Map<java.lang.String, java.lang.String>propertiesString (optional)
Stringruntime (optional)
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleanshutDownBuildServers (optional)
dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
hanguntil those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
booleanspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleantarget (optional)
Stringtargets (optional)
StringtargetsString (optional)
StringunstableIfWarnings (optional)
booleanverbosity (optional)
StringversionSuffix (optional)
$(VersionSuffix) property to use when building the project. This only works if the $(Version) property isn't set. Then, $(Version) is set to the $(VersionPrefix) combined with the $(VersionSuffix), separated by a dash.
StringworkDirectory (optional)
StringbuildAddUrltitle
Stringurl
String$class: 'BuildBuilder'dbFolder
value
vcsroot, subfolder, scaprojectsubfolder
StringprojectPath
Stringpackageid
StringtempServer
value
StringserverName
StringdbName
StringserverAuth
value
Stringusername
Stringpassword
class hudson.util.SecretencryptConnection
booleantrustServerCertificate
booleanoptions
StringdataOptions
StringtransactionIsolationLevel
Serializable, Snapshot, RepeatableRead, ReadCommitted, ReadUncommittedfilter
StringpackageVersion
StringdlmDashboard
dlmDashboardHost
StringdlmDashboardPort
StringsqlChangeAutomationVersionOption
value
Latest, SpecificspecificVersion
StringbuildDescriptiondescriptionTemplate
StringbuildNamenameTemplate
String$class: 'BuildNameUpdater'fromFile
booleanbuildName
StringfromMacro
booleanmacroTemplate
StringmacroFirst
booleancrxBuildpackageId (optional)
StringbaseUrl (optional)
username[:password]@ between the scheme and the hostname.
StringcredentialsId (optional)
/$username/keys/$fingerprint.
Stringdownload (optional)
booleanlocalDirectory (optional)
StringrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
longwspFilter (optional)
/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.
String$class: 'BuildScanner'profile
Stringtarget
StringrepTemp
Stringthreat
StringstopScan
booleansvRep
booleanincScan
booleanincScanId
StringstopTargetScans
boolean$class: 'BuildStepBuilder'sourceFolderMode
Stringsubfolder
StringpackageId
StringserverType
Stringserver
StringauthenticationType
StringuserName
Stringpassword
class hudson.util.Secretdatabase
StringcompareOptions (optional)
StringfilterFile (optional)
StringtransactionIsoLvl (optional)
String$class: 'BuildStepWithTimeout'buildStep
hudson.tasks.BuildStep)strategy
$class: 'AbsoluteTimeOutStrategy' Abort build based on a fixed time-out.
timeoutMinutes
String$class: 'DeadlineTimeOutStrategy' Abort build based on a deadline time specified in HH:MM:SS or HH:MM (24-hour time format).
deadlineTime
StringdeadlineToleranceInMinutes
int$class: 'ElasticTimeOutStrategy' Define time to wait before killing the build as a percentage of the mean of the duration of the last n successful builds.
timeoutPercentage
StringtimeoutMinutesElasticDefault
StringnumberOfBuilds
StringfailSafeTimeoutDuration
boolean$class: 'LikelyStuckTimeOutStrategy'Abort the build when the job has taken many times longer than previous runs.
$class: 'NoActivityTimeOutStrategy'timeoutSecondsString
String$class: 'RunConditionTimeoutStrategy'This extension uses run condition as condition sources.
conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'conditions
condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
Stringtimeout
longdefaultTimeout
longoperationList
$class: 'AbortAndRestartOperation'maxRestarts
String$class: 'AbortOperation'$class: 'BuildStepOperation'buildstep
hudson.tasks.BuildStep)continueEvenFailed
booleancreateLauncher
boolean$class: 'FailOperation'$class: 'WriteDescriptionOperation'description
String$class: 'BuildStepsFromJsonBuilder'$class: 'BuildoutBuilder'pythonName
StringbuildoutCfg
Stringnature
Stringcommand
StringignoreExitCode
booleanbyteguardGreettoken
Stringtask_id
String$class: 'CFLaunchBuilder'cfComposition
StringsetCFVars
vars
Variable
StringValue
String$class: 'CIMessageBuilder'providerData (optional)
activeMQPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanmessageContent (optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
StringmessageProperties (optional)
KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
StringmessageType (optional)
Type of CI message to be sent.
CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatusname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
StringactiveMQSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
Stringselector (optional)
JMS selector to choose messages that will fire the trigger.
Stringtimeout (optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
intvariable (optional)
Environment variable to hold received message content.
StringfedmsgPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanmessageContent (optional)
Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
StringfedmsgSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
Stringtimeout (optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
intvariable (optional)
Environment variable to hold received message content.
StringrabbitMQPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanfedoraMessaging (optional)
booleanmessageContent (optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
Stringschema (optional)
Path to message schema.
Stringseverity (optional)
Severity of the message.
intrabbitMQSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
Stringtimeout (optional)
Value (in minutes) to wait for a message.
intvariable (optional)
Environment variable to hold received message content.
String$class: 'CIMessageSubscriberBuilder'Subscribe to the CI message bus and wait for a message matching the specified JMS selector.
The variable value specifies the name of an environment variable in which to place the received message body.
The timeout value specifies the maximum number of minutes to wait for a message matching the JMS selector to appear.
providerData (optional)
activeMQPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanmessageContent (optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
StringmessageProperties (optional)
KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
StringmessageType (optional)
Type of CI message to be sent.
CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatusname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
StringactiveMQSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
Stringselector (optional)
JMS selector to choose messages that will fire the trigger.
Stringtimeout (optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
intvariable (optional)
Environment variable to hold received message content.
StringfedmsgPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanmessageContent (optional)
Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
StringfedmsgSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
Stringtimeout (optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
intvariable (optional)
Environment variable to hold received message content.
StringrabbitMQPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanfedoraMessaging (optional)
booleanmessageContent (optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
Stringschema (optional)
Path to message schema.
Stringseverity (optional)
Severity of the message.
intrabbitMQSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
Stringtimeout (optional)
Value (in minutes) to wait for a message.
intvariable (optional)
Environment variable to hold received message content.
String$class: 'CRDABuilder'file (optional)
StringcrdaKeyId (optional)
StringcliVersion (optional)
StringconsentTelemetry (optional)
CRDA CLI is constantly improving and we would like to know more about usage. Click here to find more details.
boolean$class: 'CToolBuilder'cmake -P <script file>) or command mode (cmake -E <command>).
installationName
Stringarguments (optional)
StringignoredExitCodes (optional)
StringtoolId (optional)
StringworkingDir (optional)
StringgenerateCachecaches
type
A2L, ELF, BUS, MODEL, SERVICEfilePath
StringdbChannel
Stringclear
boolean$class: 'CallFunction'functionName (optional)
StringargumentList (optional)
Stringargument (optional)
String$class: 'CallOtherJenkinsBuilder'hostName
StringjobName
Stringspan
Stringretry
StringuserName
Stringpassword
Stringparameters
String$class: 'CaptureIOSDeviceScreenshot'url
StringcloudTestServerID
StringadditionalOptions
Stringcarbonetesname
StringcredentialsId (optional)
StringengineTimeout (optional)
intfailBuildOnPluginError (optional)
booleanfailBuildOnPolicyEvaluationFailResult (optional)
booleanimage (optional)
StringpolicyBundleID (optional)
StringregistryURI (optional)
StringcarlinstallationName
StringsourcePath
StringapplicationName
StringarchivePdf (optional)
booleandisplayLog (optional)
booleanlogPath (optional)
StringoutputPath (optional)
StringqualityGate (optional)
StringcastechoinstallationName
StringsourcePath
StringapplicationName
StringdisplayLog (optional)
booleanlogPath (optional)
StringoutputPath (optional)
StringqualityGate (optional)
StringvenafiVcertRequestCertificateconnectorName
StringzoneConfigName
The name of the zone configuration to use.
When using Venafi as a Service, zone names are in the format of app name\api alias
StringcommonName
StringprivKeyOutput
StringcertOutput
StringcertChainOutput
Stringcountry (optional)
StringdnsNames (optional)
hostName
StringemailAddresses (optional)
address
StringexpirationWindow (optional)
intipAddresses (optional)
address
StringkeyType (optional)
RSA, ECDSAlocality (optional)
Stringorganization (optional)
StringorganizationalUnit (optional)
Stringprovince (optional)
StringchangeAsmVerversionPattern
StringassemblyCompany (optional)
StringassemblyCopyright (optional)
StringassemblyCulture (optional)
StringassemblyDescription (optional)
StringassemblyFile (optional)
StringassemblyProduct (optional)
StringassemblyTitle (optional)
StringassemblyTrademark (optional)
StringregexPattern (optional)
StringreplacementPattern (optional)
String$class: 'ChangeEventBuilder'integrationKey
StringsummaryText (optional)
StringchatterPost postToChatter "Build Started - ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"
credentialsId
If you're connecting from outside of your organizations trusted network, you'll also need to append your API security token to your password.
See Identity Confirmation in the salesforce.com online help for more information.
Stringbody
StringbuildUrlTitle (optional)
StringrecordId (optional)
Stringserver (optional)
String$class: 'CheckGate'pipelineId
StringstageName
StringversionId
Stringfatal
String$class: 'CheckGateBuilder'project
Stringgate
String$class: 'ChefBuilderConfiguration'url
Stringsinatraurl
Stringfilter
Stringusername
Stringport
intcommand
Stringprivatekey
Stringparallel
booleanfail
booleanchlAtuoActioncontent
StringbrowserString
StringrunScriptOnly
booleanrootPath
StringlibPath
String$class: 'ChrootBuilder'chrootName
StringignoreExit
booleanadditionalPackages
StringpackagesFile
Stringclear
booleancommand
StringloginAsRoot
booleannoUpdate
booleanforceInstall
boolean$class: 'CifsBuilderPlugin'publishers
configName
Stringverbose
booleantransfers
sourceFiles
Stringexcludes
StringremoteDirectory
StringremovePrefix
StringremoteDirectorySDF
booleanflatten
booleancleanRemote
booleannoDefaultExcludes
booleanmakeEmptyDirs
booleanpatternSeparator
StringuseWorkspaceInPromotion
booleanusePromotionTimestamp
booleanretry
retries
intretryDelay
longlabel
label
StringcontinueOnError
booleanfailOnError
booleanalwaysPublishFromMaster
booleanmasterNodeName
StringparamPublish
parameterName
String$class: 'ClangScanBuildBuilder'target
StringtargetSdk
xcodebuild -showsdks
Stringconfig
StringclangInstallationName
StringxcodeProjectSubPath
Stringworkspace
Stringscheme
Stringscanbuildargs
Stringxcodebuildargs
StringoutputFolderName
StringgoogleStorageUploadcredentialsId
Stringbucket
Stringpattern
StringpathPrefix (optional)
StringsharedPublicly (optional)
booleanshowInline (optional)
booleandotnetCleandotnet clean command cleans the output of the previous build. It's implemented as an MSBuild target, so the project is evaluated when the command is run. Only the outputs created during the build are cleaned. Both intermediate (obj) and final output (bin) folders are cleaned.
configuration (optional)
Debug, but you can override the build configuration settings in your project. This option is only required when cleaning if you specified it during build time.
Stringframework (optional)
Stringnologo (optional)
booleanoption (optional)
Stringoptions (optional)
StringoptionsString (optional)
StringoutputDirectory (optional)
Stringproject (optional)
Stringproperties (optional)
java.util.Map<java.lang.String, java.lang.String>propertiesString (optional)
Stringruntime (optional)
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleanshutDownBuildServers (optional)
dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
hanguntil those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
booleanspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleanunstableIfWarnings (optional)
booleanverbosity (optional)
StringworkDirectory (optional)
StringexamCleanTargetvalidNetworkusername
Stringpassword
StringprojectId
Stringfilepath
String$class: 'ClifBuilder'clifName
StringclifOpts
StringtestPlanFile
StringreportDir
String$class: 'CloudBuildBuilder'input
credentialsId
Stringrequest
filefilename
Stringinlinerequest
Stringsource (optional)
localpath
.tgz or .tar.gz) or zip file (.zip), or .tgz) and uploaded to a temporary Cloud Storage bucket. Stringrepobranch (optional)
Stringcommit (optional)
StringprojectId (optional)
StringrepoName (optional)
Stringtag (optional)
Stringstoragebucket
Stringobject
StringsubstitutionList (optional)
items
key
_) and use only numbers, uppercase letters, and underscores (respecting the regular expression _[A-Z0-9_]+). The key may not be longer than 100 characters. For details, see Build Requests - User-defined substitutions.
Stringvalue
Stringsubstitutions (optional)
java.util.Map<java.lang.String, java.lang.String>pushToCloudFoundrytarget
Stringorganization
StringcloudSpace
StringcredentialsId
StringmanifestChoice (optional)
appName (optional)
StringappPath (optional)
Stringbuildpack (optional)
Stringcommand (optional)
Stringdomain (optional)
StringenvVars (optional)
key
Stringvalue
Stringhostname (optional)
Stringinstances (optional)
StringmanifestFile (optional)
Stringmemory (optional)
StringnoRoute (optional)
StringservicesNames (optional)
name
Stringstack (optional)
Stringtimeout (optional)
Stringvalue (optional)
StringpluginTimeout (optional)
StringselfSigned (optional)
StringservicesToCreate (optional)
name
Stringtype
Stringplan
StringresetService (optional)
booleancloudhubDeployerenvironmentId
StringorgId
StringappName
StringmuleVersion
StringfilePath
StringcredentialsId (optional)
StringrequestMode (optional)
CREATE, UPDATE, CREATE_OR_UPDATE, UPDATE_FILE, RESTART, DELETEregion (optional)
StringautoScalePolicy (optional)
autoScalePolicyName (optional)
StringenableAutoScalePolicy (optional)
booleanid (optional)
StringmaxScale (optional)
intminScale (optional)
intscaleBasedOn (optional)
StringscaleDown (optional)
class org.jenkinsci.plugins.cloudhubdeployer.data.ScalescaleDownNextScaleWaitMins (optional)
intscaleDownPeriodCount (optional)
intscaleDownValue (optional)
intscaleType (optional)
StringscaleUp (optional)
class org.jenkinsci.plugins.cloudhubdeployer.data.ScalescaleUpNextScaleWaitMins (optional)
intscaleUpPeriodCount (optional)
intscaleUpValue (optional)
intautoStart (optional)
booleandebugMode (optional)
ENABLED, DISABLEDenableAutoScalePolicy (optional)
booleanenvVars (optional)
key (optional)
Stringvalue (optional)
StringignoreGlobalSettings (optional)
booleanlogLevels (optional)
levelCategory (optional)
DEBUG, WARN, ERROR, INFOpackageName (optional)
StringloggingNgEnabled (optional)
booleanmonitoringAutoRestart (optional)
booleanmonitoringEnabled (optional)
booleanobjectStoreV1 (optional)
booleanpersistentQueues (optional)
booleanpersistentQueuesEncrypted (optional)
booleantimeoutConnection (optional)
inttimeoutResponse (optional)
intverifyDeployments (optional)
booleanverifyIntervalInSeconds (optional)
intworkerAmount (optional)
intworkerCpu (optional)
StringworkerMemory (optional)
StringworkerType (optional)
StringworkerWeight (optional)
String$class: 'CloudShellConfig'buildStep
$class: 'StartSandbox'blueprintName
StringsandboxDuration
StringmaxWaitForSandboxAvailability
intsetupTimeout
intparams (optional)
StringsandboxDomain (optional)
StringsandboxName (optional)
String$class: 'CmakeBuilder'cmake -G with the given options.
CMAKE_BUILD_TOOL build environment variable if the chosen generator supports that.
installationName
StringbuildDir (optional)
StringbuildType (optional)
StringcleanBuild (optional)
booleancmakeArgs (optional)
Stringgenerator (optional)
StringpreloadScript (optional)
StringsourceDir (optional)
Stringsteps (optional)
args (optional)
cmake. Arguments must be separated by spaces but may contain spaces if they are enclosed in double quotes (will be handled like a Unix shell does),
StringenvVars (optional)
DESTDIR=${WORKSPACE}/artifacts/dir
KEY=VALUE
StringwithCmake (optional)
$CMAKE_BUILD_TOOL) or to have cmake run the build tool (by invoking cmake --build <dir>).
boolean$class: 'CocoaPodsBuilder'cleanpods
boolean$class: 'CodeBuilder'credentialsType
StringcredentialsId
StringproxyHost
StringproxyPort
StringawsAccessKey
StringawsSecretKey
class hudson.util.SecretawsSessionToken
Stringregion
StringprojectName
StringsourceVersion
StringsseAlgorithm
StringsourceControlType
StringlocalSourcePath
StringworkspaceSubdir
StringgitCloneDepthOverride
StringreportBuildStatusOverride
StringsecondarySourcesOverride
StringsecondarySourcesVersionOverride
StringartifactTypeOverride
StringartifactLocationOverride
StringartifactNameOverride
StringartifactNamespaceOverride
StringartifactPackagingOverride
StringartifactPathOverride
StringartifactEncryptionDisabledOverride
StringoverrideArtifactName
StringsecondaryArtifactsOverride
StringenvVariables
StringenvParameters
StringbuildSpecFile
StringbuildTimeoutOverride
StringsourceTypeOverride
StringsourceLocationOverride
StringenvironmentTypeOverride
StringimageOverride
StringcomputeTypeOverride
StringcacheTypeOverride
StringcacheLocationOverride
StringcacheModesOverride
StringcloudWatchLogsStatusOverride
StringcloudWatchLogsGroupNameOverride
StringcloudWatchLogsStreamNameOverride
Strings3LogsStatusOverride
Strings3LogsEncryptionDisabledOverride
Strings3LogsLocationOverride
StringcertificateOverride
StringserviceRoleOverride
StringinsecureSslOverride
StringprivilegedModeOverride
StringcwlStreamingDisabled
StringexceptionFailureMode
StringdownloadArtifacts
StringdownloadArtifactsRelativePath
String$class: 'CodeCoverageBuilder'connectionId
StringcredentialsId
StringanalysisPropertiesPath
StringanalysisProperties
StringcodescenecredentialsId
StringdeltaAnalysisUrl
Stringrepository
StringanalyzeBranchDiff (optional)
booleananalyzeLatestIndividually (optional)
booleanbaseRevision (optional)
StringcouplingThresholdPercent (optional)
intfailOnDecliningCodeHealth (optional)
booleanfailOnFailedGoal (optional)
booleanletBuildPassOnFailedAnalysis (optional)
booleanmarkBuildAsUnstable (optional)
booleanoriginUrl (optional)
StringriskThreshold (optional)
int$class: 'CodeStreamBuilder'serverUrl
StringuserName
Stringpassword
Stringtenant
StringpipelineName
StringwaitExec
booleanpipelineParams
value
Stringname
String$class: 'CodefreshPipelineBuilder'selectPipeline
cfPipeline
StringcfBranch
StringsetCFVars
vars
Variable
StringValue
String$class: 'CommentsRemoverBuilder'filename
Stringlanguage
StringoutputDir
String$class: 'CompareBuilder'outputFolder
Path to the folder in that should be used to store compare output.
It serves as input for following steps like Generate create SQL script or Generate Report.
Folder location must be specified as:
StringsrcInputType
StringtgtInputType
StringsrcInputFileOrFolder
Specify input folder/file that will be used as source side input for compare. Following inputs are expected.
Folder/file location must be specified as:
StringtgtInputFileOrFolder
Specify input folder/file that will be used as target side input for compare. Following inputs are expected.
Folder/file location must be specified as:
StringconfigFile
Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
File location must be specified as:
String$class: 'CompareWithBaselineBuilder'outputFolder
Path to the folder in that should be used to store baseline compare output.
It serves as input for following steps like Generate create SQL script or Generate Report.
Folder location must be specified as:
StringsrcInputType
StringtgtInputType
StringsrcInputFileOrFolder
Specify input folder/file that will be used as source side input for baseline compare. Following inputs are expected.
Folder/file location must be specified as:
StringtgtInputFileOrFolder
Specify input folder/file that will be used as target side input for baseline compare. Following inputs are expected.
Folder/file location must be specified as:
StringconfigFile
Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
File location must be specified as:
String$class: 'CompoundBuilder'role
Stringnumber
StringactualBuilder
$class: 'A3Builder'project_file
Stringanalysis_ids
Stringpedantic_level
Stringexport_a3apxworkspace
Stringcopy_report_file
booleancopy_result_file
booleanskip_a3_analysis
boolean$class: 'ACSDeploymentBuilder'context
azureCredentialsId
StringresourceGroupName
StringcontainerService
StringsshCredentialsId
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.
StringconfigFilePaths
The path patterns for the specific cluster (Kubernetes, DC/OS, Docker Swarm) configurations you want to deploy, in the form of Ant glob syntax.
StringcontainerRegistryCredentials (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringdcosDockerCredenditalsPathShared (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.
booleandcosDockerCredentialsPath (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
StringenableConfigSubstitution (optional)
$VARIABLE or ${VARIABLE}) in the configuration with values from Jenkins environment variables.
This allows you to use dynamic values produced during the build in your Kubernetes or DC/OS configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.
booleansecretName (optional)
imagePullSecrets entry. Environment variable substitution are supported for the name input, so you can use available environment variables to construct the name dynamically, e.g., some-secret-$BUILD_NUMBER. The name should be in the pattern [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*, i.e., dot (.) concatenated sequences of hyphen (-) separated alphanumeric words. (See Kubernetes Names)
If left blank, the plugin will generate a name based on the build name.
The secret name will be exposed with the environment variable $KUBERNETES_SECRET_NAME. You can use this in your Kubernetes configuration to reference the updated secret when the "Enable Variable Substitution in Config" option is enabled.
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: nginx
spec:
replicas: 1
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: some.private.registry.domain/nginx
ports:
- containerPort: 80
imagePullSecrets:
- name: $KUBERNETES_SECRET_NAME
Note that once the secret is created, it will only be updated by the plugin. You have to manually delete it when it is not used anymore. If this is a problem, you may use fixed name so every time the job runs, the secret gets updated and no new secret is created.
StringsecretNamespace (optional)
StringswarmRemoveContainersFirst (optional)
booleanqualysAPIStaticAssessmentfreeUserType
booleanplatform (optional)
StringapiServer (optional)
StringcredsId (optional)
StringuseProxy (optional)
booleanproxyServer (optional)
StringproxyPort (optional)
intproxyCredentialsId (optional)
StringswaggerPath (optional)
StringapiId (optional)
StringisFailOnGrade (optional)
booleangrade (optional)
StringisFailOnSecurityGroup (optional)
booleansecurityGroupCount (optional)
StringsecurityCriticality (optional)
StringisFailOnDataGroup (optional)
booleandataGroupCount (optional)
StringdataCriticality (optional)
StringisFailOnViolationGroup (optional)
booleanviolationGroupCount (optional)
StringviolationCriticality (optional)
Stringtoken (optional)
StringcfyAzureArmazureCredentialsId (optional)
The ID of the credentials to use when accessing Azure. Parameters' expansion is supported when using freestyle jobs.
StringcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringdebugOutput (optional)
booleandeploymentId (optional)
StringechoEnvData (optional)
If checked, then the created environment's data will be printed to the job's log.
booleanechoInputs (optional)
booleanenvDataLocation (optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
Stringlocation (optional)
The Azure location where the created resource group should reside in. If omitted, the value of the azure_default_location Cloudify secret will be used.
Stringparameters (optional)
YAML/JSON of parameters to pass to the template.
java.util.Map<java.lang.String, java.lang.Object>parametersAsString (optional)
StringparametersFile (optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
StringresourceGroupName (optional)
Name of resource group to create for the template.
StringtemplateFile (optional)
Workspace-relative path of the ARM template file.
Stringtenant (optional)
String$class: 'AWSEBBuilder'extensions
awsRegion
GovCloud, US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, EU_WEST_1, EU_WEST_2, EU_CENTRAL_1, AP_SOUTH_1, AP_SOUTHEAST_1, AP_SOUTHEAST_2, AP_NORTHEAST_1, AP_NORTHEAST_2, SA_EAST_1, CN_NORTH_1, CN_NORTHWEST_1, CA_CENTRAL_1awsRegionText
StringcredentialsString
StringcredentialsText
StringapplicationName
StringversionLabelFormat
StringversionDescriptionFormat
StringfailOnError
booleanextensions
$class: 'AWSEBElasticBeanstalkSetup'$class: 'AWSEBS3Setup'bucketName
StringbucketRegion
StringkeyPrefix
StringrootObject
Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.
It could be either a path to a zip file or a directory.
If its a directory, includes and excludes are used to build the zip file
Stringincludes
Stringexcludes
StringoverwriteExistingFile
booleanuseTransferAcceleration
boolean$class: 'ByName'envNameList
String$class: 'ByUrl'urlList
StringenvLookup
$class: 'AWSEBElasticBeanstalkSetup'$class: 'AWSEBS3Setup'bucketName
StringbucketRegion
StringkeyPrefix
StringrootObject
Root Path to Grab for Artifacts, like '.' or 'target/myapp/'.
It could be either a path to a zip file or a directory.
If its a directory, includes and excludes are used to build the zip file
Stringincludes
Stringexcludes
StringoverwriteExistingFile
booleanuseTransferAcceleration
boolean$class: 'ByName'envNameList
String$class: 'ByUrl'urlList
String$class: 'AWSEBDeploymentBuilder'config
class br.com.ingenieux.jenkins.plugins.awsebdeployment.AWSEBDeploymentConfigapplicationName (optional)
StringawsRegion (optional)
StringbucketName (optional)
S3 Bucket Name to Upload to (e.g. "my-awseb-apps")
(Optional, will call createStorageLocation if blank)
StringcheckHealth (optional)
booleancredentialId (optional)
StringenvironmentName (optional)
Optional: AWS EB Environment name(s) to deploy to.
Can accept single or multiple comma-separated values. Examples:
When this value is set and each requested environment exists, an UpdateEnvironment call will be triggered as the Application Version is created.
Stringexcludes (optional)
Stringincludes (optional)
StringkeyPrefix (optional)
StringmaxAttempts (optional)
introotObject (optional)
Workspace-relative path of the artifact file to upload (if it's a file), or if it's a directory, the base directory to build the zip/war against
Examples:
target/mywebapp.war: The war file will be uploaded.' or 'target/war': A Zip file will be built and uploaded instead (using includes and excludes). StringskipEnvironmentUpdates (optional)
booleansleepTime (optional)
intversionDescriptionFormat (optional)
StringversionLabelFormat (optional)
StringzeroDowntime (optional)
booleanawsebReleasercredentialId
StringawsRegion
StringapplicationName
StringenvironmentId
StringversionLabel
StringabapCiabapPackagename (optional)
StringatcVariant (optional)
StringsapSystemLabel (optional)
StringrunAtcChecks (optional)
booleanrunUnitTests (optional)
booleantreatWarningAtcChecksAsErrors (optional)
booleanuseJenkinsProjectName (optional)
booleanwithCoverage (optional)
boolean$class: 'ActionHubPlugin'snActivatePlugincredentialsId (optional)
StringapiVersion (optional)
StringpluginId (optional)
Stringurl (optional)
String$class: 'AddComment'prefix
Stringnote
Stringlogfile
String$class: 'AddTestToSetStep'domain
Stringproject
StringtestPlanPath
StringtestSetPath
String$class: 'AmxEclipseAntBuilder'targets
Stringname
Jenkins supplies some environment variables that can be used from within the build script.
StringantOpts
StringbuildFile
Stringproperties
# comment name1=value1 name2=$VAR2These are passed to amx_eclipse_ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as amx_eclipse_ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname= Please refer to TIBCO Documentation for any detail
StringamxEclipseAntTra
StringbusinessStudioWs
Stringanchorename
Stringannotations (optional)
key
Stringvalue
StringautoSubscribeTagUpdates (optional)
booleanbailOnFail (optional)
booleanbailOnPluginFail (optional)
booleanengineCredentialsId (optional)
StringengineRetries (optional)
Stringengineurl (optional)
Stringengineverify (optional)
booleanforceAnalyze (optional)
booleanpolicyBundleId (optional)
String$class: 'AnsibleAdHocCommandBuilder'hostPattern
Stringinventory
$class: 'InventoryContent'content
Stringdynamic
boolean$class: 'InventoryDoNotSpecify'$class: 'InventoryPath'path
Stringmodule
Stringcommand
StringadditionalParameters (optional)
StringansibleName (optional)
StringbecomeUser (optional)
StringcolorizedOutput (optional)
booleancredentialsId (optional)
StringdisableHostKeyChecking (optional)
booleanextraVars (optional)
hidden (optional)
booleankey (optional)
Stringvalue (optional)
Stringforks (optional)
inthostKeyChecking (optional)
booleansudo (optional)
booleansudoUser (optional)
StringunbufferedOutput (optional)
booleanvaultCredentialsId (optional)
StringcfyAnsibleadditionalArgs (optional)
StringansibleEnvVars (optional)
StringcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringdebugLevel (optional)
intdebugOutput (optional)
booleandeploymentId (optional)
StringechoEnvData (optional)
booleanechoInputs (optional)
booleanenvDataLocation (optional)
StringoptionsConfig (optional)
StringplaybookPath (optional)
StringremergeSources (optional)
booleanrunData (optional)
StringsavePlaybook (optional)
booleanscpExtraArgs (optional)
StringsensitiveKeys (optional)
StringsftpExtraArgs (optional)
StringsourcePath (optional)
Stringsources (optional)
StringsshCommonArgs (optional)
StringsshExtraArgs (optional)
StringstartAtTask (optional)
Stringtenant (optional)
Stringtimeout (optional)
int$class: 'AnsiblePlaybookBuilder'playbook
Stringinventory
$class: 'InventoryContent'content
Stringdynamic
boolean$class: 'InventoryDoNotSpecify'$class: 'InventoryPath'path
StringadditionalParameters (optional)
StringansibleName (optional)
StringbecomeUser (optional)
StringcolorizedOutput (optional)
booleancredentialsId (optional)
StringdisableHostKeyChecking (optional)
booleanextraVars (optional)
hidden (optional)
booleankey (optional)
Stringvalue (optional)
Stringforks (optional)
inthostKeyChecking (optional)
booleanlimit (optional)
StringskippedTags (optional)
StringstartAtTask (optional)
Stringsudo (optional)
booleansudoUser (optional)
Stringtags (optional)
StringunbufferedOutput (optional)
booleanvaultCredentialsId (optional)
String$class: 'AnsibleTower'towerServer (optional)
StringjobTemplate (optional)
StringtowerCredentialsId (optional)
StringjobType (optional)
StringextraVars (optional)
StringjobTags (optional)
StringskipJobTags (optional)
Stringlimit (optional)
Stringinventory (optional)
Stringcredential (optional)
StringscmBranch (optional)
Stringverbose (optional)
booleanimportTowerLogs (optional)
StringremoveColor (optional)
booleantemplateType (optional)
StringimportWorkflowChildLogs (optional)
boolean$class: 'AnsibleTowerProjectRevisionFreestyle'towerServer (optional)
StringtowerCredentialsId (optional)
Stringproject (optional)
Stringrevision (optional)
Stringverbose (optional)
booleanthrowExceptionWhenFail (optional)
boolean$class: 'AnsibleTowerProjectSyncFreestyle'towerServer (optional)
StringtowerCredentialsId (optional)
Stringproject (optional)
Stringverbose (optional)
booleanimportTowerLogs (optional)
booleanremoveColor (optional)
boolean$class: 'AnsibleVaultBuilder'action (optional)
StringansibleName (optional)
Stringcontent (optional)
Stringinput (optional)
StringnewVaultCredentialsId (optional)
Stringoutput (optional)
StringvaultCredentialsId (optional)
StringantJenkins supplies some environment variables that can be used from within the build script.
targets
StringantName
StringantOpts
-Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
StringbuildFile
build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
Stringproperties
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
String$class: 'AntExec'scriptSource
StringextendedScriptSource
StringscriptName
Stringproperties
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes quotes and runs them through eval, and Windows has its own issues with escaping.. in either case, use of quotes may result in build failure. To define an empty property, simply write varname=
StringantName
StringantOpts
StringkeepBuildfile
booleanverbose
booleanemacs
booleannoAntcontrib
Disabling usage of Ant-Contrib Tasks in this build step.
booleanantwsJenkins supplies some environment variables that can be used from within the build script.
targets
StringantName
StringantOpts
-Xmx512m. Note that other Ant options (such as -lib) should go to the "Ant targets" field.
StringbuildFile
build.xml in the root directory; this option can be used to use build files with a different name or in a subdirectory.
Stringproperties
# comment name1=value1 name2=$VAR2These are passed to Ant like "-Dname1=value1 -Dname2=value2". Always use $VAR style (even on Windows) for references to Jenkins-defined environment variables. On Windows, %VAR% style references may be used for environment variables that exist outside of Jenkins. Backslashes are used for escaping, so use \\ for a single backslash. Double quotes (") should be avoided, as ant on *nix wraps parameters in quotes and runs them through eval, and Windows has its own issues with escaping. In either case, use of quotes may result in build failure. To define an empty property, simply write varname=
String$class: 'ApiFortressBuilder'mode
Stringhook
Stringid
Stringblocking
booleandryrun
booleansilent
booleanparam1name
Stringparam1value
Stringparam2name
Stringparam2value
Stringparam3name
Stringparam3value
StringapprayappRayUrl
StringoutputFilePath
StringwaitTimeout
intriskScoreThreshold
intcredentialsId
Stringappscanscanner
dynamic_analyzertarget
StringhasOptions
booleanextraField (optional)
StringloginPassword (optional)
StringloginUser (optional)
Stringoptimization (optional)
StringpresenceId (optional)
StringscanFile (optional)
StringscanType (optional)
StringtestPolicy (optional)
Stringmobile_analyzertarget
StringhasOptions
booleanextraField (optional)
StringloginPassword (optional)
StringloginUser (optional)
StringpresenceId (optional)
Stringstatic_analyzertarget
StringhasOptions
booleanopenSourceOnly (optional)
booleanname
Stringtype
Stringapplication
Stringcredentials
Stringemail (optional)
booleanfailBuild (optional)
booleanfailBuildNonCompliance (optional)
booleanfailureConditions (optional)
failureType
Stringthreshold
inttarget (optional)
Stringwait (optional)
booleanappscanenterprisecredentials
Stringfolder
StringtestPolicy
Stringtemplate
StringjobName
StringaccessId (optional)
Stringagent (optional)
Stringapplication (optional)
Stringemail (optional)
booleanexploreData (optional)
StringfailBuild (optional)
booleanfailureConditions (optional)
failureType
Stringthreshold
intloginType (optional)
StringscanType (optional)
StringsecretKey (optional)
Stringtarget (optional)
StringtestOptimization (optional)
StringtrafficFile (optional)
Stringwait (optional)
boolean$class: 'AppScanSourceBuilder'disableScan
booleanapplicationFile
StringacceptSSL
booleancustomScanWorkspace
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.
Stringinstallation (optional)
String$class: 'AppScanStandardBuilder'startingURL
Spiders will find the remaining URLs in the domain to be included for scanning.
Stringinstallation
StringadditionalCommands (optional)
AppScanCMD exec|ex|e
Parameters:
[ /dest_scan|/dest|/d ]
[ /base_scan|/base|/b ]
[ /old_host|/ohost|/oh ]
[ /new_host|/nhost|/nh ]
[ /scan_template|/stemplate|/st ]
[ /login_file|/lfile|/lf ]
[ /multi_step_file|/mstepfile|/mf ]
[ /manual_explore_file|/mexplorefile|/mef ]
[ /policy_file|/pfile|/pf ]
[ /additional_domains|/adomains|/ad ]
[ /report_file|/rf ]
[ /report_type|/rt {xml} ]
[ /min_severity|/msev {informational} ]
[ /test_type|/tt ]
[ /report_template|/rtemplate|/rtm {CliDefault} ]
Flags:
[ /verbose|/v {false} ]
[ /scan_log|/sl {false} ]
[ /explore_only|/eo {false} ]
[ /test_only|/to {false} ]
[ /multi_step|/mstep|/ms {false} ]
[ /continue|/c {false} ]
[ /merge_manual_explore_requests|/mmer {false} ]
[ /include_responses|/ir {false} ]
[ /open_proxy|/oprxy|/opr /listening_port|/lport|/lp ]
Creates new scan with base_scan's configuration
saving dest_scan and creating report, if configured.
AppScanCMD report|rep|r
Parametrs:
/base_scan|/base|/b
/report_file|/rf
/report_type|/rt
[ /min_severity|/msev {informational} ]
[ /test_type|/tt ]
[ /report_template|/rtemplate|/rtm {CliDefault} ]
Flags:
[ /verbose|/v {false} ]
Creates a report for base_scan.
AppScanCMD close_proxy|cprxy|cpr
Closes AppScan proxy if was previously opened.
More info. at:
(9.0.3.2 User Guide) CLI - Chapter 15 - CLI - Page 315
http://www-01.ibm.com/support/docview.wss?uid=swg27048015#2
StringauthScan (optional)
If the website contains private information accessed only by logging in this option should be checked and credentials provided to increase dynamic security coverage.
booleanauthScanPw (optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
StringauthScanRadio (optional)
A login sequence may be recorded using AppScan Standard's GUI by following these steps:
"Scan" > "Scan Configuration" > "Login Management" > "Record" > [ record your login...] > "I am logged in to the site" > "Details" (Tab) > "Export" (small icon on the right side).
Check "Form Based Authentication" if you do not have a recorded login sequence, this option will require an user name and password combination and is not guaranteed to work for all scenarios.
booleanauthScanUser (optional)
Providing an account with higher authorization (such as Administrator) will increase the attack surface and therefore the scan coverage.
StringgenerateReport (optional)
The report is available in HTML and PDF.
The HTML report generated is ready to be integrated with the HTML Publisher Plugin.
booleanhtmlReport (optional)
booleanincludeURLS (optional)
Some URLs might not be found by AppScan Standard's spiders, include them to get the best possible coverage.
StringpathRecordedLoginSequence (optional)
StringpdfReport (optional)
booleanpolicyFile (optional)
A Test Policy File can be created following these steps:
"Scan" > "Scan Configuration" > "Test Policy" > "Export".
StringreportName (optional)
To configure HTML Publisher Plugin properly, the names in the configuration must match.
Stringverbose (optional)
booleanxooaname
StringappId
String$class: 'AppUploaderBuilder'buildFilePath
StringapplatixaxUrl
StringaxUsername
StringaxPassword
StringaxServiceTemplateName
StringaxServiceTemplateRepository
StringaxServiceTemplateBranch
StringaxServiceTemplateParameters
key
Stringvalue
StringsnApplyChangescredentialsId (optional)
StringapiVersion (optional)
StringappScope (optional)
application system ID is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
StringappSysId (optional)
application scope is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
StringbranchName (optional)
Stringurl (optional)
String$class: 'ApprendaBuilder'appAlias
StringappName
StringversionAlias
Stringstage
StringartifactName
StringcredentialsId
Stringprefix
StringadvVersionAliasToBeForced
StringadvancedNewVersionOption
StringcustomPackageDirectory
StringapplicationPackageURL
StringarchiveUploadMethod
StringbuildWithParameters
booleanaqualocationType
Stringregistry
Stringregister
booleanlocalImage
StringhostedImage
StringonDisallowed
StringnotCompliesCmd
StringhideBase
booleanshowNegligible
booleanpolicies
StringcustomFlags
StringtarFilePath (optional)
StringcontainerRuntime (optional)
StringscannerPath (optional)
StringaquaMicroscannerimageName
StringonDisallowed
StringnotCompliesCmd
StringoutputFormat
StringaquaServerlessScanneronDisallowed
StringnotCompliesCmd
StringcodeScanPath
StringcustomFlags
StringarachniScannerurl
Stringchecks
Stringscope
pageLimit
intexcludePathPattern
StringuserConfig
filename
Stringformat
String$class: 'ArtifactDeployerBuilder'includes
Can use wildcards like 'module/dist/**/*.zip'. See the @includes of Ant fileset for the exact format.
Artifacts are deployed from the workspace. You can change this basedir by specifying the basedir field under Advanced.
Stringbasedir
By default, the basedir is the job workspace.
Give a value to override the default value.
Path relative to workspace is permitted.
Stringexcludes
Optionally specify the 'excludes' pattern, such as "foo/bar/**/*". A file that matches this mask will not be deployed even if it matches the mask specified.
Stringremote
Artifacts will be deployed in the specified output directory.
The remote location must be accessible through the build machine (master/slave node).
If you want to have the ability to download deployed artifacts through the Jenkins dashboard, the location must be accessible from the Jenkins master.
Make sure the Jenkins process have the right permissions to write to the remote location.
For example with a shared NFS storage, '/nfs/build/deploy/${BUILD_ID}' can be a valid value on an Unix machine.
Stringflatten
Ignore the directory structure of the source files, and deploy all the artifacts into the output directory.
booleandeleteRemote
Delete the output directory before deploying artifacts.
booleandeleteRemoteArtifacts
booleanfailNoFilesDeploy
boolean$class: 'ArtifactPromotionBuilder'groupId
StringartifactId
Stringclassifier
Stringversion
Stringextension
StringstagingRepository
StringstagingUser
StringstagingPW
StringreleaseUser
StringreleasePW
StringreleaseRepository
StringpromoterClass
Stringdebug
booleanskipDeletion
'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.
booleanartifactResolverartifacts
groupId
StringartifactId
Stringversion
Stringclassifier (optional)
StringdeployToLocal (optional)
booleandeployToRemote (optional)
booleanextension (optional)
StringfailOnError (optional)
booleanpomFile (optional)
StringtargetFileName (optional)
StringenableRepositoryLogging (optional)
booleanenableTransferLogging (optional)
booleanrepositoryId (optional)
StringtargetDirectory (optional)
StringassertthatBddFeaturesprojectId
StringcredentialsId
StringoutputFolder
Stringjql
Stringtags
Stringmode
StringproxyURI
StringproxyUsername
StringproxyPassword
StringjiraServerUrl
String$class: 'AssetBuilder'name
Stringdescription
Stringversion
Stringvendor
Stringplatform
Stringarchitecture
Stringbits
Stringcpu
intmemory
intstorage
intinstallationScriptFilePath
StringmediaFilePaths
path
StringlicenseFilePath
StringdocumentationFilePath
String$class: 'AssociateItemToRelease'releasePrefix
StringitemPrefix
StringassociateTagnexusInstanceId
StringtagName
Stringsearch
key
Stringvalue
String$class: 'AstreeBuilder'dax_file
Stringanalysis_id
Stringoutput_dir
Stringskip_analysis
booleangenXMLOverview
booleangenXMLCoverage
booleangenXMLAlarmsByOccurence
booleangenXMLAlarmsByCategory
booleangenXMLAlarmsByFile
booleangenXMLRulechecks
booleandropAnalysis
booleangenPreprocessOutput
booleanfailonswitch
failon
StringauditcredentialsId (optional)
StringminScore (optional)
intplatformUrl (optional)
StringbranchName (optional)
StringlogLevel (optional)
StringrepositoryName (optional)
StringshareEveryone (optional)
String$class: 'AutEnvironmentBuilder'autEnvironmentModel
almServerName
StringalmUserName
StringalmPassword
StringalmDomain
StringalmProject
StringclientType
StringautEnvironmentId
StringuseExistingAutEnvConf
booleanexistingAutEnvConfId
StringcreateNewAutEnvConf
booleannewAutEnvConfName
StringautEnvironmentParameters
name
Stringvalue
StringparamType
StringshouldGetOnlyFirstValueFromJson
booleanpathToJsonFile
StringoutputParameter
String$class: 'AutoConfigBuilder'name
StringdiscobitUrl
StringdiscobitUser
StringdiscobitPassword
class hudson.util.Secretconfigurations
Stringcuuid
String$class: 'Autogen'element
Specify the name of the element in your CA Endevor® sandbox that you want to include in the autogeneration process, for example, RUNCOB01. The maximum length is 8 characters.
You can specify several specific comma-separated elements within the sandbox, for example, RUNCOB01, RUNCOB02.
You can use wildcards % and * to define the name patterns for the element names.
Examples:
Specify * to include all elements from the sandbox in the autonegeration process.
Specify RUNCOB* to include all element names that start with "RUNCOB".
Specify %%%COB* to include elements that contain the substring COB starting after position three.
Stringenvironment
Provide the environment for the CA Endevor® sandbox that you want to include in the autogeneration process, for example, DEV.
Stringsystem
Provide the system name for the environment in your CA Endevor® sandbox that you want to include in the autogeneration process, for example, APCTTC0.
Stringsubsystem
Provide the subsystem name for the environment in your CA Endevor® sandbox that you want to include in the autogeneration process, for example, TESTCICD.
Stringstage
Specify the environment stage in your CA Endevor® that you want to include in the autogeneration process, for example, 1.
Stringinstance
Specify the instance name of the environment that is associated with CA Endevor® Web services, for example, WEBSMFNE.
Stringsignout
Select this option to work with elements in CA Endevor® that might be currently worked on by another user.
Select the Override signout option only if you have the permission to override the signout of another user.
boolean$class: 'AwsBatchBuilder'jobname
Stringjobdefinition
Stringcommand
Stringjobqueue
Stringvcpu
Stringmemory
Stringretries
StringazureCLIprincipalCredentialId
Stringcommands
script
StringexportVariablesString
StringazureDownloadstorageCredentialId
StringdownloadType
StringbuildSelector (optional)
downstreamupstreamProjectName
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
StringupstreamBuildNumber
StringlastWithArtifactslastCompleted$class: 'MultiJobBuildSelector'buildParameterparameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
Stringpermalinkid
String$class: 'PromotedBuildSelector'level
intlatestSavedBuildspecificbuildNumber
StringlastSuccessfulstable (optional)
booleanupstreamallowUpstreamDependencies (optional)
booleanfallbackToLastSuccessful (optional)
booleanupstreamFilterStrategy (optional)
UseGlobalSetting, UseOldest, UseNewestworkspacecontainerName (optional)
StringdeleteFromAzureAfterDownload (optional)
booleandownloadDirLoc (optional)
StringexcludeFilesPattern (optional)
StringfileShare (optional)
StringflattenDirectories (optional)
booleanincludeArchiveZips (optional)
booleanincludeFilesPattern (optional)
StringprojectName (optional)
Stringverbose (optional)
Enabling this will provide more logging on downloading files.
boolean$class: 'BDSBuilder'projectFile
Stringswitches
StringinstallationName
String$class: 'BapFtpBuilder'publishers
configName
Select an FTP configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the FTP server.
Stringverbose
booleantransfers
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.
Stringexcludes
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)
StringremoteDirectory
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.
StringremovePrefix
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.
StringasciiMode
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.
booleanremoteDirectorySDF
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 |
booleanflatten
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.
booleancleanRemote
Select to delete all files and directories within the remote directory before transferring files.
booleannoDefaultExcludes
booleanmakeEmptyDirs
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.
booleanpatternSeparator
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.
StringuseWorkspaceInPromotion
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
booleanusePromotionTimestamp
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.
booleanftpRetry
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
intretryDelay
longftpLabel
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.
StringftpCredentials
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
Stringpassword
StringcontinueOnError
booleanfailOnError
booleanalwaysPublishFromMaster
booleanmasterNodeName
StringparamPublish
parameterName
String$class: 'BapSshBuilderPlugin'publishers
configName
Select an SSH configuration from the list configured in the global configuration of this Jenkins.
The configuration defines the connection properties and base directory of the SSH server.
Stringverbose
booleantransfers
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.
Stringexcludes
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)
StringremoteDirectory
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.
StringremovePrefix
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.
StringremoteDirectorySDF
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 |
booleanflatten
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.
booleancleanRemote
booleannoDefaultExcludes
booleanmakeEmptyDirs
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.
booleanpatternSeparator
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.
StringexecCommand (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.
StringexecTimeout (optional)
Timeout in milliseconds for the Exec command.
Set to zero to disable.
intusePty (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.
booleanuseAgentForwarding (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.
booleanuseSftpForExec (optional)
Using SFTP protocol instead of SSH for Exec command.
Supported commands: mkdir, ln, symlink, rm, rmdir, cd, get, ls
booleanuseWorkspaceInPromotion
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.
booleanusePromotionTimestamp
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.
booleansshRetry
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
intretryDelay
longsshLabel
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.
StringsshCredentials
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
StringencryptedPassphrase
Key or Path to key is configured.
Stringkey
The private key.
Paste the private key here, or provide the path to the file containing the key in Path to key.
StringkeyPath
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
StringcontinueOnError
booleanfailOnError
booleanalwaysPublishFromMaster
booleanmasterNodeName
StringparamPublish
parameterName
StringbatchFilecommand
StringconfiguredLocalRules (optional)
retainOnlyVariablesLimit which environment variables are passed to a build step.
Environment variables passed to the build step are filtered, unless listed below.
The behavior of this filter depends on whether the environment variable is originally defined outside Jenkins:
JOB_URL, it will not be passed to the build step unless specified here.PATH, the behavior depends on the option Process environment variables handling: If that option is set to Retain, the original value will be passed to the build step, discarding any modifications inside Jenkins. If that option is set to Remove, the variable will not be passed to the build step. The following table shows the effect of filtering on an environment variable:
| Behavior | Originally defined outside Jenkins | Originally defined inside Jenkins |
|---|---|---|
| Process environment variables handling: reset | Variable is reset to original value | Variable is removed |
| Process environment variables handling: removed | Variable is removed | Variable is removed |
processVariablesHandling (optional)
RESET, REMOVEretainCharacteristicEnvVars (optional)
When checked, characteristic environment variables will be retained in addition to the variables listed above. These environment variables are job- and build-specific, defined by Jenkins, and are used to identify and kill processes started by this build step. See the documentation for more details on starting processes.
booleanvariables (optional)
Whitespace separated, case insensitive list of environment variables that will be retained, i.e. not removed from the environment of this build step or reset to their default.
StringunstableReturn (optional)
intsnBatchInstallcredentialsId (optional)
StringapiVersion (optional)
StringbatchName (optional)
Stringfile (optional)
The field is required if Use file is checked. If the field is not changed default value will be used: now_batch_manifest.json.
Stringnotes (optional)
Default: null
Stringpackages (optional)
[{
"id": "String",
"load_demo_data": Boolean,
"notes": "String",
"requested_customized_version": "String",
"requested_version": "String",
"type": "String"
}]
| id | Required. Sys_id of the application or identifier of the plugin to install. |
|---|---|
| load_demo_data | Flag that indicates whether demo data is loaded when installing the package. Valid values: true: Demo data should be loaded. false: Demo data should not be loaded. Default: false |
| notes | User specified notes about the package. Default: null |
| requested_customized_version | Only applicable when packages.type is set to application. Version of the store application customization package to install, such as 1.0.2 or 2.3. |
| requested_customized_version | Only applicable when packages.type is set to application. Version of the store application customization package to install, such as 1.0.2 or 2.3. Default: None. If this is not set, then the system does not look for customizations for the application. |
| requested_version | Required if type is set to application; ignored if set to plugin. Version of the package to install, such as 1.0.2 or 2.3. |
| type | Required. Type of package. Valid values:
|
Stringurl (optional)
StringuseFile (optional)
Default: false
booleansnBatchRollbackcredentialsId (optional)
StringapiVersion (optional)
StringrollbackId (optional)
sys_id) of the rollback installed before.
Stringurl (optional)
If ServiceNow Parameters are used, then the URL of installation instance will be used.
String$class: 'BeaglePlugin'apptoken
class hudson.util.Secretaccesstoken
class hudson.util.Secret$class: 'BeakerBuilder'jobSource
$class: 'FileJobSource'jobPath
String$class: 'StringJobSource'jobContent
StringdownloadFiles
boolean$class: 'BeginAnalysis'logLevel
OFF, INFO, DEBUG, WARN, ERRORbuildSessionId
StringappName
StringmoduleName
Stringbranch
StringenableMultipleBuildFiles
booleanoverrideJars
booleanmultipleBuildFiles
booleanlabId
StringtestStage
StringpackagesIncluded
StringpackagesExcluded
StringfilesIncluded
StringfilesExcluded
StringclassLoadersExcluded
Stringrecursive
booleanworkspacepath
StringbuildScannerJar
StringtestListenerJar
StringtestListenerConfigFile
StringautoRestoreBuildFile
booleansealightsMavenPluginInstallationArguments
StringbuildFilesPatterns
StringbuildFilesFolders
StringlogEnabled
booleanlogDestination
CONSOLE, FILElogFolder
StringbuildStrategy
ONE_BUILD, BUILD_EACH_MODULEslMvnPluginVersion
StringbuildName
$class: 'DefaultBuildName'$class: 'EmptyBuildName'$class: 'LatestBuildName'$class: 'ManualBuildName'insertedBuildName
String$class: 'UpstreamBuildName'upstreamProjectName
StringexecutionType
FULL, TESTS_ONLY, ONLY_LISTENERoverride_customerId
Stringoverride_url
Stringoverride_proxy
StringadditionalArguments
| Argument name | Description |
|---|---|
| token | The token provided to you by SeaLights (override the global 'token' value for this build). |
| tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
| buildsessionidfile | Set build session id file for this build. |
| createbuildsessionid | When set to 'true' - forces SeaLights Maven Plugin to create new build session id (true by default). |
| proxy | A valid URL to a proxy server. |
| agentpath | Override the path to SeaLights jar. |
| javapath | Override the path to the 'java' variable (default is 'java'). |
| filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
| sealightsJvmParams | Key value pairs of environments variables which will be added to both buildscanner and test listener ('$$$'- separated pairs, ':'- separated key and value. i.e: sealightsJvmParams=param:value$$$anotherparam:anothervalue) |
| buildScannerParams | Key value pairs of environments variables which will be added to buildscanner ('$$$'- separated pairs, ':'- separated key and value. i.e: buildScannerParams=param:value$$$anotherparam:anothervalue) |
| testListenerJvmParams | Key value pairs of environments variables which will be added to test listener ('$$$'- separated pairs, ':'- separated key and value i.e: testListenerJvmParams=param:value$$$anotherparam:anothervalue) |
StringincludeResources
booleanbenchmarkfilepath
String$class: 'BitbucketPublisher'serverUrl (optional)
StringcredentialsId (optional)
StringprojectKey (optional)
StringcreateProject (optional)
projectName
StringprojectUsers
StringprojectGroups
StringcreateJenkinsJobs (optional)
ciServer
StringprojectName (optional)
String$class: 'BladeBuilder'blades
$class: 'CodeScan'source
Stringexclude
StringnoCache
booleannoProxy
booleannoBlame
booleanruleset
StringseverityLevel
StringseverityThreshold
intautoUpdate (optional)
booleancredentialsId (optional)
Stringdebug (optional)
booleandirectory (optional)
Stringenvironment (optional)
StringforceVersion (optional)
StringignoreFailure (optional)
booleanonFailureCmd (optional)
Stringtimeout (optional)
int$class: 'ImageScan'image
Stringexclude
StringnoCache
booleannoProxy
booleannoBlame
booleanruleset
StringseverityLevel
StringseverityThreshold
intautoUpdate (optional)
booleancredentialsId (optional)
Stringdebug (optional)
booleandirectory (optional)
Stringenvironment (optional)
StringforceVersion (optional)
StringignoreFailure (optional)
booleanonFailureCmd (optional)
Stringtimeout (optional)
int$class: 'BlueprintLaunch'projectName
Project selection is mandatory.
StringblueprintName
Blueprint selection is mandatory.
StringapplicationName
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.
StringappProfileName
Application Profile selection is mandatory.
StringactionName
The field is mandatory
Select the required action need to run after the application launch from the list of actions, else please select none.
StringruntimeVariables
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.
StringwaitForSuccessFulLaunch
booleanblueprintDescription
Description is fetched from the selected Calm blueprint
String$class: 'BootPluginBuilder'tasks
StringjvmOpts
String$class: 'BranchDestructionStep'project
Stringbranch
String$class: 'BranchGenerationStep'projectConfig
pipelineConfig
destructor
booleanauthorisations
StringbranchSCMParameter
booleanbranchParameters
StringgenerationExtension
StringpipelineGenerationExtension
StringdisableDslScript
booleanscriptDirectory
StringnamingStrategy
projectFolderPath
StringbranchFolderPath
StringprojectSeedName
StringprojectDestructorName
StringbranchSeedName
StringbranchStartName
StringbranchName
StringignoredBranchPrefixes
StringeventStrategy
delete
booleanauto
booleantrigger
booleancommit
Stringproject
StringscmType
StringscmUrl
StringscmCredentials
StringtriggerIdentifier
StringtriggerType
StringtriggerSecret
StringdotnetBuilddotnet build command builds the project and its dependencies into a set of binaries. The binaries include the project's code in Intermediate Language (IL) files with a .dll extension. Depending on the project type and settings, other files may be included, such as:
configuration (optional)
Debug, but you can override the build configuration settings in your project.
Stringforce (optional)
booleanframework (optional)
StringnoDependencies (optional)
booleannoIncremental (optional)
booleannoRestore (optional)
booleannologo (optional)
booleanoption (optional)
Stringoptions (optional)
StringoptionsString (optional)
StringoutputDirectory (optional)
./bin/<configuration>/<framework>/. For projects with multiple target frameworks (via the TargetFrameworks property), you also need to specify a specific framework when you specify this option.
Stringproject (optional)
Stringproperties (optional)
java.util.Map<java.lang.String, java.lang.String>propertiesString (optional)
Stringruntime (optional)
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleanshutDownBuildServers (optional)
dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
hanguntil those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
booleanspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleantarget (optional)
Stringtargets (optional)
StringtargetsString (optional)
StringunstableIfWarnings (optional)
booleanverbosity (optional)
StringversionSuffix (optional)
$(VersionSuffix) property to use when building the project. This only works if the $(Version) property isn't set. Then, $(Version) is set to the $(VersionPrefix) combined with the $(VersionSuffix), separated by a dash.
StringworkDirectory (optional)
StringbuildAddUrltitle
Stringurl
String$class: 'BuildBuilder'dbFolder
value
vcsroot, subfolder, scaprojectsubfolder
StringprojectPath
Stringpackageid
StringtempServer
value
StringserverName
StringdbName
StringserverAuth
value
Stringusername
Stringpassword
class hudson.util.SecretencryptConnection
booleantrustServerCertificate
booleanoptions
StringdataOptions
StringtransactionIsolationLevel
Serializable, Snapshot, RepeatableRead, ReadCommitted, ReadUncommittedfilter
StringpackageVersion
StringdlmDashboard
dlmDashboardHost
StringdlmDashboardPort
StringsqlChangeAutomationVersionOption
value
Latest, SpecificspecificVersion
StringbuildDescriptiondescriptionTemplate
StringbuildNamenameTemplate
String$class: 'BuildNameUpdater'fromFile
booleanbuildName
StringfromMacro
booleanmacroTemplate
StringmacroFirst
booleancrxBuildpackageId (optional)
StringbaseUrl (optional)
username[:password]@ between the scheme and the hostname.
StringcredentialsId (optional)
/$username/keys/$fingerprint.
Stringdownload (optional)
booleanlocalDirectory (optional)
StringrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
longwspFilter (optional)
/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.
String$class: 'BuildScanner'profile
Stringtarget
StringrepTemp
Stringthreat
StringstopScan
booleansvRep
booleanincScan
booleanincScanId
StringstopTargetScans
boolean$class: 'BuildStepBuilder'sourceFolderMode
Stringsubfolder
StringpackageId
StringserverType
Stringserver
StringauthenticationType
StringuserName
Stringpassword
class hudson.util.Secretdatabase
StringcompareOptions (optional)
StringfilterFile (optional)
StringtransactionIsoLvl (optional)
String$class: 'BuildStepWithTimeout'buildStep
hudson.tasks.BuildStep)strategy
$class: 'AbsoluteTimeOutStrategy' Abort build based on a fixed time-out.
timeoutMinutes
String$class: 'DeadlineTimeOutStrategy' Abort build based on a deadline time specified in HH:MM:SS or HH:MM (24-hour time format).
deadlineTime
StringdeadlineToleranceInMinutes
int$class: 'ElasticTimeOutStrategy' Define time to wait before killing the build as a percentage of the mean of the duration of the last n successful builds.
timeoutPercentage
StringtimeoutMinutesElasticDefault
StringnumberOfBuilds
StringfailSafeTimeoutDuration
boolean$class: 'LikelyStuckTimeOutStrategy'Abort the build when the job has taken many times longer than previous runs.
$class: 'NoActivityTimeOutStrategy'timeoutSecondsString
String$class: 'RunConditionTimeoutStrategy'This extension uses run condition as condition sources.
conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'conditions
condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
Stringtimeout
longdefaultTimeout
longoperationList
$class: 'AbortAndRestartOperation'maxRestarts
String$class: 'AbortOperation'$class: 'BuildStepOperation'buildstep
hudson.tasks.BuildStep)continueEvenFailed
booleancreateLauncher
boolean$class: 'FailOperation'$class: 'WriteDescriptionOperation'description
String$class: 'BuildStepsFromJsonBuilder'$class: 'BuildoutBuilder'pythonName
StringbuildoutCfg
Stringnature
Stringcommand
StringignoreExitCode
booleanbyteguardGreettoken
Stringtask_id
String$class: 'CFLaunchBuilder'cfComposition
StringsetCFVars
vars
Variable
StringValue
String$class: 'CIMessageBuilder'providerData (optional)
activeMQPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanmessageContent (optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
StringmessageProperties (optional)
KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
StringmessageType (optional)
Type of CI message to be sent.
CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatusname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
StringactiveMQSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
Stringselector (optional)
JMS selector to choose messages that will fire the trigger.
Stringtimeout (optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
intvariable (optional)
Environment variable to hold received message content.
StringfedmsgPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanmessageContent (optional)
Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
StringfedmsgSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
Stringtimeout (optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
intvariable (optional)
Environment variable to hold received message content.
StringrabbitMQPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanfedoraMessaging (optional)
booleanmessageContent (optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
Stringschema (optional)
Path to message schema.
Stringseverity (optional)
Severity of the message.
intrabbitMQSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
Stringtimeout (optional)
Value (in minutes) to wait for a message.
intvariable (optional)
Environment variable to hold received message content.
String$class: 'CIMessageSubscriberBuilder'Subscribe to the CI message bus and wait for a message matching the specified JMS selector.
The variable value specifies the name of an environment variable in which to place the received message body.
The timeout value specifies the maximum number of minutes to wait for a message matching the JMS selector to appear.
providerData (optional)
activeMQPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanmessageContent (optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
StringmessageProperties (optional)
KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
StringmessageType (optional)
Type of CI message to be sent.
CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatusname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
StringactiveMQSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
Stringselector (optional)
JMS selector to choose messages that will fire the trigger.
Stringtimeout (optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
intvariable (optional)
Environment variable to hold received message content.
StringfedmsgPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanmessageContent (optional)
Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
StringfedmsgSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
Stringtimeout (optional)
Value (in minutes) to wait for a message matching the specified JMS selector.
intvariable (optional)
Environment variable to hold received message content.
StringrabbitMQPublisherfailOnError (optional)
Whether you want to fail the build if there is an error sending a message. By default, it is false.
booleanfedoraMessaging (optional)
booleanmessageContent (optional)
Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
Stringschema (optional)
Path to message schema.
Stringseverity (optional)
Severity of the message.
intrabbitMQSubscriberchecks (optional)
field
StringexpectedValue
Stringname (optional)
Stringoverrides (optional)
topic (optional)
Stringqueue (optional)
Stringtimeout (optional)
Value (in minutes) to wait for a message.
intvariable (optional)
Environment variable to hold received message content.
String$class: 'CRDABuilder'file (optional)
StringcrdaKeyId (optional)
StringcliVersion (optional)
StringconsentTelemetry (optional)
CRDA CLI is constantly improving and we would like to know more about usage. Click here to find more details.
boolean$class: 'CToolBuilder'cmake -P <script file>) or command mode (cmake -E <command>).
installationName
Stringarguments (optional)
StringignoredExitCodes (optional)
StringtoolId (optional)
StringworkingDir (optional)
StringgenerateCachecaches
type
A2L, ELF, BUS, MODEL, SERVICEfilePath
StringdbChannel
Stringclear
boolean$class: 'CallFunction'functionName (optional)
StringargumentList (optional)
Stringargument (optional)
String$class: 'CallOtherJenkinsBuilder'hostName
StringjobName
Stringspan
Stringretry
StringuserName
Stringpassword
Stringparameters
String$class: 'CaptureIOSDeviceScreenshot'url
StringcloudTestServerID
StringadditionalOptions
Stringcarbonetesname
StringcredentialsId (optional)
StringengineTimeout (optional)
intfailBuildOnPluginError (optional)
booleanfailBuildOnPolicyEvaluationFailResult (optional)
booleanimage (optional)
StringpolicyBundleID (optional)
StringregistryURI (optional)
StringcarlinstallationName
StringsourcePath
StringapplicationName
StringarchivePdf (optional)
booleandisplayLog (optional)
booleanlogPath (optional)
StringoutputPath (optional)
StringqualityGate (optional)
StringcastechoinstallationName
StringsourcePath
StringapplicationName
StringdisplayLog (optional)
booleanlogPath (optional)
StringoutputPath (optional)
StringqualityGate (optional)
StringvenafiVcertRequestCertificateconnectorName
StringzoneConfigName
The name of the zone configuration to use.
When using Venafi as a Service, zone names are in the format of app name\api alias
StringcommonName
StringprivKeyOutput
StringcertOutput
StringcertChainOutput
Stringcountry (optional)
StringdnsNames (optional)
hostName
StringemailAddresses (optional)
address
StringexpirationWindow (optional)
intipAddresses (optional)
address
StringkeyType (optional)
RSA, ECDSAlocality (optional)
Stringorganization (optional)
StringorganizationalUnit (optional)
Stringprovince (optional)
StringchangeAsmVerversionPattern
StringassemblyCompany (optional)
StringassemblyCopyright (optional)
StringassemblyCulture (optional)
StringassemblyDescription (optional)
StringassemblyFile (optional)
StringassemblyProduct (optional)
StringassemblyTitle (optional)
StringassemblyTrademark (optional)
StringregexPattern (optional)
StringreplacementPattern (optional)
String$class: 'ChangeEventBuilder'integrationKey
StringsummaryText (optional)
StringchatterPost postToChatter "Build Started - ${env.JOB_NAME} ${env.BUILD_NUMBER} (<${env.BUILD_URL}|Open>)"
credentialsId
If you're connecting from outside of your organizations trusted network, you'll also need to append your API security token to your password.
See Identity Confirmation in the salesforce.com online help for more information.
Stringbody
StringbuildUrlTitle (optional)
StringrecordId (optional)
Stringserver (optional)
String$class: 'CheckGate'pipelineId
StringstageName
StringversionId
Stringfatal
String$class: 'CheckGateBuilder'project
Stringgate
String$class: 'ChefBuilderConfiguration'url
Stringsinatraurl
Stringfilter
Stringusername
Stringport
intcommand
Stringprivatekey
Stringparallel
booleanfail
booleanchlAtuoActioncontent
StringbrowserString
StringrunScriptOnly
booleanrootPath
StringlibPath
String$class: 'ChrootBuilder'chrootName
StringignoreExit
booleanadditionalPackages
StringpackagesFile
Stringclear
booleancommand
StringloginAsRoot
booleannoUpdate
booleanforceInstall
boolean$class: 'CifsBuilderPlugin'publishers
configName
Stringverbose
booleantransfers
sourceFiles
Stringexcludes
StringremoteDirectory
StringremovePrefix
StringremoteDirectorySDF
booleanflatten
booleancleanRemote
booleannoDefaultExcludes
booleanmakeEmptyDirs
booleanpatternSeparator
StringuseWorkspaceInPromotion
booleanusePromotionTimestamp
booleanretry
retries
intretryDelay
longlabel
label
StringcontinueOnError
booleanfailOnError
booleanalwaysPublishFromMaster
booleanmasterNodeName
StringparamPublish
parameterName
String$class: 'ClangScanBuildBuilder'target
StringtargetSdk
xcodebuild -showsdks
Stringconfig
StringclangInstallationName
StringxcodeProjectSubPath
Stringworkspace
Stringscheme
Stringscanbuildargs
Stringxcodebuildargs
StringoutputFolderName
StringgoogleStorageUploadcredentialsId
Stringbucket
Stringpattern
StringpathPrefix (optional)
StringsharedPublicly (optional)
booleanshowInline (optional)
booleandotnetCleandotnet clean command cleans the output of the previous build. It's implemented as an MSBuild target, so the project is evaluated when the command is run. Only the outputs created during the build are cleaned. Both intermediate (obj) and final output (bin) folders are cleaned.
configuration (optional)
Debug, but you can override the build configuration settings in your project. This option is only required when cleaning if you specified it during build time.
Stringframework (optional)
Stringnologo (optional)
booleanoption (optional)
Stringoptions (optional)
StringoptionsString (optional)
StringoutputDirectory (optional)
Stringproject (optional)
Stringproperties (optional)
java.util.Map<java.lang.String, java.lang.String>propertiesString (optional)
Stringruntime (optional)
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleanshutDownBuildServers (optional)
dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
hanguntil those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
booleanspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleanunstableIfWarnings (optional)
booleanverbosity (optional)
StringworkDirectory (optional)
StringexamCleanTargetvalidNetworkusername
Stringpassword
StringprojectId
Stringfilepath
String$class: 'ClifBuilder'clifName
StringclifOpts
StringtestPlanFile
StringreportDir
String$class: 'CloudBuildBuilder'input
credentialsId
Stringrequest
filefilename
Stringinlinerequest
Stringsource (optional)
localpath
.tgz or .tar.gz) or zip file (.zip), or .tgz) and uploaded to a temporary Cloud Storage bucket. Stringrepobranch (optional)
Stringcommit (optional)
StringprojectId (optional)
StringrepoName (optional)
Stringtag (optional)
Stringstoragebucket
Stringobject
StringsubstitutionList (optional)
items
key
_) and use only numbers, uppercase letters, and underscores (respecting the regular expression _[A-Z0-9_]+). The key may not be longer than 100 characters. For details, see Build Requests - User-defined substitutions.
Stringvalue
Stringsubstitutions (optional)
java.util.Map<java.lang.String, java.lang.String>pushToCloudFoundrytarget
Stringorganization
StringcloudSpace
StringcredentialsId
StringmanifestChoice (optional)
appName (optional)
StringappPath (optional)
Stringbuildpack (optional)
Stringcommand (optional)
Stringdomain (optional)
StringenvVars (optional)
key
Stringvalue
Stringhostname (optional)
Stringinstances (optional)
StringmanifestFile (optional)
Stringmemory (optional)
StringnoRoute (optional)
StringservicesNames (optional)
name
Stringstack (optional)
Stringtimeout (optional)
Stringvalue (optional)
StringpluginTimeout (optional)
StringselfSigned (optional)
StringservicesToCreate (optional)
name
Stringtype
Stringplan
StringresetService (optional)
booleancloudhubDeployerenvironmentId
StringorgId
StringappName
StringmuleVersion
StringfilePath
StringcredentialsId (optional)
StringrequestMode (optional)
CREATE, UPDATE, CREATE_OR_UPDATE, UPDATE_FILE, RESTART, DELETEregion (optional)
StringautoScalePolicy (optional)
autoScalePolicyName (optional)
StringenableAutoScalePolicy (optional)
booleanid (optional)
StringmaxScale (optional)
intminScale (optional)
intscaleBasedOn (optional)
StringscaleDown (optional)
class org.jenkinsci.plugins.cloudhubdeployer.data.ScalescaleDownNextScaleWaitMins (optional)
intscaleDownPeriodCount (optional)
intscaleDownValue (optional)
intscaleType (optional)
StringscaleUp (optional)
class org.jenkinsci.plugins.cloudhubdeployer.data.ScalescaleUpNextScaleWaitMins (optional)
intscaleUpPeriodCount (optional)
intscaleUpValue (optional)
intautoStart (optional)
booleandebugMode (optional)
ENABLED, DISABLEDenableAutoScalePolicy (optional)
booleanenvVars (optional)
key (optional)
Stringvalue (optional)
StringignoreGlobalSettings (optional)
booleanlogLevels (optional)
levelCategory (optional)
DEBUG, WARN, ERROR, INFOpackageName (optional)
StringloggingNgEnabled (optional)
booleanmonitoringAutoRestart (optional)
booleanmonitoringEnabled (optional)
booleanobjectStoreV1 (optional)
booleanpersistentQueues (optional)
booleanpersistentQueuesEncrypted (optional)
booleantimeoutConnection (optional)
inttimeoutResponse (optional)
intverifyDeployments (optional)
booleanverifyIntervalInSeconds (optional)
intworkerAmount (optional)
intworkerCpu (optional)
StringworkerMemory (optional)
StringworkerType (optional)
StringworkerWeight (optional)
String$class: 'CloudShellConfig'buildStep
$class: 'StartSandbox'blueprintName
StringsandboxDuration
StringmaxWaitForSandboxAvailability
intsetupTimeout
intparams (optional)
StringsandboxDomain (optional)
StringsandboxName (optional)
String$class: 'CmakeBuilder'cmake -G with the given options.
CMAKE_BUILD_TOOL build environment variable if the chosen generator supports that.
installationName
StringbuildDir (optional)
StringbuildType (optional)
StringcleanBuild (optional)
booleancmakeArgs (optional)
Stringgenerator (optional)
StringpreloadScript (optional)
StringsourceDir (optional)
Stringsteps (optional)
args (optional)
cmake. Arguments must be separated by spaces but may contain spaces if they are enclosed in double quotes (will be handled like a Unix shell does),
StringenvVars (optional)
DESTDIR=${WORKSPACE}/artifacts/dir
KEY=VALUE
StringwithCmake (optional)
$CMAKE_BUILD_TOOL) or to have cmake run the build tool (by invoking cmake --build <dir>).
boolean$class: 'CocoaPodsBuilder'cleanpods
boolean$class: 'CodeBuilder'credentialsType
StringcredentialsId
StringproxyHost
StringproxyPort
StringawsAccessKey
StringawsSecretKey
class hudson.util.SecretawsSessionToken
Stringregion
StringprojectName
StringsourceVersion
StringsseAlgorithm
StringsourceControlType
StringlocalSourcePath
StringworkspaceSubdir
StringgitCloneDepthOverride
StringreportBuildStatusOverride
StringsecondarySourcesOverride
StringsecondarySourcesVersionOverride
StringartifactTypeOverride
StringartifactLocationOverride
StringartifactNameOverride
StringartifactNamespaceOverride
StringartifactPackagingOverride
StringartifactPathOverride
StringartifactEncryptionDisabledOverride
StringoverrideArtifactName
StringsecondaryArtifactsOverride
StringenvVariables
StringenvParameters
StringbuildSpecFile
StringbuildTimeoutOverride
StringsourceTypeOverride
StringsourceLocationOverride
StringenvironmentTypeOverride
StringimageOverride
StringcomputeTypeOverride
StringcacheTypeOverride
StringcacheLocationOverride
StringcacheModesOverride
StringcloudWatchLogsStatusOverride
StringcloudWatchLogsGroupNameOverride
StringcloudWatchLogsStreamNameOverride
Strings3LogsStatusOverride
Strings3LogsEncryptionDisabledOverride
Strings3LogsLocationOverride
StringcertificateOverride
StringserviceRoleOverride
StringinsecureSslOverride
StringprivilegedModeOverride
StringcwlStreamingDisabled
StringexceptionFailureMode
StringdownloadArtifacts
StringdownloadArtifactsRelativePath
String$class: 'CodeCoverageBuilder'connectionId
StringcredentialsId
StringanalysisPropertiesPath
StringanalysisProperties
StringcodescenecredentialsId
StringdeltaAnalysisUrl
Stringrepository
StringanalyzeBranchDiff (optional)
booleananalyzeLatestIndividually (optional)
booleanbaseRevision (optional)
StringcouplingThresholdPercent (optional)
intfailOnDecliningCodeHealth (optional)
booleanfailOnFailedGoal (optional)
booleanletBuildPassOnFailedAnalysis (optional)
booleanmarkBuildAsUnstable (optional)
booleanoriginUrl (optional)
StringriskThreshold (optional)
int$class: 'CodeStreamBuilder'serverUrl
StringuserName
Stringpassword
Stringtenant
StringpipelineName
StringwaitExec
booleanpipelineParams
value
Stringname
String$class: 'CodefreshPipelineBuilder'selectPipeline
cfPipeline
StringcfBranch
StringsetCFVars
vars
Variable
StringValue
String$class: 'CommentsRemoverBuilder'filename
Stringlanguage
StringoutputDir
String$class: 'CompareBuilder'outputFolder
Path to the folder in that should be used to store compare output.
It serves as input for following steps like Generate create SQL script or Generate Report.
Folder location must be specified as:
StringsrcInputType
StringtgtInputType
StringsrcInputFileOrFolder
Specify input folder/file that will be used as source side input for compare. Following inputs are expected.
Folder/file location must be specified as:
StringtgtInputFileOrFolder
Specify input folder/file that will be used as target side input for compare. Following inputs are expected.
Folder/file location must be specified as:
StringconfigFile
Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
File location must be specified as:
String$class: 'CompareWithBaselineBuilder'outputFolder
Path to the folder in that should be used to store baseline compare output.
It serves as input for following steps like Generate create SQL script or Generate Report.
Folder location must be specified as:
StringsrcInputType
StringtgtInputType
StringsrcInputFileOrFolder
Specify input folder/file that will be used as source side input for baseline compare. Following inputs are expected.
Folder/file location must be specified as:
StringtgtInputFileOrFolder
Specify input folder/file that will be used as target side input for baseline compare. Following inputs are expected.
Folder/file location must be specified as:
StringconfigFile
Specify settings file location. This file should be exported from Toad Edge and contain all compare settings.
File location must be specified as:
String$class: 'CompoundBuilder'$class: 'ConditionalBuilder'runCondition
$class: 'AlwaysRun'$class: 'And'conditions
condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'conditions
condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
Stringrunner
A run condition evaluation may fail to run cleanly - especially if it is dependent on expanding tokens provided by the Token Macro Plugin and the values are expected to be present or look like a certain type i.e. be a number.
...its about the action to take when the condition can not be evaluated - this is not same as evaluating to false.
$class: 'DontRun'$class: 'Fail'$class: 'Run'$class: 'RunUnstable'$class: 'Unstable'conditionalbuilders
hudson.tasks.BuildStep)$class: 'ConfigFileBuildStep'managedFiles
fileId
Name of the file.
StringreplaceTokens (optional)
Decides whether the token should be replaced using macro.
booleantargetLocation (optional)
Name of the file (with optional file relative to workspace directory) where the config file should be copied.
Stringvariable (optional)
Name of the variable which can be used as the reference for further configuration.
String$class: 'ConfluenceReleaseNotesPublisher'jiraCredentialsID
StringconfluenceCredentialsID
StringspaceKey
StringjqlFilter
StringpageTitle
StringparentPageTitle
String$class: 'ConsulBuilder'installationName
StringoperationList
$class: 'ConsulGetKV'valuePath
StringenvironmentVariableName
String$class: 'ConsulServiceDiscoveryOperation'serviceName
StringserviceTag
StringenvironmentVariableName
StringhealthStatus
StringaddPort
boolean$class: 'ConsulSetKV'valuePath
Stringvalue
StringconsulSettingsProfileName
String$class: 'ConsulKVBuilder'hostUrl
Stringkey
StringaclToken (optional)
StringapiUri (optional)
StringdebugMode (optional)
ENABLED, DISABLEDenvVarKey (optional)
StringignoreGlobalSettings (optional)
booleankeyValue (optional)
StringrequestMode (optional)
READ, WRITE, DELETEtimeoutConnection (optional)
inttimeoutResponse (optional)
intassessContainerImagefailOnPluginError (optional)
booleanimageId (optional)
StringnameRules (optional)
packageNameaction
Stringcontains
StringvulnerabilityCategoryaction
Stringcontains
StringvulnerabilityTitleaction
Stringcontains
StringvulnerablePackageNameaction
Stringcontains
StringthresholdRules (optional)
criticalVulnerabilitiesaction
Stringthreshold
StringcvssV2Scoreaction
Stringthreshold
StringexploitableVulnerabilitiesaction
Stringthreshold
StringvulnerabilitiesWithMalwareKitsaction
Stringthreshold
StringmoderateVulnerabilitiesaction
Stringthreshold
StringpackageRiskScoreaction
Stringthreshold
StringriskScoreaction
Stringthreshold
StringsevereVulnerabilitiesaction
Stringthreshold
StringtotalVulnerabilitiesaction
Stringthreshold
StringtreatWarningsAsErrors (optional)
booleanworkspaceDir (optional)
StringcontentReplaceconfigs (optional)
filePath
StringfileEncoding
Stringconfigs
search
Stringreplace
StringmatchCount
int$class: 'ContinuousReleaseProperties'properties
java.util.Map<java.lang.String, java.lang.String>$class: 'CoordinatorBuilder'executionPlan
class org.jenkinsci.plugins.coordinator.model.TreeNode$class: 'CopadoBuilder'stepName
StringwebhookUrl
Stringapi_key
Stringtimeout
intcopyArtifactsprojectName
The name of the project to copy artifacts from.
Artifacts from all modules will be copied. Enter JOBNAME/MODULENAME here to copy from a particular module; you may copy/paste this from the URL for that module when browsing Jenkins.
Example: MyMavenJob/my.group$MyModule
Artifacts from all configurations will be copied, each into a subdirectory with the name of the configuration as seen in its URL when browsing Jenkins.
Example: If the target directory is given as fromMatrix then the copy could create $WORKSPACE/fromMatrix/label=agentA/dist/mybuild.jar and $WORKSPACE/fromMatrix/label=agentB/dist/mybuild.jar.
To copy from a particular configuration, enter JOBNAME/AXIS=VALUE,.. as seen in the URL for that configuration.
Example: MyMatrixJob/jdk=Java6u17
To copy artifacts from one matrix project to another, use a parameter to select the matching configuration in the source project.
Example: OtherMatrixJob/jdk=$jdk
Use a path consisting of the project name followed by the branch name.
Example: /MyMultibranchProject/MyBranch
Special letters like '/' in branch names should be escaped. You can see the exact name in "Full project name" in job pages of each branch.
Example: ../MyMultibranchProject/feature%2Fnavigation
See the wiki page "How to reference another project by name" for more information.
Stringexcludes (optional)
Stringfilter (optional)
StringfingerprintArtifacts (optional)
booleanflatten (optional)
booleanoptional (optional)
booleanparameters (optional)
Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.
You shouldn't use "Build selector for Copy Artifact" parameters here, as it doesn't preserve compatibility when you upgrade plugins, and doesn't work for builds built before upgrading.
StringresultVariableSuffix (optional)
If not specified, the source project name will be used instead (in all uppercase, and sequences of characters other than A-Z replaced by a single underscore).
Example:
| Source project name | Suffix to be used |
|---|---|
| Project-ABC | PROJECT_ABC |
| tool1-release1.2 | TOOL_RELEASE_ |
Stringselector (optional)
downstreamupstreamProjectName
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
StringupstreamBuildNumber
StringlastWithArtifactslastCompleted$class: 'MultiJobBuildSelector'buildParameterparameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
Stringpermalinkid
String$class: 'PromotedBuildSelector'level
intlatestSavedBuildspecificbuildNumber
StringlastSuccessfulstable (optional)
booleanupstreamallowUpstreamDependencies (optional)
booleanfallbackToLastSuccessful (optional)
booleanupstreamFilterStrategy (optional)
UseGlobalSetting, UseOldest, UseNewestworkspacetarget (optional)
StringcopydstFile (optional)
StringkeepMeta (optional)
booleanrecursive (optional)
booleansrcFile (optional)
String$class: 'CreateBaselineBuilder'outputFile
Path to the file that should be used to store baseline.
File location must be specified as:
StringinputFileOrFolder
Specify input folder/file for creating baseline. It should depend on input type you have selected.
Folder/file location must be specified as:
String$class: 'CreateBuildBuilder'Creates a new build for the selected BuildMaster application and sets the BUILDMASTER_BUILD_NUMBER environment variable with the value returned from BuildMaster for the new build.
If your Jenkins job has produced artifacts to be loaded into BuildMaster, you have the following options. The choice is largely dependent on how you import the build artifacts into BuildMaster:
applicationId
The identifier of the BuildMaster application to trigger the build for.
Options are:
StringreleaseNumber
The BuildMaster release number to trigger the build for. Options are:
The job will fail if there is no active BuildMaster release.
StringdeployToFirstStage (optional)
waitUntilCompleted
booleanprintLogOnFailure (optional)
booleanvariables (optional)
Provide a list of variables to pass to the build.
String$class: 'CreateCustomTaskrun'name
StringgenerateName
Stringnamespace
StringclusterName
Stringworkspaces
name
StringclaimName
Stringparams
name
Stringvalue
StringtaskRef
StringcreateCloudifyEnvCreates a topology from an environment blueprint.
The "Output File" parameter denotes where the new environment's outputs will be written to. Later build steps can inspect this file in order to grab information pertinent to them (such as IP addresses, user names and so forth).
All input fields support standard Jenkins parameters' expansion. For example, the string ${app_name} will be expanded, in runtime, to the value of a build parameter called app_name .
For explanation about the format of the outputs file, refer to the help tooltip for that parameter.
blueprintId (optional)
Unique identifier for the created deployment.
StringcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringdebugOutput (optional)
booleandeploymentId (optional)
Identifies the blueprint to create a deployment off.
StringechoInputs (optional)
booleanechoOutputs (optional)
booleaninputs (optional)
A YAML/JSON containing inputs for the deployment. These inputs will be merged with inputs provided through the " inputs file " parameter.
StringinputsFile (optional)
A path (relative to the workspace root) to a YAML/JSON file containing inputs for the deployment. These inputs will be merged with inputs provided through the " inputs " parameter.
Stringmapping (optional)
If specified, this YAML/JSON will be used to transform a YAML/JSON coming from the "inputs file" parameter. This is useful if the "inputs file" is the result of a different Cloudify environment build.
This parameter must not be provided if "mapping file" is provided.
StringmappingFile (optional)
If specified, this YAML/JSON file will be used to transform a YAML/JSON coming from the "inputs file" parameter. This is useful if the "inputs file" is the result of a different Cloudify environment build.
This parameter must not be provided if "mapping" is provided.
StringoutputFile (optional)
Name of file into which the deployment's outputs and capabilities will be written. The file will be a JSON, adhering to the following format:
{
"outputs": <outputs_dictionary>,
"capabilities": <capabilities_dictionary>
}
StringskipInstall (optional)
install workflow.
booleantenant (optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String$class: 'CreateFingerprint'Create Fingerprints of specified files during a build process
targets
StringtektonCreateRawinput
StringinputType
StringclusterName (optional)
StringenableCatalog (optional)
booleannamespace (optional)
String$class: 'CreateRelease'prefix
StringitemPrefix
StringreleaseName
Stringdescription
Stringstage
Stringowner
Stringperiod
String$class: 'CreateSnapshotBuilder'outputFile
Path to the file that should be used to store snapshots.
File location must be specified as:
StringinputFileOrFolder
Specify input folder/file for creating snapshot. It should depend on input type you have selected.
Folder/file location must be specified as:
StringcreateTagnexusInstanceId
StringtagName
StringtagAttributesJson (optional)
StringtagAttributesPath (optional)
StringcreateTaskartifact (optional)
StringautoUpgradable (optional)
booleanenvironment (optional)
StringoverrideWithDefaultParameters (optional)
booleanparameters (optional)
Stringruntime (optional)
StringruntimeType (optional)
Stringworkspace (optional)
String$class: 'CreateTemplate'cloud
Stringworkspace
StringinstanceTags
StringtemplateName
Stringprovider
Stringdatacenter
Stringfolder
Stringdatastore
StringclaimFilter
StringpolicyName
Stringclaims
String$class: 'CriticalBlockEnd'Release all resources that Critical block start had allocated for this job.
$class: 'CriticalBlockStart'Delimit the beginning of the exclusion zone. All build steps that follow will be managed by exclusion plugin.
$class: 'CucumberSlackBuildStepNotifier'channel
Stringjson
StringhideSuccessfulResults
boolean$class: 'CustomPythonBuilder'home
Stringnature
Stringcommand
StringignoreExitCode
boolean$class: 'CxScanBuilder'credentialsId
StringsastCredentialsId
StringbuildStep
StringteamPath
StringsastEnabled
booleanexclusionsSetting
StringfailBuildOnNewResults
booleanfailBuildOnNewSeverity
StringuseOwnServerCredentials (optional)
booleanserverUrl (optional)
Stringusername (optional)
Stringpassword (optional)
StringisProxy (optional)
booleanconfigAsCode (optional)
booleanprojectName (optional)
StringprojectId (optional)
longgroupId (optional)
Stringpreset (optional)
StringjobStatusOnError (optional)
GLOBAL, FAILURE, UNSTABLEpresetSpecified (optional)
booleanexcludeFolders (optional)
Conversion is done as follows:
fold1, fold2 fold3
is converted to:
!**/fold1/**/*, !**/fold2/**/*, !**/fold3/**/*,
StringfilterPattern (optional)
Example: **/*.java, **/*.html, !**\test\**\XYZ*
Pattern Syntax
A given directory is recursively scanned for all files and directories. Each file/directory is matched against a set of selectors, including special support for matching against filenames with include and exclude patterns. Only files/directories which match at least one pattern of the include pattern list, and don't match any pattern of the exclude pattern list will be placed in the list of files/directories found.
When no list of include patterns is supplied, "**" will be used, which means that everything will be matched. When no list of exclude patterns is supplied, an empty list is used, such that nothing will be excluded. When no selectors are supplied, none are applied.
The filename pattern matching is done as follows: The name to be matched is split up in path segments. A path segment is the name of a directory or file, which is bounded by File.separator ('/' under UNIX, '\' under Windows). For example, "abc/def/ghi/xyz.java" is split up in the segments "abc", "def","ghi" and "xyz.java". The same is done for the pattern against which should be matched.
The segments of the name and the pattern are then matched against each other. When '**' is used for a path segment in the pattern, it matches zero or more path segments of the name.
There is a special case regarding the use of File.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").
Stringincremental (optional)
booleanfullScansScheduled (optional)
booleanfullScanCycle (optional)
intpostScanActionId (optional)
intsourceEncoding (optional)
Stringcomment (optional)
StringskipSCMTriggers (optional)
booleanwaitForResultsEnabled (optional)
booleanvulnerabilityThresholdEnabled (optional)
booleanhighThreshold (optional)
intmediumThreshold (optional)
intlowThreshold (optional)
intosaHighThreshold (optional)
intosaMediumThreshold (optional)
intosaLowThreshold (optional)
intgeneratePdfReport (optional)
booleanenableProjectPolicyEnforcement (optional)
booleanthresholdSettings (optional)
StringvulnerabilityThresholdResult (optional)
StringavoidDuplicateProjectScans (optional)
booleanaddGlobalCommenToBuildCommet (optional)
booleangenerateXmlReport (optional)
booleanhideDebugLogs (optional)
booleanforceScan (optional)
booleancustomFields (optional)
StringdependencyScanConfig (optional)
SASTUserName (optional)
StringdependencyScanExcludeFolders (optional)
StringdependencyScanPatterns (optional)
StringdependencyScannerType (optional)
OSA, SCAfsaVariables (optional)
StringisExploitablePath (optional)
booleanisIncludeSources (optional)
booleanosaArchiveIncludePatterns (optional)
StringosaInstallBeforeScan (optional)
booleanoverrideGlobalConfig (optional)
booleansastCredentialsId (optional)
StringscaAccessControlUrl (optional)
StringscaConfigFile (optional)
StringscaCredentialsId (optional)
StringscaEnvVariables (optional)
StringscaSASTProjectFullPath (optional)
StringscaSASTProjectID (optional)
StringscaSastServerUrl (optional)
StringscaServerUrl (optional)
StringscaTenant (optional)
StringscaWebAppUrl (optional)
StringuseJobLevelSastDetails (optional)
booleanexcludeOpenSourceFolders (optional)
StringincludeOpenSourceFolders (optional)
StringosaArchiveIncludePatterns (optional)
StringosaEnabled (optional)
booleanosaInstallBeforeScan (optional)
booleanthisBuildIncremental (optional)
booleanDASTScanapikey (optional)
Your API key can be found on the Breachlock Platform under
Organization settings > Integrations > Jenkins
class hudson.util.Secretasset (optional)
Select the asset that will be scanned on build.
If the asset you are looking for is missing:
Stringemail (optional)
The email-address you registered on Breachlock Platform.
StringosfBuilderSuiteForSFCCDataImporthostname (optional)
StringtfCredentialsId (optional)
StringocCredentialsId (optional)
StringocVersion (optional)
StringarchiveName (optional)
StringsourcePath (optional)
StringincludePatterns (optional)
includePattern
StringexcludePatterns (optional)
excludePattern
StringimportStrategy (optional)
StringtempDirectory (optional)
String$class: 'DaticalDBBuilder'daticalDBProjectDir
StringdaticalDBServer
StringdaticalDBAction
StringdaticalDBCmdProject
StringdaticalDBExportSQL
StringdaticalDBExportRollbackSQL
StringdaticalDBScriptDir
String$class: 'DebianPackageBuilder'pathToDebian
StringnextVersion
StringgenerateChangelog
booleansignPackage
booleanbuildEvenWhenThereAreNoChanges
booleandebianPbuilderadditionalBuildResults (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.
Stringarchitecture (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.
StringbuildAsTag (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.
booleancomponents (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.
StringdebianDirLocation (optional)
The location of the debian/ directory, relative to workspace root
This may also be set globally
Stringdistribution (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.
StringguessComponents (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"
booleankeyring (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.
StringmirrorSite (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
StringnumberCores (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.
intpristineTarName (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.
StringrunAutomationHubBuildtestSuiteId
StringstartOnly (optional)
booleanuserKeyId (optional)
StringuserKeySecret (optional)
class hudson.util.SecretdotnetNuGetDeletedotnet nuget delete command deletes or unlists a package from the server. For nuget.org, the action is to unlist the package.
apiKeyId (optional)
StringforceEnglishOutput (optional)
booleannoServiceEndpoint (optional)
booleanpackageName (optional)
StringpackageVersion (optional)
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleansource (optional)
https://www.nuget.org, https://www.nuget.org/api/v3, and https://www.nuget.org/api/v2/package. For private feeds, replace the host name (for example, %hostname%/api/v3).
StringspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleanworkDirectory (optional)
String$class: 'DeleteApplication'serverName
StringappName
Stringdomain
StringdeleteCloudifyBlueprintblueprintId (optional)
StringcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
Stringtenant (optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
StringdeleteComponentsnexusInstanceId
StringtagName
StringdeleteCloudifyEnvcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringdebugOutput (optional)
booleandeleteBlueprintIfLast (optional)
If checked, and this is the last environment for the associated blueprint, then also delete the blueprint.
booleandeploymentId (optional)
StringignoreFailure (optional)
If checked, then failures during the removal of the environment will be ignored.
booleanskipUninstall (optional)
uninstall workflow.
booleantenant (optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String$class: 'DeleteEnvironmentBuilder'systemId
intenvironmentName
String$class: 'DeleteRaw'deleteAllStatus
resourceName
StringresourceType (optional)
StringclusterName (optional)
StringresourceName (optional)
String$class: 'DeleteVirtualizeBuilder'serverType
StringserverHost
StringserverName
StringdependencyCheckadditionalArguments (optional)
StringodcInstallation (optional)
StringskipOnScmChange (optional)
booleanskipOnUpstreamChange (optional)
boolean$class: 'DeployApplication'This plugin creates a container on the OpenShift PaaS and deploys the application into the container.
serverName
StringappName
Stringcartridges
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:
Stringdomain
StringgearProfile
StringdeploymentPackage
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.
StringenvironmentVariables
Specify a space delimited list of environment variables (key=value) to be assigned to the application. e.g. LOAD_DATA=true MVN_DEPLOY=true
StringautoScale
booleandeploymentType
GIT, BINARYopenshiftDirectory
String$class: 'DeployBox'id
Stringcloud
Stringworkspace
Stringbox
StringboxVersion
StringinstanceName
Stringprofile
Stringclaims
Stringprovider
Stringlocation
StringinstanceEnvVariable
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
Stringtags
Stringvariables
Stringexpiration
$class: 'AlwaysOn'$class: 'ShutDown'hours
Stringdate
Stringtime
String$class: 'Terminate'hours
Stringdate
Stringtime
StringautoUpdates
StringalternateAction
StringwaitForCompletion
booleanwaitForCompletionTimeout
intboxDeploymentType
StringsamDeploysettings
credentialsId
Stringregion
Strings3Bucket
StringstackName
StringtemplateFile
template.yaml
app/template.json
StringkmsKeyId (optional)
StringoutputTemplateFile (optional)
template-#jobId.yaml by default.
Stringparameters (optional)
key
Stringvalue
StringroleArn (optional)
Strings3Prefix (optional)
Stringtags (optional)
key
Stringvalue
StringcrxDeploypackageIdFilters (optional)
**/*.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.
StringbaseUrls (optional)
username[:password]@ between the scheme and the hostname.
StringacHandling (optional)
Stringautosave (optional)
intbehavior (optional)
StringcredentialsId (optional)
/$username/keys/$fingerprint.
StringdisableForJobTesting (optional)
booleanlocalDirectory (optional)
Stringrecursive (optional)
booleanreplicate (optional)
booleanrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
long$class: 'DeployPromotionBuilder'hosts
com.cloudbees.plugins.deployer.hosts.DeployHost<?, ?>$class: 'DeployScriptBuilder'out
Specify full path to target connection file.
File location must be specified as:
Stringin
Specify path to file that contains SQL script.
File location must be specified as:
StringbuildMasterDeployBuildToStageDeploys (or re-deploys) a build to a particular stage.
Note: that when used in a pipeline step that the applicationId, releaseNumber, and buildNumber fields are required:
buildMasterDeployBuildToStage(applicationId: BUILDMASTER_APPLICATION_ID, releaseNumber: BUILDMASTER_RELEASE_NUMBER, buildNumber: BUILDMASTER_BUILD_NUMBER)
applicationId
The identifier of the BuildMaster application to trigger the build for.
Options are:
StringreleaseNumber
The BuildMaster release number to trigger the build for. Options are:
The job will fail if there is no active BuildMaster release.
StringbuildNumber
The BuildMaster build number to trigger the deployment for.
The must be set to an existing build number. Typically this would be obtained from the output of the createBuild step which populates the BUILDMASTER_BUILD_NUMBER environment variable.
Stringforce (optional)
booleanprintLogOnFailure (optional)
booleanstage (optional)
Optional. If not supplied, the next stage in the pipeline will be used.
Stringvariables (optional)
Set deployment level variables.
StringwaitUntilCompleted (optional)
boolean$class: 'Deployer'stack
StringdryRun
booleanbranch
StringapiKey
StringaddDeployToDashboardenv
StringbuildNumber
String$class: 'DeploymentBuilder'url
StringuserId
Stringpassword
StringenableZipFile
booleanenableAutoDeploy
booleanenableTestCase
testcaseblock
projectname
Stringtestcasename
Stringxpath
String$class: 'DescribeWithParamsBuilder'starter
booleanseparator
Stringexcludes
String$class: 'DescriptionSetterBuilder'This plugin automatically sets a description for the build as a step during building.
A description can be based on the log output (by searching it using a regular expression), or it can be hardcoded.
The description is exposed as DESCRIPTION_SETTER_DESCRIPTION environment variable
regexp
\[INFO\] Uploading project information for [^\s]* ([^\s]*)
Stringdescription
StringsnDevOpsPackagename (optional)
StringartifactsPayload (optional)
StringsnDevOpsArtifactartifactsPayload (optional)
StringdevSpacesCreateazureCredentialsId
StringaksName (optional)
StringkubeconfigId (optional)
StringresourceGroupName (optional)
StringsharedSpaceName (optional)
StringspaceName (optional)
StringsvDeployTestDeploys 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
booleanhost
Stringport
StringmarFilePath
StringtestType
StringtokenCredentialId
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".
Stringsecured
booleansvDeployVirtualServiceDeploys 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
booleanhost
Stringport
StringvseName
StringmarFilesPaths
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
StringtokenCredentialId
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".
Stringsecured
booleansvStartVirtualServiceStarts 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
booleanhost
Stringport
StringvseName
StringvsNames
StringtokenCredentialId
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".
Stringsecured
booleansvStopVirtualServiceStops 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
booleanhost
Stringport
StringvseName
StringvsNames
StringtokenCredentialId
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".
Stringsecured
booleansvUndeployVirtualServiceUndeploys (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
booleanhost
Stringport
StringvseName
StringvsNames
StringtokenCredentialId
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".
Stringsecured
booleanimportDeveloperProfileimportIntoExistingKeychain (optional)
booleankeychainId (optional)
StringkeychainName (optional)
StringkeychainPath (optional)
StringkeychainPwd (optional)
class hudson.util.SecretprofileId (optional)
String$class: 'DiawiUploader'token
StringfileName
StringproxyHost
StringproxyPort
intproxyProtocol
Stringdingtalkrobot
Stringat (optional)
StringatAll (optional)
booleanbtnLayout (optional)
H, Vbtns (optional)
title
StringactionUrl
StringhideAvatar (optional)
booleanmessageUrl (optional)
StringpicUrl (optional)
StringsingleTitle (optional)
StringsingleUrl (optional)
Stringtext (optional)
Stringtitle (optional)
Stringtype (optional)
TEXT, LINK, MARKDOWN, ACTION_CARD$class: 'DistTestingBuilder'The goal of this plugin is to enable a distributed testing of some compiled classes on multiple nodes. Tests are send one by one to nodes in the label specified for the project and run. Test results are saved in the "results" directory in the project workspace. f.e. "TEST-helloword.HelloTest.xml" for the test class "helloworld.HelloTest".
This plugin suppose that all slaves in the specified label have a shared workspace directory. (like NFS)
Only classes in the "Tests classes directory" directory with a file name containing a "test" substring (case insensitive) are automatically found by this plugin and run.
If you enable "Publish JUnit test result report" in the "Post-build Actions" section and type "results/*.xml" you will see test results in the Hudson's web UI.
Only nodes in a label which were specified for this project ("Tie this project to a node") will be used for distributed testing. This label must contain at least 2 nodes.
It's possible let this plugin to compile tests class sources which were checkout from a repository if "Compile tests" checkbox was checked. Remember to provide all necessary libraries needed for compilation.
It's possible to check a "Wait for nodes which are busy" checkbox to wait for other nodes which are busy to be freed.
distLocations
distDir
StringlibLocations
libDir
StringtestDir
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.
StringwaitForNodes
Wait for modes in the label which are now occupied by some other builds. This doesn't wait for nodes which are offline
booleancompileTests
If checked then all source codes in the "Tests classes directory" will be compiled. It's necessary to provide all libraries for compilation. Compiled tests will be saved into the directory "tests".
boolean$class: 'DockerBuilderControl'option
$class: 'DockerBuilderControlOptionProvisionAndStart'cloudName
StringtemplateId
String$class: 'DockerBuilderControlOptionRun'cloudName
Stringimage
StringpullCredentialsId
StringdnsString
Stringnetwork
StringdockerCommand
StringmountsString
StringvolumesFrom
StringenvironmentsString
Stringhostname
Stringuser
StringextraGroupsString
StringmemoryLimit
intmemorySwap
intcpuPeriod
longcpuQuota
longcpuShares
intshmSize
intbindPorts
StringbindAllPorts
booleanprivileged
booleantty
booleanmacAddress
String$class: 'DockerBuilderControlOptionStart'cloudName
StringcontainerId
String$class: 'DockerBuilderControlOptionStop'cloudName
StringcontainerId
Stringremove
boolean$class: 'DockerBuilderControlOptionStopAll'remove
boolean$class: 'DockerBuilderNewTemplate'dockerTemplate
dockerTemplateBase
$class: 'DockerTemplateBase'image
StringbindAllPorts (optional)
booleanbindPorts (optional)
StringcapabilitiesToAddString (optional)
A list of new line separated capabilities.
Each line represents an option for the --cap-add parameter sent to the docker server. Each one must be a known capability "Key" as per the docker documentation.
Please check https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities for further information.
StringcapabilitiesToDropString (optional)
A list of new line separated capabilities.
Each line represents an option for the --cap-drop parameter sent to the docker server. Each one must be a known capability "Key" as per the docker documentation.
Please check https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities for further information.
StringcpuPeriod (optional)
Set the period of CPUs to limit the container’s CPU usage.
The default CPU CFS (Completely Fair Scheduler) period is 100000us.
Consult Docker Run Documentation for further information.
longcpuQuota (optional)
Limits the container’s CPU usage.
The default 0 value allows the container to take 100% of a CPU resource.
Consult Docker Run Documentation for further information.
longcpuShares (optional)
intdevicesString (optional)
StringdnsString (optional)
StringdockerCommand (optional)
StringenvironmentsString (optional)
Zero or more environment variables that are set within the docker container. This is a multi-line text field. Each line must be of the form key=value and specify one variable name and its value.
Note that quotes are not interpreted.
e.g. foo="bar" will result in the quotes being part of foo's value.
Note also that whitespace is easily broken. Editing this field this without first expanding the box to its multi-line form will cause any whitespace within a line to be turned into end of line codes, breaking up the line and thus changing its meaning.
e.g. The single setting:
JENKINS_SLAVE_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
can be (accidentally) turned into three separate settings:
JENKINS_SLAVE_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
thus preventing the configuration from working as was intended.
StringextraDockerLabelsString (optional)
A list of new line separated docker labels to be set on the container, Specified in the form "label_name=value".
This has no effect on Jenkins functionality, and is not related to the labels used by Jenkins to map jobs to agent nodes. These labels are metadata attached to the docker container itself (again, not the jenkins agent), and which can typically be read using the docker inspect command.
This can be useful when using a docker cluster (like docker swarm) to pass information to the scheduler, in conjunction with constraints; or to let other services (portainer, prometheus...) know how they should categorize or otherwise deal with this specific container.
Notes:
StringextraGroupsString (optional)
StringextraHostsString (optional)
Stringhostname (optional)
StringmacAddress (optional)
StringmemoryLimit (optional)
The operator can constrain the memory available to a container. If the host supports swap memory, then the setting can be larger than physical RAM.
When the processes inside the container exceed the memory limit, effects vary depending on your setup, e.g. out of memory errors may occur or the operating system could start killing processes.
Consult Docker Run Documentation for further information.
Note that on most Docker installations, the memory limit will not stop Jenkins/Docker from spawning so many containers that the machines total available memory will be exceeded. However, some Docker installations might be able to constrain the number of containers automatically using the memory limit.
intmemorySwap (optional)
intmountsString (optional)
Stringnetwork (optional)
Stringprivileged (optional)
booleanpullCredentialsId (optional)
StringsecurityOptsString (optional)
A list of new line separated security options.
Each line represents an option for the --security-opt parameter sent to the docker server. The options are in the format key=value.
Please check https://docs.docker.com/engine/reference/run/#security-configuration for further information.
StringshmSize (optional)
inttty (optional)
booleanuser (optional)
StringvolumesFromString (optional)
Stringconnector
For all connection methods, Jenkins will start by triggering a docker run. Then, after this step, there will optionally be more steps to establish the connection. There is currently three alternative ways to connect your Jenkins master to the dynamically provisioned Docker agents.
There are different pros and cons for each connection method. Depending on your environment, choose the one matching your needs. More detailed prerequisites are provided once you select a given method.
docker exec, all by using the Docker API. The agent does not need to be able to reach the master through the network layers to communicate ; all will go through Docker API.
docker run command with the right secret. And the remoting agent will establish the connection with the master through the network. Hence, the agent must be able to access the master through its address and port.
attachentryPointCmdString (optional)
StringjavaExe (optional)
StringjvmArgsString (optional)
Stringuser (optional)
root") will be used if this is left blank.
StringjnlpjnlpLauncher
jnlptunnel
Stringvmargs
StringwebSocket (optional)
booleanworkDirSettings (optional)
disabled
booleanworkDirPath
StringinternalDir
StringfailIfWorkDirIsMissing
booleanentryPointArgumentsString (optional)
StringjenkinsUrl (optional)
Stringuser (optional)
StringsshsshKeyStrategy
$class: 'InjectSSHKey'user
String$class: 'ManuallyConfiguredSSHKey'credentialsId
StringsshHostKeyVerificationStrategy
$class: 'KnownHostsFileKeyVerificationStrategy'Checks the known_hosts file (~/.ssh/known_hosts) for the user Jenkins is executing under, to see if an entry exists that matches the current connection.
This method does not make any updates to the Known Hosts file, instead using the file as a read-only source and expecting someone with suitable access to the appropriate user account on the Jenkins controller to update the file as required, potentially using the ssh hostname command to initiate a connection and update the file appropriately.
$class: 'ManuallyProvidedKeyVerificationStrategy'Checks the key provided by the remote host matches the key set by the user who configured this connection.
key
The SSH key expected for this connection. This key should be in the form `algorithm value` where algorithm is one of ssh-rsa or ssh-dss, and value is the Base 64 encoded content of the key.
String$class: 'ManuallyTrustedKeyVerificationStrategy'Checks the remote key matches the key currently marked as trusted for this host.
Depending on configuration, the key will be automatically trusted for the first connection, or an authorised user will be asked to approve the key. An authorised user will be required to approve any new key that gets presented by the remote host.
requireInitialManualTrust
Require a user with Computer.CONFIGURE permission to authorise the key presented during the first connection to this host before the connection will be allowed to be established.
If this option is not enabled then the key presented on first connection for this host will be automatically trusted and allowed for all subsequent connections without any manual intervention.
boolean$class: 'NonVerifyingKeyVerificationStrategy'Does not perform any verification of the SSH key presented by the remote host, allowing all connections regardless of the key they present.
javaPath (optional)
StringjvmOptions (optional)
StringlaunchTimeoutSeconds (optional)
intmaxNumRetries (optional)
Note: That this field applies first to checks that the SSH port is open for new TCP connections, and secondly to checks that the SSH service that owns the TCP port is accepting SSH connections.
e.g. a value of 3 would mean that (up to) 4 attempts (1 initial attempt plus 3 retries) would be made to check the availability of the TCP port, followed by (up to) 4 attempts (1 initial attempt plus 3 retries) to check the availability of the SSH service itself.
intport (optional)
intprefixStartSlaveCmd (optional)
StringretryWaitTime (optional)
intsuffixStartSlaveCmd (optional)
StringlabelString
StringinstanceCapStr
The maximum number of containers, based on this template, that this provider is allowed to run in total. A negative value, or zero, or 2147483647 all mean "no limit" is imposed on the this template, although the overall cloud instance limit (if any) will still apply.
Note that containers which have not been created by Jenkins are not included in this total.
As an alternative, some Docker setups can also determine the maximum number of containers automatically using memory/cpu constraints.
Stringdisabled (optional)
disabledByChoice (optional)
booleanenabledByChoice (optional)
Note: If problems are encountered then this functionality may be disabled automatically. If that happens then it will be shown here. In this situation, the disabled state is transient and will automatically clear after the stated period has elapsed.
booleanmode (optional)
NORMAL, EXCLUSIVEname (optional)
If blank or just whitespace, a default of "docker" will be used.
StringnodeProperties (optional)
? extends hudson.slaves.NodeProperty<?>pullStrategy (optional)
PULL_ALWAYS, PULL_LATEST, PULL_NEVERpullTimeout (optional)
Note: This overrides the read timeout specified for the cloud, but only for the docker pull operation (as this operation is expected to take longer than most docker operations).
intremoteFs (optional)
StringremoveVolumes (optional)
booleanretentionStrategy (optional)
Specify the strategy when docker containers shall be started and stopped:
idleMinutes
intstopTimeout (optional)
int$class: 'DockerBuilderPublisher'dockerFileDirectory
StringfromRegistry
url
https://index.docker.io/v1/).
StringcredentialsId
Stringcloud
StringtagsString
StringpushOnSuccess
booleanpushCredentialsId
StringcleanImages
booleancleanupWithJenkinsJobDelete
booleannoCache (optional)
--no-cache which disables caching of layers. See the docker build command for more information.
booleanpull (optional)
--pull to pull the latest version of the base image, instead of using the local one. See the docker build command for more information.
boolean$class: 'DockerComposeBuilder'useCustomDockerComposeFile
booleandockerComposeFile
Stringoption
$class: 'ExecuteCommandInsideContainer'privilegedMode
booleanservice
Stringcommand
Stringindex
intworkDir
String$class: 'StartAllServices'$class: 'StartService'service
Stringscale
int$class: 'StopAllServices'$class: 'StopService'service
String$class: 'DockerPullImageBuilder'registry
url
https://index.docker.io/v1/).
StringcredentialsId
Stringimage
StringdockerShellconnector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTY, OKHTTPcredentialsId (optional)
StringreadTimeout (optional)
intcontainerLifecycle (optional)
createContainer (optional)
bindAllPorts (optional)
booleanbindPorts (optional)
Stringcommand (optional)
StringcpuShares (optional)
intcpusetCpus (optional)
StringcpusetMems (optional)
StringdevicesString (optional)
StringdnsString (optional)
StringdockerLabelsString (optional)
Stringentrypoint (optional)
StringenvironmentString (optional)
StringextraHostsString (optional)
Stringhostname (optional)
StringlinksString (optional)
StringmacAddress (optional)
StringmemoryLimit (optional)
longnetworkMode (optional)
Stringprivileged (optional)
booleanrestartPolicy (optional)
policyName
NO, UNLESS_STOPPED, ALWAYS, ON_FAILUREmaximumRetryCount
intshmSize (optional)
longtty (optional)
booleanuser (optional)
StringvolumesFromString (optional)
StringvolumesString (optional)
Stringworkdir (optional)
Stringimage (optional)
StringpullImage (optional)
connector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTY, OKHTTPcredentialsId (optional)
StringreadTimeout (optional)
intcredentialsId (optional)
StringpullStrategy (optional)
PULL_ALWAYS, PULL_ONCE, PULL_LATEST, PULL_NEVERregistriesCreds (optional)
registryAddr
StringcredentialsId
StringremoveContainer (optional)
force (optional)
booleanremoveVolumes (optional)
booleanstopContainer (optional)
connector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTY, OKHTTPcredentialsId (optional)
StringreadTimeout (optional)
inttimeout (optional)
intexecutorScript (optional)
StringlongConnector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTY, OKHTTPcredentialsId (optional)
StringreadTimeout (optional)
intshellScript (optional)
String$class: 'DoktorStep'server
StringmarkdownIncludePatterns
value
StringmarkdownExcludePatterns
value
StringasciidocIncludePatterns
value
StringasciidocExcludePatterns
value
String$class: 'DotNetCoreRunner'targetCode
//Simple Example
public class JenkinsPlugin
{
public static void ScriptMain()
{
Console.WriteLine("Hello World from c#!!!");
}
}
// Complete example
using DotNetTools.Jenkins;
using System;
public class JenkinsPlugin
{
public static void ScriptMain(JenkinsManager manager)
{
Console.WriteLine("Hello World from c#!!!");
manager.SetSessionEnv("PI", Math.PI.ToString());
}
}
public void SetSessionEnv(string key, string value);
public string GetSessionEnv(string key);
StringadditionalPackages
StringdownloadProgetPackageDownload options are:
See Inedo documentation.
feedName
StringgroupName
StringpackageName
Stringversion
StringdownloadFormat
StringdownloadFolder
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}
StringcrxDownloadpackageIds (optional)
StringbaseUrl (optional)
username[:password]@ between the scheme and the hostname.
StringcredentialsId (optional)
/$username/keys/$fingerprint.
StringignoreErrors (optional)
booleanlocalDirectory (optional)
Stringrebuild (optional)
booleanrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
longgoogleStorageDownloadcredentialsId
StringbucketUri
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.
StringlocalDirectory
The local directory that will store the downloaded files. The path specified is considered relative to the build's workspace. Example value:
StringpathPrefix (optional)
The specified prefix will be stripped from all downloaded filenames. Filenames that do not start with this prefix will not be modified. If this prefix does not have a trailing slash, it will be added automatically.
String$class: 'DoxygenBuilder'doxyfilePath
StringinstallationName
StringcontinueOnBuildFailure
booleanunstableIfWarnings
boolean$class: 'DrMemoryBuilder'executable
Stringarguments
StringlogPath
StringtreatFailed
boolean$class: 'DropAllBuilder'changeLogFile (optional)
StringchangeLogParameters (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringinstallationName (optional)
Stringlabels (optional)
StringliquibasePropertiesPath (optional)
Stringpassword (optional)
StringresourceDirectories (optional)
Stringurl (optional)
Stringusername (optional)
String$class: 'DrupalInstanceBuilder'db
Stringroot
Stringprofile
Stringrefresh
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.
booleanupdb
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
booleancomment
booleansql
booleansecurity
booleani18n
booleanroot
Stringlogs
Stringexcept
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.
StringignoresPass
If checked, warnings flagged as ignored will pass.
Note that the ignore system was introduced in Coder 7.x-2.4. This option will be ignored if using an older version of Coder.
boolean$class: 'DrupalTestsBuilder'uri
Stringroot
Stringlogs
StringexceptGroups
Actions, Aggregator, AJAX, Batch API, Block, Blog, Book, Bootstrap, Cache, Color, Comment, Contact, Contextual, Dashboard, Database, DBLog, Entity API, Field API, Field types, Field UI, File, File API, File API (remote), Filter, Form API, Forum, Help, Image, Locale, Mail, Menu, Module, Node, OpenID, Pager, Path, Path API, PHP, Poll, Profile, RDF, Search, Session, Shortcut, SimpleTest, Statistics, Syslog, System, Taxonomy, Theme, Tracker, Translation, Trigger, Update, Update API, Upgrade path, User, XML-RPCMultiple groups can be separated by a comma.
StringexceptClasses
Specify Simpletest classes that should not be tested, for instance 'UserLoginTestCase'.
Multiple classes can be separated by a comma.
String$class: 'ECXCDMBuilder'name
Stringpassword
Stringurl
Stringjob
Stringproduction
booleanmaxWaitTime
int$class: 'EclipseBuckminsterBuilder'installationName
Stringcommands
StringlogLevel
Stringparams
StringtargetPlatformName
StringuserTemp
StringuserOutput
StringuserCommand
StringuserWorkspace
StringglobalPropertiesFile
StringequinoxLauncherArgs
String$class: 'ElasticsearchQueryBuilder'query
StringaboveOrBelow
Stringthreshold
longsince
longunits
String$class: 'EndAnalysisBuildStep'restoreBuildFile
shouldRestore
booleanfolders
StringparentPom
String$class: 'EnvInjectBuilder'propertiesFilePath
StringpropertiesContent
String$class: 'EnvPropagatorBuilder'envVariableString
String$class: 'EnvironmentManagerBuilder'systemId
intenvironmentId
intinstanceId
intcopyToServer
booleannewEnvironmentName
StringserverType
StringserverId
intserverHost
StringserverName
StringcopyDataRepo
booleanrepoType
StringrepoHost
StringrepoPort
intrepoUsername
StringrepoPassword
StringabortOnFailure
boolean$class: 'EnvironmentTagBuilder'credentials
Stringregion
String$class: 'EstimateBuilder'name
Stringtoken
StringarchiveFilePath
StringregWhichIncludedModules
StringreportConfigName
Stringuri
Stringsaasuri
Stringlanguage
StringregexExclude
StringtestOnly
booleanmaxNumberOfViolations
longfailBlockTotalVio
booleanmaxNumberOfBlockerViolations
longfailBlockBlockerVio
booleanmaxNumberOfImportantViolations
longfailBlockImportantVio
booleanmaxNumberOfOptimizationViolations
longfailBlockOptimizationVio
booleanmaxNumberOfWarningViolations
longfailBlockWarningVio
booleanexamTest_ExecutionFileexamName
StringpythonName
StringexamReport
StringsystemConfiguration (optional)
StringclearWorkspace (optional)
booleanjavaOpts (optional)
Stringlogging (optional)
booleanloglevelLibCtrl (optional)
StringloglevelTestCtrl (optional)
StringloglevelTestLogic (optional)
StringpathExecutionFile (optional)
StringpathPCode (optional)
StringpdfMeasureImages (optional)
booleanpdfReport (optional)
booleanpdfReportTemplate (optional)
StringpdfSelectFilter (optional)
StringreportPrefix (optional)
StringtestrunFilter (optional)
name
Stringvalue
StringadminCases
booleanactivateTestcases
booleantimeout (optional)
intexamTest_ModelexamName
StringpythonName
StringexamReport
StringexecutionFile (optional)
StringsystemConfiguration (optional)
StringclearWorkspace (optional)
booleanexamModel (optional)
StringjavaOpts (optional)
Stringlogging (optional)
booleanloglevelLibCtrl (optional)
StringloglevelTestCtrl (optional)
StringloglevelTestLogic (optional)
StringmodelConfiguration (optional)
StringpdfMeasureImages (optional)
booleanpdfReport (optional)
booleanpdfReportTemplate (optional)
StringpdfSelectFilter (optional)
StringreportPrefix (optional)
StringtestrunFilter (optional)
name
Stringvalue
StringadminCases
booleanactivateTestcases
booleantimeout (optional)
int$class: 'ExeBuilder'exeName
StringcmdLineArgs
StringfailBuild
booleanexecuteCerberusCampaigncampaignName
Stringenvironment
Stringbrowser
Stringscreenshot
Stringverbose
StringpageSource
StringseleniumLog
StringtimeOut
Stringretries
Stringpriority
Stringtag
Stringss_p
StringssIp
Stringrobot
StringmanualHost
StringmanualContextRoot
Stringcountry
StringcerberusUrl
StringtimeOutForCampaignExecution
intexecutor
String$class: 'ExecuteCommandAction'command
Stringsearch
StringissueInText
Stringcomment
StringcommentVisibility
StringjobDsladditionalClasspath (optional)
StringadditionalParameters (optional)
java.util.Map<java.lang.String, java.lang.Object>failOnMissingPlugin (optional)
booleanfailOnSeedCollision (optional)
booleanignoreExisting (optional)
booleanignoreMissingFiles (optional)
booleanlookupStrategy (optional)
JENKINS_ROOT, SEED_JOBremovedConfigFilesAction (optional)
Note: when using multiple Job DSL build steps in a single job, set this to "Delete" only for the last Job DSL build step. Otherwise config files may be deleted and re-created. See JENKINS-44142 for details.
IGNORE, DELETEremovedJobAction (optional)
Note: when using multiple Job DSL build steps in a single job, set this to "Delete" or "Disable" only for the last Job DSL build step. Otherwise jobs will be deleted and re-created or disabled and re-enabled and you may lose the job history of generated jobs. See JENKINS-44142 for details.
IGNORE, DISABLE, DELETEremovedViewAction (optional)
Note: when using multiple Job DSL build steps in a single job, set this to "Delete" only for the last Job DSL build step. Otherwise views may be deleted and re-created. See JENKINS-44142 for details.
IGNORE, DELETEsandbox (optional)
booleanscriptText (optional)
Stringtargets (optional)
Scripts are executed in the same order as specified. The execution order of expanded wildcards is unspecified.
StringunstableOnDeprecation (optional)
booleanuseScriptText (optional)
boolean$class: 'ExecuteJobBuilder'jobId
longjobName
StringjobType
StringabortOnFailure
booleanabortOnTimeout
booleantimeoutMinutes
intpublish
booleanprojectId
longbuildId
StringsessionTag
StringappendEnv
booleanexecuteKatalonversion
Stringlocation
StringexecuteArgs
Stringx11Display
StringxvfbConfiguration
StringexecuteKatalonTestOpscredentialsId
StringapiKey
StringserverUrl
StringprojectId
StringplanId
StringexecManrequestType (optional)
StringaltEMConfig (optional)
url
Stringcredentials
Stringbookmark (optional)
name
Stringfolder (optional)
StringexecParams (optional)
list (optional)
key
Stringvalue
StringpostExecute (optional)
action
Stringparams
StringprocessList (optional)
database
Stringproject
Stringprocesses
processPath
Stringfolder
StringrequestName
Stringrequest (optional)
name
StringwaitConfig (optional)
pollInterval
StringmaxRunTime
StringexecuteTestsFromAlmOctane| Mode | Explanation |
| Execute suite runs in ALM Octane | Execute suites according to specified suite IDs. New suite runs will be created and executed in ALM Octane. Jenkins job is finished after triggering the suite runs. The job does not wait until the suite runs are finished. This method is useful if you want to schedule suite execution in ALM Octane. By default, newly created suite runs will have name of suite and will be assigned to default release. In order to override this default behaviour, add following parameters (one or more) to job with your desired values:
|
| Get tests from suites and trigger execution jobs | Get tests from suites and trigger execution jobs : Get tests from specified suite IDs. (This method assumes that tests are assigned to test runner jobs from the current Jenkins.) Tests are send to execution by their assigned test runner jobs. The main job is finished after the test runner jobs are finished. This method is useful if you intend to add your job to the ALM Octane Pipeline module. |
configurationId
StringworkspaceId
StringexecutionMode
Stringids
StringexecuteCloudifyWorkflowcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringdebugOutput (optional)
booleandeploymentId (optional)
StringexecutionParameters (optional)
Parameters to pass to the execution, in YAML/JSON format.
StringprintLogs (optional)
booleantenant (optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
StringwaitForCompletion (optional)
booleanworkflowId (optional)
The ID of the workflow to execute.
String$class: 'ExecutorBuildStep'frameworkType
StringrunningType
Stringapp
StringtestApplication
StringdeviceQueries
Other field that can be used:
StringrunTags
StringexecutorOptions
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.
intminDevices
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.
intignoreTestsFile
StringoverallExecTimeout
intcreationTimeout
intexportIpaappURL (optional)
StringarchiveDir (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
StringassetPackManifestURL (optional)
StringcompileBitcode (optional)
booleancopyProvisioningProfile (optional)
booleandevelopmentTeamID (optional)
StringdevelopmentTeamName (optional)
StringdisplayImageURL (optional)
StringfullSizeImageURL (optional)
StringipaExportMethod (optional)
StringipaName (optional)
StringipaOutputDirectory (optional)
StringkeychainId (optional)
StringkeychainName (optional)
StringkeychainPath (optional)
StringkeychainPwd (optional)
class hudson.util.SecretmanualSigning (optional)
booleanpackResourcesAsset (optional)
booleanprovisioningProfiles (optional)
provisioningProfileAppId
StringprovisioningProfileUUID
StringresourcesAssetURL (optional)
StringsigningMethod (optional)
StringstripSwiftSymbols (optional)
booleansymRoot (optional)
Stringthinning (optional)
StringunlockKeychain (optional)
booleanuploadBitcode (optional)
booleanuploadSymbols (optional)
booleanxcodeName (optional)
StringxcodeProjectPath (optional)
StringxcodeSchema (optional)
StringxcodeWorkspaceFile (optional)
StringexportPackagesexportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ExportParametersBuilder'filePath
StringfileFormat
StringkeyPattern
StringuseRegexp
booleanexportProjectsexportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ExporterBuilder'$class: 'ExtensiveTestingBuilder'testPath
Stringlogin
Stringpassword
StringserverUrl
StringprojectName
Stringdebug
booleandownloadFeatureFilesserverAddress
StringprojectKey
StringtargetPath
String$class: 'FeedStatus'prefix
Stringstatus
String$class: 'FigletBuilder'message
StringfileOperationsfileOperations
fileCopyOperationincludes
Stringexcludes
StringtargetLocation
StringflattenFiles
booleanrenameFiles
booleansourceCaptureExpression
StringtargetNameExpression
StringfileCreateOperationfileName
StringfileContent
StringfileDeleteOperationincludes
Stringexcludes
StringfileDownloadOperationurl
StringuserName
Stringpassword
StringtargetLocation
StringtargetFileName
StringproxyHost
StringproxyPort
StringfileJoinOperationsourceFile
StringtargetFile
StringfilePropertiesToJsonOperationsourceFile
StringtargetFile
StringfileRenameOperationsource
Stringdestination
StringfileTransformOperationincludes
Stringexcludes
StringfileUnTarOperationfilePath
StringtargetLocation
StringisGZIP
booleanfileUnZipOperationfilePath
StringtargetLocation
StringfileZipOperationfolderPath
StringoutputFolderPath
StringfolderCopyOperationsourceFolderPath
StringdestinationFolderPath
StringfolderCreateOperationfolderPath
StringfolderDeleteOperationfolderPath
StringfolderRenameOperationsource
Stringdestination
String$class: 'FireLineBuilder'fireLineTarget
csp
If you select "Yes", this plugin will set the following content of CSP to allow access to HTML with JS or CSS.
sandbox allow-scripts; default-src *; style-src * http://* 'unsafe-inline' 'unsafe-eval'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'
Warning:
There is a security risk if you select "Yes".
booleanblockBuild
If there are some questions of block level detected from your project,FireLine plugin will make build fail when you select "Yes".
booleanconfiguration
<?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>
以上配置文件去掉了日志类的规则,所以火线扫描过程中就不会执行日志类规则的检查。
StringreportPath
StringreportFileName
StringbuildWithParameter
可通过配置使用build with parameter插件,在项目构建时灵活使用火线扫描。
例如:在项目配置中设置参数化构建参数。配置boolean类型参数fireline。
则在此输入框中填写${fireline}即可
Stringjdk
JDK to be used for this FireLine analysis.
Tips:
JDK1.7 or 1.8 is compatible with FireLine.
Stringjvm
合理设置JVM参数可以有效提高扫描效率,建议JVM最低配置如下:
"-Xms1g -Xmx1g -XX:MaxPermSize=512m"
String$class: 'FitnesseBuilder'options
java.util.Map<java.lang.String, java.lang.String>$class: 'FixResultBuilder'defaultResultName
Stringsuccess
Stringunstable
Stringfailure
Stringaborted
StringflywayrunnerinstallationName
StringflywayCommand
Stringurl
Stringlocations
StringcommandLineArgs
StringcredentialsId
String$class: 'FogbugzLinkBuilder'frugalTestinguserId
StringtestId
StringrunTag
StringgetJtl
booleanserverUrl (optional)
String$class: 'FtpRenameBuilder'ftpServer
StringftpPort
if you don't specify the port, the default port is 21.
intftpUser
StringftpPassword
class hudson.util.SecretftpPath
Specify the path to your artifact.
StringartifactName (optional)
StringnewArtifactName (optional)
StringremoteDirectory (optional)
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder won't be created if does not exist.
String$class: 'FuzzBuildStep'configurationFilePath
The file path where the test configuration file (*.set or *.testplan) for this job can be found, relative to the project's workspace.
A test configuration file defines what kind of testing is to be done, and can be created using Defensics. Configure a test suite in Defensics and save the settings file in File -> Save Settings.
StringconfigurationOverrides (optional)
Additional test configuration settings that override the settings saved in the test configuration file. This can be useful if, for example, the test target address needs to be set dynamically.
The available settings are the same as the Defensics command line settings. Each setting should follow the format '--setting-name value'. Multiple settings are separated with spaces.
Example for HTTP Server Test Suite:
--uri https://example.com --http-status-filter "1xx 2xx 3xx"
StringdefensicsInstance (optional)
StringsaveResultPackage (optional)
boolean$class: 'FxCopBuilder'toolName
Stringfiles
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 ]
StringoutputXML
FxCop project or XML report output file.
Command Line Argument: /out:[ output file path ]
StringruleSet
Rule set to be used for the analysis.
Command Line Argument: /ruleset:=[ Rule set file path ]
StringignoreGeneratedCode
Suppress analysis results against generated code.
Command Line Argument: /ignoregeneratedcode
booleanforceOutput
Write output XML and project files even in the case where no violations occurred.
Command Line Argument: /forceoutput
booleancmdLineArgs
StringfailBuild
boolean$class: 'GCloudSDKBuilder'command
String$class: 'GCloudSDKWithAuthBuilder'credentialsId
Stringcommand
String$class: 'GatekeeperCommit'commitUsername
String$class: 'GatekeeperMerge'commitUsername
StringreleaseFilePath
StringreleaseFileContentTemplate
String$class: 'GatekeeperPush'gcrImageVulnerabilityScannerimageName (optional)
StringgenexusbgxInstallationId
StringkbPath
StringkbVersion
StringkbEnvironment
StringkbDbCredentialsId
StringforceRebuild
boolean$class: 'GenerateChangeScriptBuilder'in
Specify path to input folder for generating SQL change script. This folder should contain result of previously executed "Run Compare" build step.
Folder location must be specified as:
Stringout
Path to the file that should be used to store SQL change script.
File location must be specified as:
String$class: 'GenerateCreateScriptBuilder'outputFile
Path to the file that should be used to store create SQL script.
File location must be specified as:
StringinputFileOrFolder
Specify input folder/file for generating create SQL script. It should depend on input type you have selected.
Folder/file location must be specified as:
String$class: 'GenerateJenkinsReportBuilder'Generate a HTML report based on a previous schema compare build step. This report is accessible via build detail within build history in Jenkins.
Warning: You can include only one Generate Jenkins HTML comparison report step per project.
inputFolder
Specify path to input folder containing output from "Run Compare" build step.
Folder location must be specified as:
String$class: 'GenerateStandaloneReportBuilder'inputFolder
Specify path to input folder containing output from "Run Compare" build step.
Folder location must be specified as:
StringoutputFolder
Specify path to folder where standalone report will be exported.
Folder location must be specified as:
StringghostInspectorapiKey
StringsuiteId
StringstartUrl
Stringparams
StringgitAutomergercheckoutFromRemote (optional)
booleandetailConflictReport (optional)
booleanlimitAuthorsInDetailReport (optional)
intlimitCommitsInDetailReport (optional)
intlogLevel (optional)
TRACE, DEBUG, INFO, WARN, ERRORmergeRules (optional)
path
Stringresolution
KEEP_OLDER, KEEP_NEWER, MERGE_OLDER_TOP, MERGE_NEWER_TOPreleaseBranchPattern (optional)
StringremoteName (optional)
StringgitbisectjobToRun
StringgoodStartCommit
StringbadEndCommit
StringsearchIdentifier
StringrevisionParameterName
StringretryCount
intcontinuesBuild
booleanminSuccessfulIterations
intoverrideGitCommand
booleangitCommand
StringgitHubPRStatusstatusMessage
content
String$class: 'GitHubSetCommitStatusBuilder'contextSource (optional)
$class: 'DefaultCommitContextSource'$class: 'ManuallyEnteredCommitContextSource'context
StringstatusMessage (optional)
content
String$class: 'GitStatusWrapperBuilder'The gitStatusWrapper builder wraps set of job builders and handles PENDING/SUCCESS/FAILURE git statuses automatically
Check documentation here
buildSteps
hudson.tasks.BuildStep)account (optional)
The GitHub account that owns the repos that contains the commit to notify
Default: If SCM used, plugin will attempt to get details from SCM execution
Check documentation here
StringcredentialsId (optional)
The GitHub credentials, username/password or username/accessToken
Stringdescription (optional)
StringfailureDescription (optional)
The notification description for a failure, it will be displayed by GitHub
Default: value set to description
This field can also be given a regular expression to evaluate on the entire build log. To have the expression evaluated, wrap it with "/". Example: "/^buildVersion=(.*)$/"
Check documentation here
StringgitApiUrl (optional)
If you are a user of GitHub Enterprise use this field to set your custom API endpoint
Default: https://api.github.com
StringgitHubContext (optional)
The git status context key. Keys are used by GitHub to differentiate between notifications
Default: gitStatusWrapper
Check documentation here
Stringrepo (optional)
The GitHub repository that contains the commit to validate, must be owned by the user specified in the account field
Default: If SCM used, plugin will attempt to get details from SCM execution
Check documentation here
Stringsha (optional)
The SHA that identifies the commit to notify
Default: If SCM used, plugin will attempt to get details from SCM execution
Check documentation here
StringsuccessDescription (optional)
The notification description for a success, it will be displayed by GitHub
Default: value set to description
This field can also be given a regular expression to evaluate on the entire build log. To have the expression evaluated, wrap it with "/". Example: "/^buildVersion=(.*)$/"
Check documentation here
StringtargetUrl (optional)
Use this field to specify a custom target URL for the notification
Default: Jenkins build URL
Check documentation here
String$class: 'GitToIspwPublish'app (optional)
StringbranchMapping (optional)
StringconnectionId (optional)
StringcredentialsId (optional)
StringispwConfigPath (optional)
StringruntimeConfig (optional)
Stringstream (optional)
String$class: 'GnatmakeBuilder'gnatName
Stringswitches
StringfileNames
StringmodeSwitches
StringgprbuildinstallationName (optional)
Stringnames (optional)
Stringproj (optional)
-P switch. If not specified, GPRbuild uses the project file default.gpr if there is one in the current working directory. Otherwise, if there is only one project file in the current working directory, GPRbuild uses this project file.
Stringswitches (optional)
StringgradlebuildFile (optional)
StringgradleName (optional)
StringmakeExecutable (optional)
booleanpassAllAsProjectProperties (optional)
booleanpassAllAsSystemProperties (optional)
booleanprojectProperties (optional)
StringrootBuildScriptDir (optional)
Stringswitches (optional)
StringsystemProperties (optional)
Stringtasks (optional)
StringuseWorkspaceAsHome (optional)
Gradle will write to $HOME/.gradle by default for GRADLE_USER_HOME. For a multi-executor agent in Jenkins, setting the environment variable localized files to the workspace avoid collisions accessing gradle cache.
booleanuseWrapper (optional)
booleanwrapperLocation (optional)
StringgradleForesightprojectId
StringcredentialId
StringthundraAgentVersion (optional)
StringthundraGradlePluginVersion (optional)
String$class: 'Groovy'Executes a groovy script.
scriptSource
$class: 'FileScriptSource'scriptFile
String$class: 'StringScriptSource'command
StringgroovyName
Groovy installation which will execute the script. Specify the name of the Groovy installation as specified in the Global Jenkins configuration.
Stringparameters
Parameters for the Groovy executable.
StringscriptParameters
These parameters will be passed to the script.
Stringproperties
Instead of passing properties using the -D parameter you can define them here.
StringjavaOpts
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.
StringclassPath
Specify script classpath here. Each line is one class path item.
String$class: 'GroovyRemoteBuilder'remoteName
Stringscript
StringexamRun_GroovyexamName
Stringscript (optional)
StringstartElement (optional)
StringexamModel (optional)
StringmodelConfiguration (optional)
StringjavaOpts (optional)
Stringtimeout (optional)
intuseStartElement (optional)
boolean$class: 'GsshCommandBuilder'disable
booleanserverInfo
Stringshell
String$class: 'GsshFtpDownloadBuilder'disable
booleanserverInfo
StringremoteFile
StringlocalFolder
StringfileName
String$class: 'GsshFtpUploadBuilder'disable
booleanserverInfo
StringlocalFilePath
StringremoteLocation
StringfileName
String$class: 'GsshShellBuilder'disable
booleanserverInfo
Stringshell
String$class: 'HOTPlayer'project
Stringbundle
class com.arkea.jenkins.openstack.heat.orchestration.template.Bundlehabitattask (optional)
Stringdirectory (optional)
Stringartifact (optional)
Stringchannel (optional)
Stringorigin (optional)
StringbldrUrl (optional)
StringauthToken (optional)
StringlastBuildFile (optional)
Stringformat (optional)
StringsearchString (optional)
Stringcommand (optional)
Stringbinary (optional)
Stringpath (optional)
Stringdocker (optional)
booleanhealthAnalyzerproducts
$class: 'HealthAnalyzerLrStep'checkLrInstallation
booleancheckOsVersion
booleancheckFiles
filesList
field
StringnodePoolHoldduration
Stringreason
String$class: 'HttpRequest'url
StringacceptType (optional)
NOT_SET, TEXT_HTML, TEXT_PLAIN, APPLICATION_FORM, APPLICATION_JSON, APPLICATION_JSON_UTF8, APPLICATION_TAR, APPLICATION_ZIP, APPLICATION_OCTETSTREAMauthentication (optional)
StringconsoleLogResponseBody (optional)
booleancontentType (optional)
NOT_SET, TEXT_HTML, TEXT_PLAIN, APPLICATION_FORM, APPLICATION_JSON, APPLICATION_JSON_UTF8, APPLICATION_TAR, APPLICATION_ZIP, APPLICATION_OCTETSTREAMcustomHeaders (optional)
name
Stringvalue
StringmaskValue
booleanhttpMode (optional)
GET, HEAD, POST, PUT, DELETE, OPTIONS, PATCHhttpProxy (optional)
StringignoreSslErrors (optional)
booleanmultipartName (optional)
StringoutputFile (optional)
StringpassBuildParameters (optional)
booleanproxyAuthentication (optional)
Stringquiet (optional)
booleanrequestBody (optional)
Stringtimeout (optional)
intuploadFile (optional)
StringuseSystemProperties (optional)
booleanvalidResponseCodes (optional)
StringvalidResponseContent (optional)
StringwrapAsMultipart (optional)
booleanhugobaseUrl (optional)
StringbuildFuture (optional)
booleandestination (optional)
Stringenvironment (optional)
StringhugoHome (optional)
Stringverbose (optional)
boolean$class: 'HyperBuilder'image
Stringcommands
StringipythonBuildercode
Eg: print(" Hello Jenkins, from Machine Learning Plugin ...... ! ")
StringfilePath
Eg: /home/alice/iris/ml.py
StringparserType
Stringtask
Eg: Training
StringkernelName
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)
Stringprojects
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.
Stringtestcases
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
Stringtestbed
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
Stringparams
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.
StringparamFile
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.
StringtestReportRequired
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.
booleandbCustomTag
This option enables you to define and assign a value to a custom tag.
Example: Create a tag that holds the build number so that you compare test execution results between builds.
For tests run against build 54322, use: --tag buildNumber=54322
Tip: Use a custom tag to identify executions or groups of executions on the iTest Team Server Test Execution page.
String$class: 'ImportFiles'url
StringcloudTestServerID
Stringfiles
Stringexcludes
Stringmode
StringadditionalOptions
StringimportPackagesimportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
StringimportProjectsimportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'InfluxDBPublisher'userCredentialsID
StringdbUrl
StringdbName
Stringcontent
StringinfluxDbQuerycheckName
StringinfluxQuery
StringexpectedThreshold
doublemarkUnstable (optional)
booleanretryCount (optional)
intretryInterval (optional)
intshowResults (optional)
booleaninsightAppSecregion
StringinsightCredentialsId
StringappId
StringscanConfigId
StringbuildAdvanceIndicator
StringvulnerabilityQuery
vulnerability.severity='HIGH'
StringmaxScanPendingDuration
0d 5h 30m
StringmaxScanExecutionDuration
0d 5h 30m
StringenableScanResults
booleansnInstallAppcredentialsId (optional)
StringapiVersion (optional)
StringappScope (optional)
application system ID is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
StringappSysId (optional)
application scope is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
StringappVersion (optional)
StringbaseAppAutoUpgrade (optional)
booleanbaseAppVersion (optional)
Stringurl (optional)
String$class: 'InstallBuilder'apkFile
StringuninstallFirst
booleanfailOnInstallFailure
booleansnInstanceScancredentialsId (optional)
StringapiVersion (optional)
StringcomboSysId (optional)
StringrequestBody (optional)
StringscanType (optional)
StringsuiteSysId (optional)
StringtargetRecordSysId (optional)
StringtargetTable (optional)
Stringurl (optional)
String$class: 'IqPolicyEvaluatorBuildStep'iqStage
StringiqApplication
manualApplicationapplicationId
StringselectedApplicationapplicationId
StringiqScanPatterns
**/target/*.war or **/target/*.ear. If unspecified, the scan will default to the patterns **/*.jar, **/*.war, **/*.ear, **/*.zip, **/*.tar.gz.
scanPattern
StringiqModuleExcludes
**/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
StringfailBuildOnNetworkError
booleanjobCredentialsId
- none -, otherwise select different credentials.
StringenableDebugLogging
booleanadvancedProperties
key1=value1
key2=value2
StringiqInstanceId (optional)
String$class: 'IspwRestApiRequest'connectionId (optional)
StringconsoleLogResponseBody (optional)
booleancredentialsId (optional)
StringispwAction (optional)
StringispwRequestBody (optional)
StringskipWaitingForSet (optional)
boolean$class: 'IssueFieldUpdateStep'issueSelector (optional)
$class: 'DefaultIssueSelector'$class: 'ExplicitIssueSelector'issueKeys
String$class: 'JqlIssueSelector'jql
String$class: 'P4JobIssueSelector'fieldId (optional)
StringfieldValue (optional)
String$class: 'IssueUpdatesBuilder'restAPIUrl
StringuserName
Stringpassword
Stringjql
StringworkflowActionName
Stringcomment
StringcustomFieldId
StringcustomFieldValue
StringresettingFixedVersions
booleancreateNonExistingFixedVersions
booleanfixedVersions
StringfailIfJqlFails
booleanfailIfNoIssuesReturned
booleanfailIfNoJiraConnection
boolean$class: 'JBossBuilder'operation
value
START_AND_WAIT, START, SHUTDOWN, CHECK_DEPLOYproperties
StringstopOnFailure
booleanserverName
String$class: 'JIRATicketEditor'jiraCredentialsID
StringnewTicketsTemplates
performDuplicateCheck
booleanparentJQL
Stringtitle
Stringtype
Stringpriority
Stringdescription
StringenvVarName
StringfieldValues
fieldHumanReadableName
StringvalueToSet
StringmodifyTicketsTemplates
jqlFilter
StringcommitRegEx
StringticketSource
Stringmodifications
$class: 'AddCommentModification'commentBody
String$class: 'ModifyArrayFieldModification'fieldHumanReadableName
StringmodificationType
StringmodificationValue
String$class: 'PerformTransitionModification'transitionName
Stringcomment
String$class: 'SetFieldModification'fieldHumanReadableName
StringvalueToSet
String$class: 'JIRAVersionEditor'jiraCredentialsID
StringversionModifiactions
versionName
StringreplaceDescription
booleandescriptionText
StringreleaseState
StringfailOnJQL
booleanfailQuery
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
StringexcludePattern
The files to exclude in an Ant-style filter. See javadoc
Example: lib/**/ModuleImportProgressDialog.js
This would omit any file named ModuleImportProgressDialog.js
Stringlogfile
The file to output to in a Checkstyle XML format
Example: target/jslint.xml
Stringarguments
The arguments to pass to JSLint. You can use any arguments that JSLint supports! Be sure, though, to prefix each argument with -D
Example: -Dadsafe=true, -Dcontinue=true
This would activate adsafe and continue
Example: -Dpredef=foo,bar,baz
This would be like having /*global foo,bar,baz*/ at the top of every JavaScript file JSLint runs on.
Example: -Dpredef=foo,bar,baz, -Dmaxlen=80
This would be like having /*global foo,bar,baz*/ at the top of every JavaScript file JSLint runs on. It also sets the maximum length of a line to 80 chars.
The default options we use are:
var defaultOptions = { bitwise: true, eqeqeq: false, immed: false, newcap: false, nomen: false, onevar: false, plusplus: false, regexp: false, rhino: true, undef: true, white: false, forin: true, sub: true, browser: true, laxbreak: true, predef: [ 'Ext', 'jQuery', 'window', '$', 'ActiveXObject', 'SWFObject' ] };
String$class: 'JabberBuilder'builderName
StringvenafiCodeSignWithJarSignertppName
StringcertLabel
StringextraArgs (optional)
This plugin invokes Jarsigner under the hood. Here you can specify extra custom CLI arguments to pass to Jarsigner.
These arguments will be appended to the Jarsigner CLI invocation, and take precedence over any arguments implicitly passed by this plugin.
argument
Stringfile (optional)
The path to the file to be signed.
Either a path or a glob must be given.
Stringglob (optional)
A glob that specifies the files to be signed.
Either a path or a glob must be given.
StringtimestampingServers (optional)
Specifies one or more timestamping authority servers to use during signing. Specifying this is strongly recommended, because it allows signed files to be usable even after the original signing certificate has expired.
If you specify more than one server, then a random one will be used.
Tip: here are some public timestamping authorities that you can use:
address
StringvenafiClientToolsDir (optional)
Specify the path to the directory in which Venafi CodeSign Protect client tools are installed. If not specified, it's autodetected as follows:
StringvenafiVerifyWithJarSignertppName
StringcertLabel
Stringfile (optional)
The path to the file to be verified.
Either a path or a glob must be given.
Stringglob (optional)
A glob that specifies the files to be verified.
Either a path or a glob must be given.
StringvenafiClientToolsDir (optional)
Specify the path to the directory in which Venafi CodeSign Protect client tools are installed. If not specified, it's autodetected as follows:
String$class: 'JbpmUrlResourceBuilder'url
StringprocessId
StringSoapUIPropathToTestrunner
StringpathToProjectFile
Stringenvironment (optional)
StringprojectPassword (optional)
StringtestCase (optional)
StringtestCaseTags (optional)
StringtestSuite (optional)
StringtestSuiteTags (optional)
String$class: 'JigomergeBuilder'source
Stringusername
Stringpassword
StringoneByOne
booleaneager
booleanvalidationScript
StringdryRun
booleanverbose
booleanignoreMergePatterns
StringcommitCommentPrefix
String$class: 'JiraEnvironmentVariableBuilder'Typical usage:
issue in (${JIRA_ISSUES})
issueSelector
$class: 'DefaultIssueSelector'$class: 'ExplicitIssueSelector'issueKeys
String$class: 'JqlIssueSelector'jql
String$class: 'P4JobIssueSelector'$class: 'JiraExtBuildStep'issueStrategy
$class: 'FirstWordOfCommitStrategy'$class: 'FirstWordOfUpstreamCommitStrategy'$class: 'MentionedInCommitStrategy'$class: 'SingleTicketStrategy'issueKey
Stringextensions
$class: 'AddComment'postCommentForEveryCommit
booleancommentText
String$class: 'AddFixVersion'fixVersion
The Fix Version to append. Must exist.
String$class: 'AddLabel'labelName
String$class: 'AddLabelToField'fieldName
StringfieldValue
String$class: 'Transition'transitionName
String$class: 'UpdateField'fieldName
StringfieldValue
String$class: 'JiraIssueUpdateBuilder'jqlSearch
Example:
or (e.g., combined with a Jira Issue Parameter, selecting one issue from a JQL result set):project = JENKINS and fixVersion = "$RELEASE_VERSION" and status not in (Resolved, Closed)
issue = $ISSUE_ID
StringworkflowActionName
Stringcomment
String$class: 'JiraReleaseVersionUpdaterBuilder'jiraProjectKey
Specify the project key. A project key is the all capitals part before the issue number in Jira.
(EXAMPLE-100)
StringjiraRelease
StringjiraDescription
String$class: 'JiraVersionCreatorBuilder'jiraVersion
StringjiraProjectKey
Specify the project key. A project key is the all capitals part before the issue number in Jira.
(EXAMPLE-100)
String$class: 'JobConfigRebrander'$class: 'JobDeleteBuilder'target
String$class: 'JobStrongAuthSimpleBuilder'jobUsers
StringuseGlobalUsers
booleanjobMinAuthUserNum
intuseJobExpireTime
booleanjobExpireTimeInHours
int$class: 'JobcopyBuilder'fromJobName
StringtoJobName
Stringoverwrite
booleanjobcopyOperationList
$class: 'DisableOperation'$class: 'EnableOperation'$class: 'ReplaceOperation'fromStr
StringexpandFromStr
booleantoStr
StringexpandToStr
booleanadditionalFilesetList
includeFile
StringexcludeFile
Stringoverwrite
booleanjobcopyOperationList
$class: 'DisableOperation'$class: 'EnableOperation'$class: 'ReplaceOperation'fromStr
StringexpandFromStr
booleantoStr
StringexpandToStr
boolean$class: 'KanboardTaskFetcher'projectIdentifier
StringtaskReference
StringtaskAttachments (optional)
StringtaskLinks (optional)
String$class: 'KarafBuildStepBuilder'useCustomKaraf
booleankarafHome
Stringflags
specify the port to connect to
-h [host]specify the host to connect to
-u [user]specify the user name
-p [password]specify the password (optional, if not provided, the password is prompted)
-vraise verbosity
-lset client logging level. Set to 0 for ERROR logging and up to 4 for TRACE
-r [attempts]retry connection establishment (up to attempts times)
-d [delay]intra-retry delay (defaults to 2 seconds)
-f [file]read commands from the specified file
-k [keyFile]specify the private keyFile location when using key login, need have BouncyCastle registered as security provider using this flag
-t [timeout]define the client idle timeout
Stringoption
$class: 'KarafCommandFileOption'file
String$class: 'KarafCommandScriptOption'script (optional)
StringunlockMacOSKeychainkeychainId (optional)
StringkeychainName (optional)
StringkeychainPath (optional)
StringkeychainPwd (optional)
class hudson.util.Secret$class: 'KlocworkBuildSpecBuilder'buildSpecConfig
buildCommand
Stringtool
Stringoutput
StringadditionalOpts
StringignoreErrors
boolean$class: 'KlocworkCiBuilder'ciConfig
buildSpec
StringprojectDir
StringcleanupProject
booleanreportFile
StringadditionalOpts
StringincrementalAnalysis
This feature allows for quick, incremental analyses of changed source files to enable pre/post-checkin/commit-like behavior . The goal is that only changed files are analyzed by the Klocwork kwciagent tool to replicate the local analysis developers would perform by using our supported IDE plugins or the command line utility. To enable this behavior, the plugin takes a list of the changed files from the SCM; this enables the system to analyze only the changed files when the workspace isn’t kept. Leave this cleared to analyze the whole project, or, if the workspace is kept, to perform a standard incremental analysis.
The diff file list is the file that contains the changed source files for Klocwork to analyze. All analyzed files must exist in the build specification generated by kwinject.
Note: All files to be analyzed must exist in the build specification.
If using Git, provide the previous commit that Git should perform a "diff" against. The change list between the current commit and the specified previous commit will be added to the diff file list for Klocwork to process by automatically calling "git diff <previous_commit>" during the build. Note: If you are using Git jenkins plugin to obtain source files for you pipeline job be sure to use 'Pipeline script from SCM' and specify the previous commit with the environment variable, 'GIT_PREVIOUS_COMMIT'. Also be aware that the first build in the job won't be able to access GIT_PREVIOUS_COMMIT and the first build will run full CI analysis.
If you are not using Git, or want to manually generate the change list by using Git, select this option. You will need to generate the diff file list by using a custom build-step (or similar). List one changed source file on each line of the file.
booleandifferentialAnalysisConfig
diffType
StringgitPreviousCommit
StringdiffFileList
String$class: 'KlocworkServerAnalysisBuilder'serverConfig
buildSpec
StringtablesDir
StringincrementalAnalysis
booleanignoreCompileErrors
booleanimportConfig
StringadditionalOpts
StringdisableKwdeploy
booleanduplicateFrom (optional)
StringenabledCreateProject (optional)
boolean$class: 'KlocworkServerLoadBuilder'serverConfig (optional)
tablesDir (optional)
StringbuildName (optional)
StringadditionalOpts (optional)
StringreportConfig (optional)
displayChart (optional)
booleanchartHeight (optional)
StringchartWidth (optional)
Stringquery (optional)
String$class: 'KlocworkXSyncBuilder'syncConfig
dryRun
booleanlastSync
StringprojectRegexp
StringstatusAnalyze
booleanstatusIgnore
booleanstatusNotAProblem
booleanstatusFix
booleanstatusFixInNextRelease
booleanstatusFixInLaterRelease
booleanstatusDefer
booleanstatusFilter
booleanadditionalOpts
String$class: 'KmapJenkinsBuilder'username
Stringpassword
StringkmapClient
Stringcategories
Stringteams
Stringusers
StringsendNotifications
booleanpublishOptional
teams
Stringusers
StringsendNotifications
booleanfilePath
StringappName
Stringbundle
Stringversion
Stringdescription
StringiconPath
String$class: 'KojiBuilder'kojiBuild
StringkojiTarget
StringkojiPackage
StringkojiOptions
StringkojiTask
StringkojiScratchBuild
booleankojiScmUrl
StringcfyKubernetesallowNodeRedefinition (optional)
booleanapiKeyCredentialsId (optional)
The ID of the credentials entry that contains the API key.
This parameter is optional; the API key may also be provided through "API options", however this method is preferred.
If provided, then this credentials entry must either be of type "text" or "file". In the latter case, the file is read as-is and the resultant string is used as the API credentials.
StringapiKeyFile (optional)
Path to file, relative to the Jenkins workspace, containing the API key.
This parameter is optional, as the API key may be provided by other means.
StringcaCert (optional)
StringcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringdebugOutput (optional)
booleandefinition (optional)
java.util.Map<java.lang.String, java.lang.Object>definitionAsString (optional)
StringdefinitionFile (optional)
StringdeploymentId (optional)
ID to assign to the created Cloudify deployment. If not provided, one will be randomly generated. You can obtain the deployment ID from the "environment data" output file.
StringechoEnvData (optional)
If checked, then the created environment's data will be printed to the job's log.
booleanechoInputs (optional)
booleanenvDataLocation (optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
StringgcpCredentialsFile (optional)
A YAML/JSON file containing GCP service account details, to use for authentication against GCP.
This parameter is optional, and is only relevant for authenticating against GCP.
If provided, it should follow the same layout as described in the "GCP Credentials ID" parameter.
StringgcpCredentialsId (optional)
The ID of the credentials to be used for authentication against GCP.
This parameter is optional, and is only relevant for authenticating against GCP.
If provided, it should be the ID of either a string-type or file-type credentials entry, with the standard GCP service account YAML/JSON syntax:
{
"type": "...",
"project_id": "...",
"private_key_id": "...",
"private_key": "...",
"client_email": "...",
"client_id": "...",
"auth_uri": "...",
"token_uri": "...",
"auth_provider_x509_cert_url": "...",
"client_x509_cert_url": "..."
}
Stringk8sDebug (optional)
booleank8sMaster (optional)
Stringnamespace (optional)
namespace value in the options field, if exists.
Stringoptions (optional)
java.util.Map<java.lang.String, java.lang.Object>optionsAsString (optional)
StringoptionsFile (optional)
StringskipSslVerification (optional)
booleansslCertFile (optional)
StringsslKeyFile (optional)
Stringtenant (optional)
StringvalidateStatus (optional)
boolean$class: 'KubernetesDeploy'context
configs (optional)
The path patterns for the Kubernetes configurations you want to deploy, in the form of Ant glob syntax.
StringcredentialsType (optional)
Choose how to get the kubeconfig file to authenticate with the Kubernetes cluster management endpoint.
3 options are supported:
~/.kube/config file through an SSH connection to the master node.See also: Configure kubectl
StringdeleteResource (optional)
Whether to delete the resource, if it is true, delete all resources in the config file.
booleandockerCredentials (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringenableConfigSubstitution (optional)
Substitute variables (in the form $VARIABLE or ${VARIABLE}) in the configuration with values from Jenkins environment variables.
This allows you to use dynamic values produced during the build in your Kubernetes configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.
booleankubeConfig (optional)
path (optional)
kubeconfig file path relative to the current Jenkins workspace.
StringkubeconfigId (optional)
StringsecretName (optional)
imagePullSecrets entry. Environment variable substitution are supported for the name input, so you can use available environment variables to construct the name dynamically, e.g., some-secret-$BUILD_NUMBER. The name should be in the pattern [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*, i.e., dot (.) concatenated sequences of hyphen (-) separated alphanumeric words. (See Kubernetes Names)
If left blank, the plugin will generate a name based on the build name.
The secret name will be exposed with the environment variable $KUBERNETES_SECRET_NAME. You can use this in your Kubernetes configuration to reference the updated secret when the "Enable Variable Substitution in Config" option is enabled.
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: nginx
spec:
replicas: 1
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: some.private.registry.domain/nginx
ports:
- containerPort: 80
imagePullSecrets:
- name: $KUBERNETES_SECRET_NAME
Note that once the secret is created, it will only be updated by the plugin. You have to manually delete it when it is not used anymore. If this is a problem, you may use fixed name so every time the job runs, the secret gets updated and no new secret is created.
StringsecretNamespace (optional)
Stringssh (optional)
sshCredentialsId (optional)
StringsshServer (optional)
<host>[:<port>]) of the Kubernetes master node. If port is omitted, the default SSH port 22 will be used.
StringtextCredentials (optional)
certificateAuthorityData (optional)
clusters.cluster.certificate-authority-data value in the kubeconfig file.
StringclientCertificateData (optional)
users.user.client-certificate-data value in the kubeconfig file.
StringclientKeyData (optional)
users.user.client-key-data value in the kubeconfig file.
StringserverUrl (optional)
clusters.cluster.server address in the kubeconfig. Generally, it should start with https://.
StringkubernetesEngineDeploycluster (optional)
StringclusterName (optional)
StringcredentialsId (optional)
Stringlocation (optional)
StringmanifestPattern (optional)
Stringnamespace (optional)
StringprojectId (optional)
StringverboseLogging (optional)
booleanverifyDeployments (optional)
booleanverifyServices (optional)
booleanverifyTimeoutInMinutes (optional)
intzone (optional)
Stringloadcompletetestproject (optional)
Stringtest (optional)
StringactionOnErrors (optional)
StringactionOnWarnings (optional)
StringexecutorVersion (optional)
StringgenerateMHT (optional)
booleangeneratePDF (optional)
booleantimeout (optional)
StringuseTimeout (optional)
booleanleanIXMicroserviceIntelligenceapitoken (optional)
class hudson.util.Secretdependencymanager (optional)
Stringdeploymentstage (optional)
Stringdeploymentversion (optional)
Stringhostname (optional)
Stringjobresultchoice (optional)
Stringlxmanifestpath (optional)
Stringuseleanixconnector (optional)
booleaneventSourceLambdalambdaEventSourceBuildStepVariables
awsRegion
StringfunctionName
StringeventSourceArn
StringawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringfunctionAlias (optional)
StringuseInstanceCredentials (optional)
booleaninvokeLambdalambdaInvokeBuildStepVariables
awsRegion
StringfunctionName
Stringsynchronous
booleanawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringjsonParameters (optional)
envVarName
StringjsonPath (optional)
Stringpayload (optional)
StringuseInstanceCredentials (optional)
booleanpublishLambdalambdaPublishBuildStepVariables
awsRegion
StringfunctionARN
StringfunctionAlias
StringversionDescription
StringawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringuseInstanceCredentials (optional)
booleandeployLambdalambdaUploadBuildStepVariables
awsRegion
StringfunctionName
StringupdateMode
Stringalias (optional)
StringartifactLocation (optional)
StringawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringcreateAlias (optional)
booleandeadLetterQueueArn (optional)
Stringdescription (optional)
StringenableDeadLetterQueue (optional)
booleanenvironmentConfiguration (optional)
environment
key
Stringvalue
StringconfigureEnvironment (optional)
booleankmsArn (optional)
Stringhandler (optional)
StringmemorySize (optional)
Stringpublish (optional)
booleanrole (optional)
Stringruntime (optional)
StringsecurityGroups (optional)
Stringsubnets (optional)
Stringtimeout (optional)
StringuseInstanceCredentials (optional)
boolean$class: 'LeapworkJenkinsBridgeBuilder'leapworkHostname
StringleapworkPort
StringleapworkAccessKey
StringleapworkSchNames
StringleapworkSchIds
StringleapworkDelay (optional)
StringleapworkDoneStatusAs (optional)
StringleapworkReport (optional)
StringleapworkScheduleVariables (optional)
StringleapworkWritePassedFlowKeyFrames (optional)
boolean$class: 'LeiningenBuilder'task
StringsubdirPath
StringcheckETLicenseCheck ECU-TEST license.
Pipelines usage:
checkETLicense(String toolName) : void
checkETLicense('ECU-TEST')
toolName
Stringinstallation (optional)
name
Stringhome
Stringproperties
? extends hudson.tools.ToolProperty<?>timeout (optional)
StringlighthouseReportfile
Stringname (optional)
StringdotnetListPackagedotnet list package command provides a convenient option to list all NuGet package references for a specific project or a solution. You first need to build the project in order to have the assets needed for this command to process.
config (optional)
Stringdeprecated (optional)
booleanframework (optional)
Stringframeworks (optional)
StringframeworksString (optional)
StringhighestMinor (optional)
booleanhighestPatch (optional)
booleanincludePrerelease (optional)
booleanincludeTransitive (optional)
booleanoutdated (optional)
booleanproject (optional)
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleansource (optional)
Stringsources (optional)
StringsourcesString (optional)
StringspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleanverbosity (optional)
StringworkDirectory (optional)
String$class: 'LoadImpactTestRunTask'apiTokenId
StringloadTestId
intcriteriaDelayValue
intcriteriaDelayUnit
StringcriteriaDelayQueueSize
intabortAtFailure
booleanthresholds
metric
Stringoperator
Stringvalue
intresult
StringpollInterval
intlogHttp
booleanlogJson
boolean$class: 'LoadNinjaBuilder'apiKey
StringscenarioId
Stringoeb
errorPassCriteria
Stringodb
durationPassCriteria
String$class: 'LoadPluginBuilder'url
Stringusername
Stringpassword
Stringfile
StringgreettestId
StringcredentialsId
String$class: 'LoadtestBuilder'loadtestBuilderModel
environmentShortName
StringauthToken
StringpresetName
StringloadtestScenario
StringloadtestThresholdParameters
metricType
StringevaluationDirection
StringnumericValue
doubledotnetNuGetLocalsdotnet nuget locals command clears or lists local NuGet resources in the http-request cache, temporary cache, or machine-wide global packages folder.
cacheLocation (optional)
all: Indicates that the specified operation is applied to all cache types: http-request cache, global packages cache, and the temporary cache. global-packages: Indicates that the specified operation is applied only to the global packages cache. The other cache locations aren't affected. http-cache: Indicates that the specified operation is applied only to the http-request cache. The other cache locations aren't affected. temp: Indicates that the specified operation is applied only to the temporary cache. The other cache locations aren't affected. StringforceEnglishOutput (optional)
booleanoperation (optional)
clear: The contents of the cache directories are deleted recursively. The executing user/group must have permission to the files in the cache directories. If not, an error is displayed indicating the files/folders that weren't cleared. list: Displays the path to the specified cache location.Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleanspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleanworkDirectory (optional)
String$class: 'LoginBuilder'credentialsId
StringhubUrl
StringmablrestApiKeyId
StringenvironmentId
StringapplicationId
StringapiBaseUrl (optional)
StringappBaseUrl (optional)
StringcontinueOnMablError (optional)
booleancontinueOnPlanFailure (optional)
booleandisableSslVerification (optional)
booleanlabels (optional)
StringmablBranch (optional)
String$class: 'MailCommandBuilder'| POP3 mail server address | Set POP3 mail server's hostname or ip address. |
| POP3 mail server port | Set POP3 mail server's port. Default value is 110. |
| POP3 User Name | Set POP3 mail server's user account. |
| POP3 Password | Set POP3 mail server's password. |
address
Stringport
Stringusername
Stringpassword
String$class: 'MakeAppTouchTestable'url
StringcloudTestServerID
StringinputType
StringprojectFile
Stringtarget
StringlaunchURL
StringbackupModifiedFiles
booleanadditionalOptions
StringjavaOptions
String$class: 'ManageInstance'cloud
Stringworkspace
Stringoperations
? extends com.elasticbox.jenkins.builders.Operation$class: 'MatlabBuilder'matlabRoot (optional)
Note: If the job runs on a remote agent, you must specify the full path to MATLAB root folder on the remote agent.
StringtestRunTypeList (optional)
$class: 'RunTestsAutomaticallyOption'taCoberturaChkBx (optional)
booleantaJunitChkBx (optional)
booleantaModelCoverageChkBx (optional)
booleantaPDFReportChkBx (optional)
booleantaSTMResultsChkBx (optional)
booleantatapChkBx (optional)
boolean$class: 'RunTestsWithCustomCommandOption'customMatlabCommand (optional)
Stringmaventargets
Stringname
Stringpom
Stringproperties
# comment name1=value1 name2=value2These are passed to Maven like "-Dname1=value1 -Dname2=value2"
StringjvmOptions
StringusePrivateRepository
booleansettings
settings.xml file contains elements used to define values which configure Maven execution in various ways, like the pom.xml, but should not be bundled to any specific project, or distributed to an audience. These include values such as the local repository location, alternate remote repository servers, and authentication information.
settings.xml file per default may live:
$M2_HOME/conf/settings.xml${user.home}/.m2/settings.xml see also: settings.xml reference
standardfilePathpath
String$class: 'MvnSettingsProvider'settingsConfigId
StringglobalSettings
standard$class: 'FilePathGlobalSettingsProvider'path
String$class: 'MvnGlobalSettingsProvider'settingsConfigId
StringinjectBuildVariables
boolean$class: 'Maven3Builder'mavenName
StringrootPom
Stringgoals
StringmavenOpts
StringuseWrapper
boolean$class: 'MavenDeploymentDownloader'projectName
StringfilePattern
.*)
StringpermaLink
StringtargetDir
StringstripVersion
booleanstripVersionPattern
StringfailIfNoArtifact
booleancleanTargetDir
boolean$class: 'MavenSealightsBuildStep'beginAnalysis
logLevel
OFF, INFO, DEBUG, WARN, ERRORbuildSessionId
StringappName
StringmoduleName
Stringbranch
StringenableMultipleBuildFiles
booleanoverrideJars
booleanmultipleBuildFiles
booleanlabId
StringtestStage
StringpackagesIncluded
StringpackagesExcluded
StringfilesIncluded
StringfilesExcluded
StringclassLoadersExcluded
Stringrecursive
booleanworkspacepath
StringbuildScannerJar
StringtestListenerJar
StringtestListenerConfigFile
StringautoRestoreBuildFile
booleansealightsMavenPluginInstallationArguments
StringbuildFilesPatterns
StringbuildFilesFolders
StringlogEnabled
booleanlogDestination
CONSOLE, FILElogFolder
StringbuildStrategy
ONE_BUILD, BUILD_EACH_MODULEslMvnPluginVersion
StringbuildName
$class: 'DefaultBuildName'$class: 'EmptyBuildName'$class: 'LatestBuildName'$class: 'ManualBuildName'insertedBuildName
String$class: 'UpstreamBuildName'upstreamProjectName
StringexecutionType
FULL, TESTS_ONLY, ONLY_LISTENERoverride_customerId
Stringoverride_url
Stringoverride_proxy
StringadditionalArguments
| Argument name | Description |
|---|---|
| token | The token provided to you by SeaLights (override the global 'token' value for this build). |
| tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
| buildsessionidfile | Set build session id file for this build. |
| createbuildsessionid | When set to 'true' - forces SeaLights Maven Plugin to create new build session id (true by default). |
| proxy | A valid URL to a proxy server. |
| agentpath | Override the path to SeaLights jar. |
| javapath | Override the path to the 'java' variable (default is 'java'). |
| filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
| sealightsJvmParams | Key value pairs of environments variables which will be added to both buildscanner and test listener ('$$$'- separated pairs, ':'- separated key and value. i.e: sealightsJvmParams=param:value$$$anotherparam:anothervalue) |
| buildScannerParams | Key value pairs of environments variables which will be added to buildscanner ('$$$'- separated pairs, ':'- separated key and value. i.e: buildScannerParams=param:value$$$anotherparam:anothervalue) |
| testListenerJvmParams | Key value pairs of environments variables which will be added to test listener ('$$$'- separated pairs, ':'- separated key and value i.e: testListenerJvmParams=param:value$$$anotherparam:anothervalue) |
StringincludeResources
booleanbuildStepMode
$class: 'DisableSealightsView'targets
String$class: 'InvokeMavenCommandView'targets
String$class: 'OffView'$class: 'PrepareSealightsView'additionalMavenArguments
Stringname
Stringpom
Stringproperties
# comment name1=value1 name2=value2These are passed to Maven like "-Dname1=value1 -Dname2=value2"
StringjvmOptions
StringusePrivateRepository
booleansettings
settings.xml file contains elements used to define values which configure Maven execution in various ways, like the pom.xml, but should not be bundled to any specific project, or distributed to an audience. These include values such as the local repository location, alternate remote repository servers, and authentication information.
settings.xml file per default may live:
$M2_HOME/conf/settings.xml${user.home}/.m2/settings.xml see also: settings.xml reference
standardfilePathpath
String$class: 'MvnSettingsProvider'settingsConfigId
StringglobalSettings
standard$class: 'FilePathGlobalSettingsProvider'path
String$class: 'MvnGlobalSettingsProvider'settingsConfigId
StringmavenSnapshotCheckcheck (optional)
boolean$class: 'MdtoolSolutionBuilder'installationName
StringsolutionPath
Stringtarget
value
Stringconfiguration
value
Stringproject
value
Stringruntime
value
StringredmineMetricsReportsettings (optional)
url
StringapiKey
Specify Redmine API Key which can be found in Redmine's [My Account] -> API access key
If can't find "API access key", Redmine admin needs to enable a setting. "Administration > Settings > Authentication > Enable REST web service".
StringprojectName
Specify Redmine Project's Identifier which you want to generate report for, use Identifier not Name in the Redmine project setting page.
StringcustomQueryId
intsprintSize
Specify the time span(day). e.g.: if you want to generate report on a weekly basis you should specify 7.
int$class: 'MicroDocsChecker'microDocsReportFile
StringmicroDocsProjectName
StringmicroDocsGroupName
StringmicroDocsEnvironments
StringmicroDocsSourceFolder
StringmicroDocsFailBuild
booleanmicroDocsPublish
booleanmicroDocsNotifyPullRequest
booleanminiobucket
Stringincludes
StringcredentialsId (optional)
Stringexcludes (optional)
Stringhost (optional)
StringtargetFolder (optional)
StringminioDeletebucket
Stringfiles
StringcredentialsId (optional)
StringfailOnNonExisting (optional)
booleanhost (optional)
StringminioDownloadbucket
Stringfile
StringcredentialsId (optional)
Stringexcludes (optional)
StringfailOnNonExisting (optional)
booleanhost (optional)
StringtargetFolder (optional)
String$class: 'MobileStudioTestBuilder'mobileStudioRunnerPath
StringtestPath
StringmsgServer (optional)
StringdeviceId (optional)
StringprojectRoot (optional)
StringtestAsUnit (optional)
boolean$class: 'MockLoadBuilder'mock-artifact-*.txt. There will be a JUnit test report with the file name mock-junit.xml. Approximately 5% of the time, the build will "fail" its tests and thus no artifacts will be generated.
averageDuration
long$class: 'ModelBuilder'pushGuardSettings
minBufferSize
StringhubUrls
String$class: 'MonitorRemoteJobBuilder'hostName
StringjobName
StringtimeBefore
StringuserName
Stringpassword
StringuseSSL
boolean$class: 'MonkeyBuilder'filename
StringpackageId
StringeventCount
intthrottleMs
intseed
Stringcategories
StringextraParameters
StringmoveComponentsnexusInstanceId
Stringdestination
Stringsearch (optional)
java.util.Map<java.lang.String, java.lang.String>tagName (optional)
StringmsbuildmsBuildName
StringmsBuildFile
Give the .proj or .sln file from the module root (SCM root directory or workspace directory) that MSBuild will use to build.
You can use build variables through the syntax ${var}.
StringcmdLineArgs
This is a whitespace separated-list of command-line arguments you can specify. These can be the same as if you were to run MSBuild from the command line.
StringbuildVariablesAsProperties
If set to true, Jenkins build variables will be passed to MSBuild as /p:name=value pairs.
Beware : Sensitive build variables such as passwords will not be added.
booleancontinueOnBuildFailure
If set to true, Job will continue despite MSBuild build failure.
booleanunstableIfWarnings
If set to true and warnings on compilation, the build will be unstable.
booleandoNotUseChcpCommand
boolean$class: 'MsBuildSQRunnerBegin'additionalArguments (optional)
StringmsBuildScannerInstallationName (optional)
StringprojectKey (optional)
StringprojectName (optional)
StringprojectVersion (optional)
StringsonarInstallationName (optional)
String$class: 'MsBuildSQRunnerEnd'$class: 'MsTestBuilder'msTestName
StringtestFiles
Specify the path to your MSTest compiled assemblies.
You can specify multiple test assemblies by separating them with new-line.
You can use either relative path to the workspace or full path. Spaces in the path are allowed.
You can use Ant-style filters. i.e - foo/*, foo/**/bar.dll, foo/*.dll
Command Line Argument: /testcontainer
Stringcategories
Optional field, if you do not enter all test will run. If entered specify the test categories to run. You can use logical operators like:
| Cateogry Filter | Result |
| Priority1 | Any test with category Priority1 |
| Priority1&SpeedTest | Test that have both Priority1 and SpeedTest categories |
| Priority1|SpeedTest | Tests that have either Priority1 or SpeedTest categories |
| Priority1&!SpeedTest | Test that have Priority1 category and also do not have SpeedTest category. |
Command Line Argument: /category
StringresultFile
Specify name of the result file to create. The result file will be delete before each run and will be created relative to the workspace directory.
Command Line Argument: /resultsfile
StringcmdLineArgs
StringcontinueOnFail
Specify if the build should fail if a test fail (unchecked) or continue even if a test failed (checked).
boolean$class: 'MultiJobBuilder'phaseName
StringphaseJobs
jobName
StringjobAlias
StringjobProperties
StringcurrParams
booleanconfigs
$class: 'BooleanParameters'configs
name
Stringvalue
boolean$class: 'CurrentBuildParameters'$class: 'FileBuildParameters'propertiesFile
Stringencoding
StringfailTriggerOnMissing
booleanuseMatrixChild
booleancombinationFilter
StringonlyExactRuns
booleantextParamValueOnNewLine
boolean$class: 'GeneratorCurrentParameters'$class: 'GitRevisionBuildParameters'combineQueuedCommits
boolean$class: 'MatrixSubsetBuildParameters'filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggered job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String$class: 'NodeLabelBuildParameter'name
StringnodeLabel
String$class: 'NodeParameters'$class: 'PredefinedBuildParameters'properties
StringtextParamValueOnNewLine
boolean$class: 'PredefinedGeneratorParameters'properties
String$class: 'SubversionRevisionBuildParameters'includeUpstreamParameters
booleankillPhaseOnJobResultCondition
FAILURE, NEVER, UNSTABLEdisableJob
booleanenableRetryStrategy
booleanparsingRulesPath
StringmaxRetries
intenableCondition
booleanabortAllJob
booleancondition
StringbuildOnlyIfSCMChanges
booleanapplyConditionOnlyIfNoSCMChanges
booleanaggregatedTestResults
booleancontinuationCondition
ALWAYS, SUCCESSFUL, COMPLETED, UNSTABLE, FAILUREexecutionType
PARALLEL, SEQUENTIALLYquietPeriodGroovy
StringmavenForesightprojectId
StringcredentialId
StringthundraAgentVersion (optional)
String$class: 'MystBuilder'mystAction
Stringconfig
StringmystWorkspace
Stringproperties
StringmystInstallationName
String$class: 'NISConnection'viewUrl
Stringaddress
Stringport
intprozent
intnpmcommand
StringworkspaceSubdirectory (optional)
StringapiKeyvalidateDnsUrlConnection
booleanapiUrl (optional)
Stringgroup (optional)
StringbinaryName (optional)
Stringdescription (optional)
StringwaitForResults (optional)
booleanwaitMinutes (optional)
intbreakBuildOnScore (optional)
booleanscoreThreshold (optional)
intapiKey (optional)
StringuseBuildEndpoint (optional)
booleanartifactsDir (optional)
Stringdebug (optional)
booleanpassword (optional)
StringproxyEnabled (optional)
booleanshowStatusMessages (optional)
booleanstopTestsForStatusMessage (optional)
Stringusername (optional)
StringvalidateDnsUrlConnectionEnabled (optional)
boolean$class: 'NSiqBuilder'srcDir
StringfileFilter
String$class: 'NantBuilder'nantBuildFile
StringnantName
Stringtargets
Stringproperties
String$class: 'NeoBuildAction'executable
/opt/NeoLoad 6.5/bin/NeoLoadCmd, C:\Program Files\NeoLoad 6.5\bin\NeoLoadCmd.exe or /Applications/NeoLoad 6.5/bin/NeoLoadCmd.
StringprojectType
StringreportType
StringlocalProjectFile
/home/ajohnson/neoload_projects/JenkinsExample/JenkinsExample.nlp, C:\neoload_projects\JenkinsExample\JenkinsExample.nlp or /Users/ajohnson/neoload_projects/JenkinsExample/JenkinsExample.nlp or C:\neoload_projects\JenkinsExample\JenkinsExample.yaml.
StringsharedProjectName
MyProjectName.
StringscenarioName
StringhtmlReport
${WORKSPACE}/neoload-report/report.html.
StringxmlReport
${WORKSPACE}/neoload-report/report.xml.
StringpdfReport
${WORKSPACE}/neoload-report/report.pdf.
StringjunitReport
${WORKSPACE}/neoload-report/junit-sla-results.xml.
StringscanAllBuilds
booleandisplayTheGUI
booleantestResultName
$Date{hh:mm - dd MMM yyyy} is replaced by the current date by NeoLoad and the value ${BUILD_NUMBER} is replaced by the current build number by Jenkins.
$Date{hh:mm - dd MMM yyyy} (build $${BUILD_NUMBER}).
StringtestDescription
StringlicenseType
StringlicenseVUCount
StringlicenseVUSAPCount
StringlicenseDuration
StringcustomCommandLineOptions
StringpublishTestResults
booleansharedProjectServer
uniqueID
Stringurl
StringloginUser
StringloginPassword
class hudson.util.Secretlabel
StringlicenseServer
uniqueID
Stringurl
StringloginUser
StringloginPassword
class hudson.util.Secretlabel
StringcollabPath
StringlicenseID
StringshowTrendAverageResponse
booleanshowTrendErrorRate
booleangraphOptionsInfo
name
Stringcurve
path
Stringstatistic
StringmaxTrends
int$class: 'NerrvanaPlugin'settingsXmlString
Stringloglevel
String$class: 'NetStormBuilder'URLConnectionString
Stringusername
Stringpassword
Stringproject
StringsubProject
Stringscenario
StringtestMode
StringbaselineType
StringpollInterval
Stringprotocol
StringrepoIp
StringrepoPort
StringrepoPath
StringrepoUsername
StringrepoPassword
Stringprofile
Stringscript
Stringpage
StringadvanceSett
StringurlHeader
StringhiddenBox
StringgitPull
StringgenerateReport
booleandoNotWaitForTestCompletion
booleantotalusers
StringrampUpSec
Stringrampupmin
Stringrampuphour
Stringduration
Stringserverhost
Stringsla
StringtestName
StringscriptPath
StringrampupDuration
Stringemailid
StringemailidCC
StringemailidBcc
Stringtestsuite
StringdataDir
StringcheckRuleFileUpload
Stringneuvectorrepository
StringregistrySelection
StringnameOfVulnerabilityToExemptFour (optional)
StringnameOfVulnerabilityToExemptOne (optional)
StringnameOfVulnerabilityToExemptThree (optional)
StringnameOfVulnerabilityToExemptTwo (optional)
StringnameOfVulnerabilityToFailFour (optional)
StringnameOfVulnerabilityToFailOne (optional)
StringnameOfVulnerabilityToFailThree (optional)
StringnameOfVulnerabilityToFailTwo (optional)
StringnumberOfHighSeverityToFail (optional)
StringnumberOfMediumSeverityToFail (optional)
StringscanLayers (optional)
booleanstandaloneScanner (optional)
booleantag (optional)
String$class: 'NexusArtifactUploader'nexusVersion
Stringprotocol
StringnexusUrl
StringgroupId
Stringversion
Stringrepository
StringcredentialsId
Stringartifacts
artifactId
Stringtype
Stringclassifier
Stringfile
String$class: 'NexusPublisherBuildStep'nexusInstanceId
StringnexusRepositoryId
Stringpackages
$class: 'MavenPackage'mavenCoordinate
groupId
StringartifactId
Stringversion
Stringpackaging
StringmavenAssetList
filePath
Stringclassifier
Stringextension
StringtagName (optional)
Stringnirmatabuilder
Delete App in Environment
Deletes the specified application from the specified environment.
Deploy App in Environment
Deploys the specified application from catalog to specified application.
Update App in Catalog
Updates the specified application in specified catalog.
Update App in Environment
Updates the specified application in specified environment.
deleteAppInEnvironmentendpoint
Stringapikey
Stringenvironment
Stringapplication
Stringtimeout
intdeployAppInEnvironmentendpoint
Stringapikey
Stringenvironment
Stringapplication
Stringtimeout
intcatalog
Stringdirectories
Stringincludescheck
booleanincludes
Stringexcludescheck
booleanexcludes
StringdeployType
StringupdateAppInCatalogendpoint
Stringapikey
Stringcatalog
Stringtimeout
intdirectories
Stringincludescheck
booleanincludes
Stringexcludescheck
booleanexcludes
StringupdateAppInEnvironmentendpoint
Stringapikey
Stringenvironment
Stringapplication
Stringtimeout
intdirectories
Stringincludescheck
booleanincludes
Stringexcludescheck
booleanexcludes
Stringnodejscicommand
StringnodeJSInstallationName
StringcacheLocationStrategy (optional)
defaultexecutorworkspaceconfigId (optional)
String$class: 'NopmdCheckPublisher'filesetList
pattern
StringexcludePattern
String$class: 'NotifyEventsBuilder'token
Stringtitle
Stringmessage
Stringpriority
Stringlevel
StringattachBuildLog
booleanattachment
String$class: 'NouvolaBuilder'planID
StringapiKey
StringcredsPass
StringwaitTime
StringreturnURL
StringlistenTimeOut
String$class: 'NucleiBuilder'targetUrl
StringadditionalFlags (optional)
nuclei --help
or visit:StringnucleiVersion (optional)
StringreportingConfiguration (optional)
String$class: 'NvEmulationBuilder'serverName
StringincludeClientIPs
StringexcludeServerIPs
StringreportFiles
StringthresholdsFile
StringuseProxyCheckbox
envVariable
Stringsteps
hudson.tasks.BuildStep)profileNames (optional)
profileName
String$class: 'OOBuildStep'ooServer
Stringbasepath
Default path: /Library
E.g.:
Library/Tutorials/subflows/
Library/Templates
StringselectedFlow
Stringargs
name
Stringvalue
StringretVariableToCheck
StringcomparisonOrdinal
intvalueToCompareWith
StringdesiredResultType
StringstepExecutionTimeout
xxx ms. The plugin will wait for this amount of time, then it will finish the Jenkins job and it will automatically put the build in the fail/unstable state.
StringrunName
StringostorlabScanwaitForResults
booleanriskThreshold
HIGH, MEDIUM, LOW, POTENTIALLY, HARDENINGfilePath (optional)
Stringtitle (optional)
Stringplan (optional)
Stringplatform (optional)
StringwaitMinutes (optional)
intbreakBuildOnScore (optional)
booleanscoreThreshold (optional)
HIGH, MEDIUM, LOW, POTENTIALLY, HARDENINGwaitingForResults (optional)
boolean$class: 'Oak9Builder'orgId (optional)
StringprojectId (optional)
StringcredentialsId (optional)
StringmaxSeverity (optional)
intbaseUrl (optional)
String$class: 'OctoperfBuilder'credentialsId (optional)
StringworkspaceId (optional)
StringprojectId (optional)
StringscenarioId (optional)
StringstopConditions (optional)
? extends org.jenkinsci.plugins.octoperf.conditions.TestStopConditionoctopusPacktoolId
StringpackageId
StringpackageFormat
StringsourcePath
StringadditionalArgs (optional)
StringincludePaths (optional)
StringoutputPath (optional)
StringoverwriteExisting (optional)
booleanpackageVersion (optional)
StringverboseLogging (optional)
booleanoctopusPushBuildInformationserverId
StringspaceId
StringtoolId
StringpackageId
StringpackageVersion
StringcommentParser
StringoverwriteMode
FailIfExists, OverwriteExisting, IgnoreIfExistsadditionalArgs (optional)
StringgitBranch (optional)
StringgitCommit (optional)
StringgitUrl (optional)
StringverboseLogging (optional)
booleanoctopusPushPackageserverId
StringtoolId
StringpackagePaths
StringoverwriteMode
FailIfExists, OverwriteExisting, IgnoreIfExistsadditionalArgs (optional)
StringspaceId (optional)
StringverboseLogging (optional)
booleanOneSkyprojectId (optional)
StringresourcesPath (optional)
String$class: 'OntrackDSLStep'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
booleanignoreFailure
boolean$class: 'OpenShiftBuildVerifier'apiURL
StringbldCfg
Stringnamespace
StringauthToken
Stringverbose
StringcheckForTriggeredDeployments
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftBuilder'apiURL
StringbldCfg
Stringnamespace
Stringenv
name
Stringvalue
StringauthToken
Stringverbose
StringcommitID
StringbuildName
StringshowBuildLogs
StringcheckForTriggeredDeployments
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftCreator'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringjsonyaml
String$class: 'OpenShiftDeleterJsonYaml'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringjsonyaml
String$class: 'OpenShiftDeleterLabels'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringtypes
Stringkeys
Stringvalues
String$class: 'OpenShiftDeleterList'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringtypes
Stringkeys
String$class: 'OpenShiftDeployer'apiURL
StringdepCfg
Stringnamespace
StringauthToken
Stringverbose
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftDeploymentVerifier'apiURL
StringdepCfg
Stringnamespace
StringreplicaCount
StringauthToken
Stringverbose
StringverifyReplicaCount
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftExec'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringpod
Stringcontainer
Stringcommand
Stringarguments
value
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftImageTagger'apiURL
StringtestTag
StringprodTag
Stringnamespace
StringauthToken
Stringverbose
StringtestStream
StringprodStream
StringdestinationNamespace
StringdestinationAuthToken
Stringalias
String$class: 'OpenShiftScaler'apiURL
StringdepCfg
Stringnamespace
StringreplicaCount
StringauthToken
Stringverbose
StringverifyReplicaCount
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftServiceVerifier'apiURL
StringsvcName
Stringnamespace
StringauthToken
Stringverbose
String$class: 'OrchestratorBuilder'serverUrl
StringuserName
Stringpassword
Stringtenant
StringworkflowName
StringwaitExec
booleaninputParams
name
Stringtype
Stringvalue
StringcfyOutputsToInputsThis step maps outputs and capabilities, of an environment created by Cloudify, into inputs of another deployment.
This step takes two inputs:
The format of the mapping JSON is as follows:
{
"outputs": {
"<output_name>": "<input_name>",
"<output_name>": "<input_name>",
...
},
"capabilities": {
"<capability_name>": "<input_name>",
"<capability_name>": "<input_name>",
...
}
}
At the end, a file will be generated, containing a JSON compatible with Cloudify's standard "Deployment Inputs" structure, namely:
{
"<input_name>": "<intput_value>",
"<input_name>": "<intput_value>",
...
For example, if the "outputs file" is as follows:
{
"outputs": {
"endpoint": "10.0.0.130",
"username": "centos"
},
"capabilities": {
"public_key": "/tmp/public_key"
}
}
And the mapping is as follows:
{
"outputs": {
"username": "app_username"
},
"capabilities": {
"public_key": "app_data"
}
}
Then the resultant inputs file will be as follows:
{
"app_username": "centos",
"app_data": "/tmp/public_key"
}
credentialsId (optional)
StringinputsLocation (optional)
Path to the inputs file to be created.
Stringmapping (optional)
A JSON containing mapping between outputs/capabilities and inputs. For information about the structure, refer to the tooltip of this build step.
StringmappingLocation (optional)
A JSON containing mapping between outputs/capabilities and inputs. For information about the structure, refer to the tooltip of this build step.
StringoutputsLocation (optional)
Location of the outputs JSON file, containing outputs and capabilities of another deployment. The file must be in the following format:
{
"outputs": {
"<output_name>": "<output_value>",
"<output_name>": "<output_value>",
...
},
"capabilities": {
"<capability_name>": "<capability_value>",
"<capability_name>": "<capability_value>",
...
}
}
Stringtenant (optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
StringoversecuredUploadapkPath
StringintegrationId
StringdotnetPackdotnet pack command builds the project and creates NuGet packages. The result of this command is a NuGet package (that is, a .nupkg file).
configuration (optional)
Debug, but you can override the build configuration settings in your project.
Stringforce (optional)
booleanincludeSource (optional)
src folder within the symbols package.
booleanincludeSymbols (optional)
booleannoBuild (optional)
booleannoDependencies (optional)
booleannoRestore (optional)
booleannologo (optional)
booleanoption (optional)
Stringoptions (optional)
StringoptionsString (optional)
StringoutputDirectory (optional)
Stringproject (optional)
Stringproperties (optional)
java.util.Map<java.lang.String, java.lang.String>propertiesString (optional)
Stringruntime (optional)
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleanshutDownBuildServers (optional)
dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
hanguntil those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
booleanspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleanunstableIfWarnings (optional)
booleanverbosity (optional)
StringversionSuffix (optional)
$(VersionSuffix) MSBuild property in the project.
StringworkDirectory (optional)
StringuTesterPageCountTaskinitialUrl
StringurlsWhiteList
StringpageCount
intrulesList
rule
StringcomplianceMinimum
floatallowSimultaneousLogins
booleanloginFlowJson
StringuseRunner
booleanfetchResponseTimeout
int$class: 'ParallelTestExecutor'This builder can be used with any test job that (1) produce JUnit-compatible XML files, and (2) accept a test-exclusion list in a file. This builder looks at the test execution time from the last time, and divide tests into multiple units of roughly equal size. Each unit is then converted into the exclusion list (by excluding all but the tests that assigned to that unit), and the test job is triggered for each unit, with the exclusion file placed inside the workspace at your specified location.
Optionally, if your test job supports it, you may provide a test-inclusion file name. If defined, the plugin will generate inclusion lists for all parallel units but one which will still use exclusion list. This avoids new test cases from being included in all units on their first run. If you don't use an inclusion file, when a new test is added, the first build afterward will be executed in all the sub-builds, because it's not in the exclusion list on any of the units.
You are responsible for configuring the build script in the test job to honor the exclusion and inclusion file. A standard technique is to write the build script to always refer to a fixed exclusion list file, and check in an empty file by that name to your SCM. You can then specify that file as the "exclusion file name" in the configuration of this builder, and the builder will overwrite the empty file from SCM by the generated one.
Similarly, you are responsible for checking "Execute concurrent builds if necessary" on the test job to allow the concurrent execution.
At the end of the executions of the test job, the specified report directories are brought back into this job's workspace, then the standard JUnit test report collector will tally them.
parallelism
countsize
inttimeThis value counts just the time spent on executing tests, and not including other time such as checking out the code, building the test, etc. For example, if your test job spends 50 minutes in tests and 60 minutes total from start to finish, then you have 10 minutes "fixed" overhead regardless of the number of tests it executes. If you use this mode and set the value to "10 minutes", then you'll have 5 parallel sub-tasks that all ends in roughly 20 minutes (20 mins = 10 mins tests time + 10 mins overhead.)
"N minutes per a sub-task" is a goal, not a hard constraint. So a sub-task can take longer (for example if you have a single test that takes more than N minutes.)
mins
inttestJob
StringpatternFile
StringtestReportFiles
The path is relative to the workspace of the test job. For Maven builds, this value is normally "**/target/surefire-reports/".
StringarchiveTestResults
booleanparameters
$class: 'BooleanParameters'configs
name
Stringvalue
boolean$class: 'CurrentBuildParameters'$class: 'FileBuildParameters'propertiesFile
Stringencoding
StringfailTriggerOnMissing
booleanuseMatrixChild
booleancombinationFilter
StringonlyExactRuns
booleantextParamValueOnNewLine
boolean$class: 'GeneratorCurrentParameters'$class: 'GitRevisionBuildParameters'combineQueuedCommits
boolean$class: 'MatrixSubsetBuildParameters'filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggered job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String$class: 'NodeLabelBuildParameter'name
StringnodeLabel
String$class: 'NodeParameters'$class: 'PredefinedBuildParameters'properties
StringtextParamValueOnNewLine
boolean$class: 'PredefinedGeneratorParameters'properties
String$class: 'SubversionRevisionBuildParameters'includeUpstreamParameters
booleanestimateTestsFromFiles
booleanincludesPatternFile (optional)
String$class: 'ParameterPoolBuilder'projects
Stringname
Stringvalues
StringpreferError
boolean$class: 'PartialReleaseMgrSuccessfulBuilder'pcBuildserverAndPort
StringpcServerName
StringcredentialsId
StringalmDomain
StringalmProject
StringtestId
StringtestInstanceId
StringautoTestInstanceID
StringtimeslotDurationHours
StringtimeslotDurationMinutes
StringpostRunAction
COLLATE, COLLATE_AND_ANALYZE, DO_NOTHINGvudsMode
booleanstatusBySLA
booleandescription
StringaddRunToTrendReport
StringtrendReportId
StringHTTPSProtocol
booleanproxyOutURL
StringcredentialsProxyId
Stringretry
StringretryDelay
StringretryOccurrences
StringauthenticateWithToken
booleanpcGitBuilddescription
StringpcServerName
StringhttpsProtocol
booleancredentialsId
StringalmDomain
StringalmProject
StringserverAndPort
StringproxyOutURL
StringcredentialsProxyId
StringsubjectTestPlan
StringuploadScriptMode
RUNTIME_FILES, ALL_FILESremoveScriptFromPC
YES, NOimportTests
Note:
| Parameter | Description | Required |
|---|---|---|
| controller |
Defines the Controller to be used during the test run (it must be an available host in the LoadRunner Enterprise project). If not specified, a Controller will be chosen from the different controllers available in the LoadRunner Enterprise project.
From Performance Center 12.62 and plugin version 1.1.1, the option to provision a Controller as a Docker image is available by specifying the value "Elastic" and providing a value for the 'controller_elastic_configuration' parameter (see 'controller_elastic_configuration' table below).
|
No |
| lg_amount | Number of load generators to allocate to the test (every group in the test will be run by the same load generators). | Not required if each group defined in the 'group' parameter defines the load generators it will be using via the 'lg_name' parameter (see 'group' table below). |
| group | Lists all groups or scripts defined in the test. The parameter to be used in each group are specified in the 'group' table below. | Yes |
| scheduler | Defines the duration of a test, and determines whether virtual users are started simultaneously or gradually. See the 'scheduler' table below. | No |
| lg_elastic_configuration | Defines the image to be used in order to provision load generators. See the 'lg_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if a load generator is defined to be provisioned from a Docker image. |
| controller_elastic_configuration | Defines the image to be used in order to provision the Controller. See the 'controller_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if the Controller is defined to be provisioned from a Docker image. |
| Parameter | Description | Required |
|---|---|---|
| group_name | Name of the group (it must be a unique name if several groups are defined). | Yes |
| vusers | Number of virtual users to allocate to the group for running the script. | Yes |
| script_id | ID of the script in the LoadRunner Enterprise project. | Not required if the 'script_path' parameter is specified. |
| script_path | Path and name of the script to be added to the group, separated by double backslashes (\\). For example "MyMainFolder\\MySubFolder\\MyScriptName'. Do not include the LoadRunner Enterprise root folder (named "Subject"). | Not required if 'script_id' parameter is specified |
| lg_name | List of load generators to allocate to the group for running the script. The supported values are:
|
No |
| command_line | The command line applied to the group. | No |
| rts | Object defining the runtime settings of the script. See the 'rts' table below. | No |
| Parameter | Description | Required |
|---|---|---|
| pacing | Can be used to define the number of iterations the script will run and the required delay between iterations (see the 'pacing' table below). | No |
| thinktime | Can be used to define think time (see the 'thinktime' table below). | No |
| java_vm | Can be used when defining Java environment runtime settings (see the 'java_vm' table below). | No |
| jmeter | Can be used to define JMeter environment runtime settings (see the 'jmeter' table below). | No |
| Parameter | Description | Required |
|---|---|---|
| number_of_iterations | Specifies the number of iterations to run; this must be a positive number. | Yes |
| type | Possible values for type attribute are:
|
No |
| delay | Non-negative number (less than 'delay_at_range_to_seconds' when specified). | Depends on the value provided for the 'type' parameter. |
| delay_random_range | Non-negative number. It will be added to the value given to the 'delay' parameter (the value will be randomly chosen between the value given to 'delay' parameter and the same value to which is added the value of this parameter). | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| type | The ThinkTime Type attribute is one of:
|
No |
| min_percentage | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| max_percentage | This must be a positive number (it must be larger than the value provided for the 'min_percentage' parameter). | Depends on the value provided for the 'type' parameter. |
| limit_seconds | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| multiply_factor | The recorded think time is multiplied by this factor at runtime. | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| jdk_home | The JDK installation path. | No |
| java_vm_parameters | List the Java command line parameters. These parameters can be any JVM argument. The common arguments are the debug flag (-verbose) or memory settings (-ms, -mx). In additional, you can also pass properties to Java applications in the form of a -D flag. | No |
| use_xboot | Boolean: Instructs VuGen to add the Classpath before the Xbootclasspath (prepend the string). | No |
| enable_classloader_per_vuser | Boolean: Loads each Virtual User using a dedicated class loader (runs Vusers as threads). | No |
| java_env_class_paths | A list of classpath entries. Use a double backslash (\\) for folder separators. | No |
| Parameter | Description | Required |
|---|---|---|
| start_measurements | Boolean value to enable JMX measurements during performance test execution. | No |
| jmeter_home_path | Path to JMeter home. If not defined, the path from the %JMETER_HOME% environment variable is used. | No |
| jmeter_min_port | This number must be lower than the value provided in the 'jmeter_max_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_max_port | This number must be higher than the value provided in the 'jmeter_min_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_additional_properties | JMeter additional properties file. Use double slash (\\) for folder separator. | No |
| Parameter | Description | Required |
|---|---|---|
| rampup | Time, in seconds, to gradually start all virtual users. Additional virtual users are added every 15 seconds until the time specified in the parameter ends. If no value is specified, all virtual users are started simultaneously at the beginning of the test. | No |
| duration | Time, in seconds, that it will take to run the test after all virtual users are started. After this time, the test run ends. If not specified, the test will run until completion. | No |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if one of the load generator is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if the Controller is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
##################################################
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
Duration: '300'
##################################################
##################################################
controller: "mycontroller"
lg_amount: 3
group:
- group_name: "JavaVuser_LR_Information_pacing_immediately_thinktime_ignore"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "immediately"
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
use_xboot: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "ignore"
- group_name: "JavaHTTP_BigXML_pacing_fixed_delay_thinktime_replay"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed delay"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
thinktime:
type: "replay"
limit_seconds: 30
- group_name: "JavaVuser_LR_Information_immediately_pacing_random_delay_thinktime_modify"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "random delay"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "modify"
limit_seconds: 30
multiply_factor: 2
- group_name: "JavaHTTP_BigXML_pacing_fixed_interval_thinktime_random"
vusers: 50
#script_id: 392
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed interval"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "random"
limit_seconds: 30
min_percentage: 2
max_percentage: 3
- group_name: "JavaHTTP_BigXML_pacing_random_interval"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
- group_name: "Mtours_pacing_random_interval"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
jmeter_home_path: "c:\\jmeter"
jmeter_min_port: 2001
jmeter_max_port: 3001
jmeter_additional_properties: "jmeter_additional_properties"
- group_name: "Mtours_pacing_random_interval_Jmeter_default_port"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
scheduler:
rampup: 120
duration: 600
##################################################
YES, NOauthenticateWithToken
booleanpcRunBuildserverAndPort
StringpcServerName
StringcredentialsId
StringalmDomain
StringalmProject
StringtestToRun
StringtestId
StringtestContentToCreate
The content of the field must either be:
Note:
| Parameter | Description | Required |
|---|---|---|
| test_name | The test name. | Yes |
| test_folder_path | The location of the test in the Test Management folder tree of the LoadRunner Enterprise project. The folders should be separated by double backslashes (\\). For example, "MyMainFolder\\MySubfolder\\MySubSubFolder". Do not include the LoadRunner Enterprise root folder (named "Subject") | Yes |
| test_content | The content of the test that requires additional parameters specified in the 'test_content' table below. | Yes |
| Parameter | Description | Required |
|---|---|---|
| controller |
Defines the Controller to be used during the test run (it must be an available host in the LoadRunner Enterprise project). If not specified, a Controller will be chosen from the different controllers available in the LoadRunner Enterprise project.
From Performance Center 12.62 and plugin version 1.1.1, the option to provision a Controller as a Docker image is available by specifying the value "Elastic" and providing a value for the 'controller_elastic_configuration' parameter (see 'controller_elastic_configuration' table below).
|
No |
| lg_amount | Number of load generators to allocate to the test (every group in the test will be run by the same load generators). | Not required if each group defined in the 'group' parameter defines the load generators it will be using via the 'lg_name' parameter (see 'group' table below). |
| group | Lists all groups or scripts defined in the test. The parameter to be used in each group are specified in the 'group' table below. | Yes |
| scheduler | Defines the duration of a test, and determines whether virtual users are started simultaneously or gradually. See the 'scheduler' table below. | No |
| lg_elastic_configuration | Defines the image to be used in order to provision load generators. See the 'lg_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if a load generator is defined to be provisioned from a Docker image. |
| controller_elastic_configuration | Defines the image to be used in order to provision the Controller. See the 'controller_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if the Controller is defined to be provisioned from a Docker image. |
| Parameter | Description | Required |
|---|---|---|
| group_name | Name of the group (it must be a unique name if several groups are defined). | Yes |
| vusers | Number of virtual users to allocate to the group for running the script. | Yes |
| script_id | ID of the script in the LoadRunner Enterprise project. | Not required if the 'script_path' parameter is specified. |
| script_path | Path and name of the script to be added to the group, separated by double backslashes (\\). For example "MyMainFolder\\MySubFolder\\MyScriptName'. Do not include the LoadRunner Enterprise root folder (named "Subject"). | Not required if 'script_id' parameter is specified |
| lg_name | List of load generators to allocate to the group for running the script. The supported values are:
|
No |
| command_line | The command line applied to the group. | No |
| rts | Object defining the runtime settings of the script. See the 'rts' table below. | No |
| Parameter | Description | Required |
|---|---|---|
| pacing | Can be used to define the number of iterations the script will run and the required delay between iterations (see the 'pacing' table below). | No |
| thinktime | Can be used to define think time (see the 'thinktime' table below). | No |
| java_vm | Can be used when defining Java environment runtime settings (see the 'java_vm' table below). | No |
| jmeter | Can be used to define JMeter environment runtime settings (see the 'jmeter' table below). | No |
| Parameter | Description | Required |
|---|---|---|
| number_of_iterations | Specifies the number of iterations to run; this must be a positive number. | Yes |
| type | Possible values for type attribute are:
|
No |
| delay | Non-negative number (less than 'delay_at_range_to_seconds' when specified). | Depends on the value provided for the 'type' parameter. |
| delay_random_range | Non-negative number. It will be added to the value given to the 'delay' parameter (the value will be randomly chosen between the value given to 'delay' parameter and the same value to which is added the value of this parameter). | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| type | The ThinkTime Type attribute is one of:
|
No |
| min_percentage | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| max_percentage | This must be a positive number (it must be larger than the value provided for the 'min_percentage' parameter). | Depends on the value provided for the 'type' parameter. |
| limit_seconds | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| multiply_factor | The recorded think time is multiplied by this factor at runtime. | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| jdk_home | The JDK installation path. | No |
| java_vm_parameters | List the Java command line parameters. These parameters can be any JVM argument. The common arguments are the debug flag (-verbose) or memory settings (-ms, -mx). In additional, you can also pass properties to Java applications in the form of a -D flag. | No |
| use_xboot | Boolean: Instructs VuGen to add the Classpath before the Xbootclasspath (prepend the string). | No |
| enable_classloader_per_vuser | Boolean: Loads each Virtual User using a dedicated class loader (runs Vusers as threads). | No |
| java_env_class_paths | A list of classpath entries. Use a double backslash (\\) for folder separators. | No |
| Parameter | Description | Required |
|---|---|---|
| start_measurements | Boolean value to enable JMX measurements during performance test execution. | No |
| jmeter_home_path | Path to JMeter home. If not defined, the path from the %JMETER_HOME% environment variable is used. | No |
| jmeter_min_port | This number must be lower than the value provided in the 'jmeter_max_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_max_port | This number must be higher than the value provided in the 'jmeter_min_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_additional_properties | JMeter additional properties file. Use double slash (\\) for folder separator. | No |
| Parameter | Description | Required |
|---|---|---|
| rampup | Time, in seconds, to gradually start all virtual users. Additional virtual users are added every 15 seconds until the time specified in the parameter ends. If no value is specified, all virtual users are started simultaneously at the beginning of the test. | No |
| duration | Time, in seconds, that it will take to run the test after all virtual users are started. After this time, the test run ends. If not specified, the test will run until completion. | No |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if one of the load generator is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if the Controller is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
##################################################
test_name: mytestname
test_folder_path: "Tests\\mytests"
test_content:
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
duration: '300'
##################################################
##################################################
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
duration: '300'
##################################################
##################################################
controller: "mycontroller"
lg_amount: 3
group:
- group_name: "JavaVuser_LR_Information_pacing_immediately_thinktime_ignore"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "immediately"
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
use_xboot: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "ignore"
- group_name: "JavaHTTP_BigXML_pacing_fixed_delay_thinktime_replay"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed delay"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
thinktime:
type: "replay"
limit_seconds: 30
- group_name: "JavaVuser_LR_Information_immediately_pacing_random_delay_thinktime_modify"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "random delay"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "modify"
limit_seconds: 30
multiply_factor: 2
- group_name: "JavaHTTP_BigXML_pacing_fixed_interval_thinktime_random"
vusers: 50
#script_id: 392
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed interval"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "random"
limit_seconds: 30
min_percentage: 2
max_percentage: 3
- group_name: "JavaHTTP_BigXML_pacing_random_interval"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
- group_name: "Mtours_pacing_random_interval"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
jmeter_home_path: "c:\\jmeter"
jmeter_min_port: 2001
jmeter_max_port: 3001
jmeter_additional_properties: "jmeter_additional_properties"
- group_name: "Mtours_pacing_random_interval_Jmeter_default_port"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
scheduler:
rampup: 120
duration: 600
##################################################
StringtestInstanceId
StringautoTestInstanceID
StringtimeslotDurationHours
StringtimeslotDurationMinutes
StringpostRunAction
COLLATE, COLLATE_AND_ANALYZE, DO_NOTHINGvudsMode
booleanstatusBySLA
booleandescription
StringaddRunToTrendReport
StringtrendReportId
StringHTTPSProtocol
booleanproxyOutURL
StringcredentialsProxyId
Stringretry
StringretryDelay
StringretryOccurrences
StringauthenticateWithToken
booleanactivateDTConfigurationdynatraceProfile
Stringconfiguration
StringcreateMemoryDumpdynatraceProfile
Stringagent
Stringhost
StringautoPostProcess (optional)
booleancapturePrimitives (optional)
booleancaptureStrings (optional)
booleandogc (optional)
booleanlockSession (optional)
booleantype (optional)
StringstartSessiondynatraceProfile
StringtestCase
StringlockSession (optional)
booleanrecordingOption (optional)
StringstopSessiondynatraceProfile
StringcreateThreadDumpdynatraceProfile
Stringagent
Stringhost
StringlockSession (optional)
boolean$class: 'PerformanceAnalysisBuilder'testjob
Specify the data set name that contains the mainframe job that you want to run the performance benchmarking for, for example, TEST.POC.JCLLIB(TESTJOB).
The maximum length is 44 characters.
Ensure that the job is included in the monitoring scope of the CA MAT Performance Benchmarking plugin by Broadcom.
StringblazeMeterTestcredentialsId (optional)
StringworkspaceId (optional)
StringtestId (optional)
StringabortJob (optional)
booleanadditionalTestFiles (optional)
StringgetJtl (optional)
booleangetJunit (optional)
booleanjobApiKey (optional)
StringjtlPath (optional)
StringjunitPath (optional)
StringmainTestFile (optional)
Stringnotes (optional)
StringreportLinkName (optional)
StringserverUrl (optional)
StringsessionProperties (optional)
Stringbztparams
StringalwaysUseVirtualenv (optional)
booleanbztVersion (optional)
StringgeneratePerformanceTrend (optional)
booleanprintDebugOutput (optional)
booleanuseBztExitCode (optional)
booleanuseSystemSitePackages (optional)
booleanvirtualEnvCommand (optional)
StringworkingDirectory (optional)
Stringworkspace (optional)
String$class: 'PhingBuilder'name
StringbuildFile
If your build requires a custom -buildfile, specify it here. By default Phing will use the build.xml in the module directory, this option can be used to use build files with a different name or in somewhere outside the top directory.
And you can use environment variables such like ''$WORKSPACE''.
Stringtargets
Stringproperties
# comment name1=value1 name2=value2These are passed to Phing like "-Dname1=value1 -Dname2=value2"
StringuseModuleRoot
booleanoptions
String$class: 'PipelineGenerationStep'project
Name of the project. It is used as an identifier in the corresponding pipelines, folders and jobs being generated.
StringprojectScmType
Type of the SCM. Currently only svn and git are supported.
StringprojectScmUrl
URL to the project SCM. Without any branch indication.
For example:
svn, URL to the root of the project, without trunk or branches. git, URL of the remote.StringprojectScmCredentials
ID or UUID of the Jenkins credentials to use when connecting to the project SCM.
Stringbranch
SCM branch.
StringseedProject
Project name useable for folders, job names, etc.
StringseedBranch
Branch name useable for folders, job names, etc.
StringdisableDslScript
If checked, the pipeline generation disallows the direct execution of a DSL Groovy script. Only DSL libraries, configured through a seed.properties file are allowed. By default, both modes are allowed.
booleanscriptDirectory
Path to the directory which contains the pipeline script. Defaults to seed if not filled.
Stringplotgroup
Stringstyle
StringcsvFileName
StringcsvSeries (optional)
file
Stringurl
StringinclusionFlag
StringexclusionValues
StringdisplayTableFlag
booleandescription (optional)
StringexclZero (optional)
booleankeepRecords (optional)
booleanlogarithmic (optional)
booleannumBuilds (optional)
StringpropertiesSeries (optional)
file
Stringlabel
Stringtitle (optional)
StringuseDescr (optional)
booleanxmlSeries (optional)
file
Stringxpath
StringnodeType
Stringurl
Stringyaxis (optional)
StringyaxisMaximum (optional)
StringyaxisMinimum (optional)
String$class: 'PolarisBuildStep'createChangeSetFile (optional)
Creates a file at $CHANGE_SET_FILE_PATH (by default, the workspace directory) containing a list of files generated from the Jenkins-provided scm changeset.
Used for Incremental analysis (--incremental) as the file containing the list of changed files for analysis.
buildStatusOnSkip (optional)
The action to take when static analysis is skipped because the changeset contained no files to analyze. Defaults to "Mark the build as Unstable".
SUCCESS, FAILURE, UNSTABLEchangeSetExclusionPatterns (optional)
Specify a comma separated list of filename patterns that you would like to explicitly excluded from the Jenkins-provided SCM changeset.
The pattern is applied to determine which files will be populated in the changeset file, stored at $CHANGE_SET_FILE_PATH.
If blank, will exclude none.
Examples:
| File Name | Pattern | Will be excluded |
|---|---|---|
| test.java | *.java | Yes |
| test.java | *.jpg | No |
| test.java | test.* | Yes |
| test.java | test.???? | Yes |
| test.java | test.????? | No |
StringchangeSetInclusionPatterns (optional)
Specify a comma separated list of filename patterns that you would like to explicitly included Jenkins-provided SCM changeset.
The pattern is applied to determine which files will be populated in the changeset file, stored at $CHANGE_SET_FILE_PATH.
If blank, will include all. Examples:
| File Name | Pattern | Will be included |
|---|---|---|
| test.java | *.java | Yes |
| test.java | *.jpg | No |
| test.java | test.* | Yes |
| test.java | test.???? | Yes |
| test.java | test.????? | No |
StringpolarisArguments (optional)
The command line arguments to pass to the CLI
StringpolarisCliName (optional)
The CLI installation to execute
StringwaitForIssues (optional)
Check this box to wait for CLI jobs to complete and set the build status based on issues discovered
buildStatusForIssues (optional)
The build status to set the project to if there are issues
SUCCESS, FAILURE, UNSTABLEjobTimeoutInMinutes (optional)
The maximum number of minutes to wait for jobs started by the Polaris CLI to complete when the Polaris CLI is executed without -w (nonblocking mode). Must be a positive integer, defaults to 30 minutes.
intfortiCWPScannerimageName
Stringblock (optional)
booleanportshift_vulnerability_scanneraccessKey
StringsecretKey
StringimageName
StringimageTag
Stringurl
StringscannerIp
String$class: 'PowerShell'command
StringstopOnError
Stops script when some step fails. Similar to Shell set -e. Translates to $ErrorActionPreference Stop or Continue. See documentation.
booleanuseProfile
Runs script with default profile or no profile. See documentation.
booleanunstableReturn (optional)
int$class: 'PowerShellBuildStep'buildStepId
StringdefineArgs
booleanbuildStepArgs
arg
String$class: 'PreflightBuilder'clientId
StringclientSecret
StringtestId
StringgroupId
StringenvironmentId
Stringplatforms
win-chrome.win-chrome,win-firefoxwinchrome, ie, edge, firefoxStringsizes
1440x900.1920x1080, 1440x9001920x1080, 1440x900, 1024x768, 480x640StringcaptureScreenshots
booleanwaitResults
boolean$class: 'PrereqBuilder'projects
StringwarningOnly
booleanprobelyScantargetId
ID of the target you want Probely to scan.
StringauthToken (optional)
Raw Probely API authentication key.
Please use the credentialsId field instead, unless you understand the security implications of using this mechanism. Passing the API authentication token directly is not advised, unless it is properly secured using a secret storage mechanism, such as HashiCorp Vault.
StringcredentialsId (optional)
Credential identifier for the Probely API authentication key.
StringfailThreshold (optional)
Mark the build as failed if a vulnerability with the following severity level is found.
StringstopIfFailed (optional)
If the build fails because the target is vulnerable, stop scanning for more vulnerabilities.
booleanwaitForScan (optional)
Wait for the scan to complete before proceeding to the next step in the pipeline.
Since a scan can take a long time, the plugin will return as soon as the scan starts. This is enabled by default to make the build faster.
Please note that disabling this option implies that the build step always finishes successfully, even if vulnerabilities are found later on.
Enabling this option allows the plugin to mark the build as failed if it finds any vulnerabilities.
boolean$class: 'ProjectGenerationStep'projectConfig
pipelineConfig
destructor
booleanauthorisations
StringbranchSCMParameter
booleanbranchParameters
StringgenerationExtension
StringpipelineGenerationExtension
StringdisableDslScript
booleanscriptDirectory
StringnamingStrategy
projectFolderPath
StringbranchFolderPath
StringprojectSeedName
StringprojectDestructorName
StringbranchSeedName
StringbranchStartName
StringbranchName
StringignoredBranchPrefixes
StringeventStrategy
delete
booleanauto
booleantrigger
booleancommit
Stringproject
StringscmType
StringscmUrl
StringscmCredentials
StringtriggerIdentifier
StringtriggerType
StringtriggerSecret
String$class: 'ProjectPrerequisitesInstaller'protecodesccredentialsId (optional)
StringprotecodeScGroup (optional)
Group ID can be found from the BDBA service by looking at the URL when browsing an individual group: https://protecode-sc.mydomain.com/group/1234/ or with Groups API https://protecode-sc.mydomain.com/api/groups/.
StringconvertToSummary (optional)
protecodesc.xml.
booleancustomHeader (optional)
StringdirectoryToScan (optional)
StringdontZipFiles (optional)
booleanendAfterSendingFiles (optional)
booleanfailIfVulns (optional)
booleanincludeSubdirectories (optional)
booleanpattern (optional)
StringprotecodeScanName (optional)
StringscanOnlyArtifacts (optional)
booleanscanTimeout (optional)
int$class: 'ProxyBuilder'projectName
StringdotnetPublishdotnet publish compiles the application, reads through its dependencies specified in the project file, and publishes the resulting set of files to a directory. The output includes the following assets:
dotnet publish command's output is ready for deployment to a hosting system (for example, a server, PC, Mac, laptop) for execution. It's the only officially supported way to prepare the application for deployment. Depending on the type of deployment that the project specifies, the hosting system may or may not have the .NET Core shared runtime installed on it. For more information, see Publish .NET Core apps with the .NET Core CLI .
configuration (optional)
Debug, but you can override the build configuration settings in your project.
Stringforce (optional)
booleanframework (optional)
Stringmanifest (optional)
Stringmanifests (optional)
StringmanifestsString (optional)
dotnet store command.
StringnoBuild (optional)
booleannoDependencies (optional)
booleannoRestore (optional)
booleannologo (optional)
booleanoption (optional)
Stringoptions (optional)
StringoptionsString (optional)
StringoutputDirectory (optional)
dotnet publish commands result in nested output folders. For example, if the project folder is myproject, and the publish output folder is myproject/publish, and you run dotnet publish twice, the second run puts content files such as .config and .json files in myproject/publish/publish. To avoid nesting publish folders, specify a publish folder that is not directly under the project folder, or exclude the publish folder from the project.
PublishDir property instead of this option. Stringproject (optional)
Stringproperties (optional)
java.util.Map<java.lang.String, java.lang.String>propertiesString (optional)
dotnet publish:
PublishProfile=Properties\PublishProfiles\profile.pubxml: Use a .pubxml to set publish-related properties. See Visual Studio publish profiles (.pubxml) for ASP.NET Core app deployment for more information. PublishReadyToRun=true: Compiles application assemblies as ReadyToRun (R2R) format. R2R is a form of ahead-of-time (AOT) compilation. For more information, see ReadyToRun images.PublishSingleFile=true: Packages the app into a platform-specific single-file executable. The executable is self-extracting and contains all dependencies (including native) that are required to run the app. When the app is first run, the application is extracted to a directory based on the app name and build identifier. Startup is faster when the application is run again. The application doesn't need to extract itself a second time unless a new version is used.PublishTrimmed=true: Trims unused libraries to reduce the deployment size of an app when publishing a self-contained executable. For more information, see Trim self-contained deployments and executables .PublishProfile, in a publish profile rather than here.
Stringruntime (optional)
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringselfContained (optional)
booleanshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleanshutDownBuildServers (optional)
dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
hanguntil those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
booleanspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleanunstableIfWarnings (optional)
booleanverbosity (optional)
StringversionSuffix (optional)
*) in the version field of the project file.
StringworkDirectory (optional)
StringsnPublishAppcredentialsId (optional)
StringapiVersion (optional)
StringappScope (optional)
application system ID is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
StringappSysId (optional)
application scope is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
StringappVersion (optional)
StringdevNotes (optional)
StringincrementBy (optional)
intisAppCustomization (optional)
booleanobtainVersionAutomatically (optional)
booleanurl (optional)
String$class: 'PublishBuilder'packageid
StringnugetFeedUrl
StringnugetFeedApiKey
class hudson.util.SecretpackageVersion
StringsqlChangeAutomationVersionOption
value
Latest, SpecificspecificVersion
String$class: 'PublishStepBuilder'packageId
StringnugetFeedUrl
StringnugetFeedUrlApi
StringpackageVersion
String$class: 'PullRequestCommenter'comment
StringdotnetNuGetPushdotnet nuget push command pushes a package to the server and publishes it. The push command uses server and credential details found in the system's NuGet config file or chain of config files. For more information on config files, see Configuring NuGet Behavior. NuGet's default configuration is obtained by loading %AppData%\NuGet\NuGet.config (Windows) or $HOME/.local/share (Linux/macOS), then loading any nuget.config or .nuget\nuget.config starting from the root of drive and ending in the current directory.
dotnet pack.
apiKeyId (optional)
StringdisableBuffering (optional)
booleanforceEnglishOutput (optional)
booleannoServiceEndpoint (optional)
booleannoSymbols (optional)
booleanroot (optional)
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleanskipDuplicate (optional)
booleansource (optional)
https://www.nuget.org, https://www.nuget.org/api/v3, and https://www.nuget.org/api/v2/package. For private feeds, replace the host name (for example, %hostname%/api/v3).
DefaultPushSource config value is set in the NuGet config file.
StringspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleansymbolApiKeyId (optional)
StringsymbolSource (optional)
Stringtimeout (optional)
intworkDirectory (optional)
String$class: 'PushBuilder'remoteImageStrategy
DO_NOT_USE, GENERATE_GIT, FIXEDhubUrls
Stringorganization
StringoverwriteOrganization
booleanremoteImageName
StringdateFormat
| y|Y | Year |
| M | Month |
| w | Week in year |
| W | Week in month |
| D | Day in year |
| d | Day in month |
| F | Day of week in month |
| E | Day name in week |
| u | Day number of week (1 = Monday, ..., 7 = Sunday) |
| H | Hour in day (0-23) |
| k | Hour in day (1-24) |
| K | Hour in am/pm (0-11) |
| h | Hour in am/pm (1-12) |
StringappendDate
booleanincrementVersion
boolean$class: 'Python'Runs a Python script (defaults to python interpreter) for building the project. The script will be run with the workspace as the current directory.
command
String$class: 'PythonBuilder'pythonName
Stringnature
Stringcommand
StringignoreExitCode
booleanqualityCloudsScancredentialsId
StringinstanceUrl
StringissuesCountThreshold
inttechDebtThreshold
intqcThreshold
inthighSeverityThreshold
int$class: 'QFTestConfigBuilder'The QF-Test build step. Invokes QF-Test binary during your Jenkins job. If not listed in your PATH variable, the location of the QF-Test binary can be specified explicitly.
The actual test configuration is set via pairs of arguments and suite file fields. The Advanced Test result control button allows to adjust the mapping between the QF-Test result and the Jenkins build result.
All report files that are produced will be stored in an output directory relative to your workspace, whose structure is as follows:
<LOGDIR>
├── html (HTML report directory)
├── junit (junit report directory)
└── qrz (QF-Test runlogs)
The resulting runlogs are automatically declared as Jenkins build artificats and should appear as such on the Jenkins build page. The junit and html reports can be processed further by the junit respectively the publishHTML plugin.
suitefield
suitename
StringcustomParam
StringcustomPath (optional)
StringonTestError (optional)
StringonTestException (optional)
StringonTestFailure (optional)
StringonTestWarning (optional)
StringreportDirectory (optional)
StringreportGenArgs (optional)
String$class: 'QualityCenter'qcClientInstallationName
StringqcQTPAddinInstallationName
StringqcServerURL
qcbin folder of the Quality Center Web application.
StringqcLogin
StringqcPass
StringqcDomain
StringqcProject
StringqcTSFolder
StringqcTSName
StringqcTSLogFile
Name of the report that will be generated.
If several test sets are run in one build step, one report will be generated per test set. As such, you must ensure that the name will be unique by including the test set name in it (through the ${TS_NAME} variable). If it's not the case, then the name will be automatically post fixed with an underscore followed by the test set name.
You can use all standard environment variables plus:
${QC_DOMAIN} for the current Quality Center domain;${QC_PROJECT} for the current Quality Center project;${TS_FOLDER} for the current TestSet folder;${TS_NAME} for the TestSet name.StringqcTimeOut
intrunMode
StringrunHost
StringacrQuickTaskazureCredentialsId
StringresourceGroupName
StringregistryName
Stringarchitecture (optional)
StringbuildArgs (optional)
docker build --build-arg.
key
Stringvalue
Stringsecrecy
booleandockerfile (optional)
StringgitPath (optional)
StringgitRefspec (optional)
StringgitRepo (optional)
https://PAT@github.com/user/repo.git for private repo.
StringimageNames (optional)
image
Stringlocal (optional)
StringnoCache (optional)
no-cache flag when build as docker build --no-cache
booleanos (optional)
StringsourceType (optional)
Stringtarball (optional)
http://remoteserver/myapp.tar.gz
Stringtimeout (optional)
intvariant (optional)
String$class: 'R'Runs an R script (defaults to RScript interpreter) for building the project. The script will be run with the workspace as the current directory.
command
String$class: 'RAD'activateProjectWorkspaceVar
WORKSPACE environment variable through the PROJECT_WORKSPACE one.
WORKSPACE variable during this build step as it doesn't refer to the workspace of the project: It is internally used by RAD.
booleanbuildFile
build.xml one in the project's workspace. The base directory is the workspace.
StringdeleteRadWorkspaceContent
.metadata folder.
booleandeleteRadWorkspaceMetadata
.metadata folder of RAD's workspace has to be removed before RAD is actually run.
booleanproperties
# comment
name1=value1
name2=value2
These are passed to RAD like "-Dname1=value1 -Dname2=value2"
StringradInstallationName
StringradWorkspace
Stringtargets
String$class: 'RPDCreateInstance'pack
StringinstanceName
StringcustomProfile
String$class: 'RPDDeployInstance'instanceName
Stringpack
Stringenvironment
Stringroute
StringcustomProfile
StringuseCustomProfile
boolean$class: 'RTCGitBuilder'serverURI
The Jazz Repository connection URI for the Rational Team Concert (RTC) server
StringcredentialsId
Credentials to use for the build user. A user name and password credential for the Jazz Repository should be configured.
StringannotateChangeLog
Optionally hyperlink bug numbers that appear in git commit descriptions as links to Rational Team Concert Work Items.
booleanbuildDefinition (optional)
The ID of the Hudson/Jenkins build definition within the Rational Team Concert (RTC) server. The build definition should not have any Source Control option.
StringjenkinsRootURI (optional)
StringjenkinsRootURIOverride (optional)
Optionally specify the HTTP address of the Jenkins installation, such as http://yourhost.yourdomain/jenkins/. This is necessary because the Rational Team Concert Git plugin cannot reliably detect such a URL from within itself.
booleantimeout (optional)
The timeout period in seconds for Jazz repository requests made during the build.
inttrackBuildWorkItem (optional)
Specify an Id of a Work Item in Rational Team Concert. The Work Item will be updated with the execution status of the Jenkins build.
StringuseBuildDefinition (optional)
booleanuseTrackBuildWorkItem (optional)
booleanuseWorkItems (optional)
booleanworkItemUpdateType (optional)
StringrabbitMQPublisherrabbitName
Stringexchange
Stringdata
Stringconversion (optional)
booleanroutingKey (optional)
StringtoJson (optional)
boolean$class: 'RadarGunBuilder'radarGunInstance
$class: 'RadarGunCustomInstallation'home
String$class: 'RadarGunInstallationWrapper'radarGunName
StringscenarioSource
$class: 'FileScenarioSource'scenarioPath
String$class: 'TextScenarioSource'scenario
StringnodeSource
$class: 'FileNodeConfigSource'nodeListPath
String$class: 'TextNodeConfigSource'nodes
StringscriptSource
$class: 'BuildInScriptSource'$class: 'FileScriptSource'mainPath
StringworkerPath
String$class: 'TextScriptSource'mainScript
StringworkerScript
StringremoteLoginProgram
StringremoteLogin
StringworkspacePath
StringpluginPath
StringpluginConfigPath
StringreporterPath
String$class: 'Rake'rakeInstallation
StringrakeFile
Stringtasks
StringrakeLibDir
StringrakeWorkingDir
Stringsilent
booleanbundleExec
boolean$class: 'RallyBuild'preRallyState
stateName
StringissueString
StringupdateOnce
booleanpreComment
preCommentText
StringpreReady
preReadyState
booleanchangeReady
issueReady
booleancreateComment
commentText
StringchangeRallyState
issueRallyState
StringchangeDefectRallyState
defectRallyState
StringrancherRedeploycredential
Stringworkload
since endpoint part has bean set in Credential, you only need specify path from "/p/" or "/project", eg:
/project/c-h4hxd:p-c9j8z/workloads/deployment:default:busybox
or /p/c-h4hxd:p-dwqfr/workload/deployment:jenkins:jenkins
Stringimages
nginx;nginx:1.0;myteam/myproject:v2.0;docker.io/team/image:v1.0.${BUILD_NUMBER}
this plugin will update all images in this workload by match the name part exactly, and simply set version part as you specified. so you may need Jenkins variables to dynamic generate new version number.StringalwaysPull
booleanrancherenvironmentId
Stringendpoint
StringcredentialId
Stringservice
Stringimage
Stringconfirm
booleanstartFirst
booleanports
Stringenvironments
Stringtimeout
intranorexcmdLineArgs (optional)
| Flag | Function |
|---|---|
| config | cfg:<config parameter name>=<value> | Set values for configuration parameters. |
| reportlevel | rl: Debug|Info|Warn|Error|Success|Failure|<any integer> | Sets the minimum report level that log messages need to have in order to be included in the log file. Specify 'None' to completely disable reporting. These levels correspond to the following integer values: Debug=10,Info=20,Warn=30,Error=40,Success=110,Failure=120 |
| testcase | tc:<name or guid of test case> | Runs this test case only. |
| testsuite | ts:<path to test suite file> | Runs the test cases defined by the test suite (rxtst) file. By default the rxtst file with the same name as the <TestSuiteExe> is used or the first rxtst file in the same folder as <TestSuiteExe>. |
| module | mo:<module name or guid> | Runs the module with the specified name or guid. Assemblies loaded by <TestSuiteExe> and assemblies referenced in the rxtst file are searched. |
| testcaseparam | tcpa:<name or guid of test case>:<parameter name>=<value> | Creates or overrides values for testcase parameters specified in the test suite. |
| runlabel | rul:<custom value> | Sets a custom runlabel for the test run. |
| testcasedatarange | tcdr:<name or guid of test case>=<data range> | Sets the data range for a testcase. |
StringrxGlobalParameter (optional)
StringrxJUnitReport (optional)
booleanrxReportDirectory (optional)
StringrxReportExtension (optional)
StringrxReportFile (optional)
StringrxRunConfiguration (optional)
StringrxTestRail (optional)
booleanrxTestRailPassword (optional)
StringrxTestRailRID (optional)
StringrxTestRailRunName (optional)
StringrxTestRailUser (optional)
StringrxTestSuiteFilePath (optional)
StringrxZippedReport (optional)
booleanrxZippedReportDirectory (optional)
StringrxZippedReportFile (optional)
String$class: 'RapidDeployJobPlanRunner'serverUrl
StringauthenticationToken
StringjobPlan
StringasynchronousJob
booleanshowIndividualLogs
booleanshowFullLog
boolean$class: 'RapidDeployJobRunner'serverUrl
StringauthenticationToken
Stringproject
Stringtarget
StringpackageName
StringasynchronousJob
booleanshowFullLog
boolean$class: 'RapidDeployPackageBuilder'serverUrl
StringauthenticationToken
Stringproject
StringenableCustomPackageName
booleanpackageName
StringarchiveExtension
String$class: 'RawCliBuilder'changeLogFile (optional)
StringchangeLogParameters (optional)
StringcommandArguments (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringinstallationName (optional)
Stringlabels (optional)
StringliquibasePropertiesPath (optional)
Stringpassword (optional)
StringresourceDirectories (optional)
Stringurl (optional)
Stringusername (optional)
String$class: 'RebaseBuilder'You can rebase from the latest revision in the upstream branch, but you can also do safer rebase by choosing the permalink. For example, if you specify "last stable", then Jenkins will look for the last stable build, then rebase with the corresponding Subversion revision. Thus you know that you are rebasing to the known good state.
If you don't want Jenkins to automatically rebase, you can still use the "Rebase From Upstream" link from the left to manually initiate the rebase.
permalink
StringstopBuildIfMergeFails
booleansetUnstableIfMergeFails
boolean$class: 'RebootIOSDevice'url
StringcloudTestServerID
StringadditionalOptions
String$class: 'ReconfigureBox'id
Stringcloud
Stringworkspace
Stringbox
Stringinstance
Stringvariables
StringbuildStep
StringbuildStepVariables
String$class: 'ReinstallBox'cloud
Stringworkspace
Stringbox
Stringinstance
StringbuildStep
String$class: 'ReleaseMarker'releaseName
Stringservices (optional)
name
StringscopedTo (optional)
applications
name
Stringapplications (optional)
name
StringreleaseEndTimestamp (optional)
StringreleaseStartTimestamp (optional)
StringandroidApkMoveapkFilesPattern (optional)
StringapplicationId (optional)
StringfilesPattern (optional)
StringfromVersionCode (optional)
booleangoogleCredentialsId (optional)
StringinAppUpdatePriority (optional)
StringreleaseName (optional)
StringrolloutPercent (optional)
doublerolloutPercentage (optional)
StringtrackName (optional)
StringversionCodes (optional)
StringaddRelizaReleaseartId (optional)
StringartType (optional)
StringenvSuffix (optional)
StringprojectId (optional)
Stringstatus (optional)
Stringuri (optional)
StringuseCommitList (optional)
Stringversion (optional)
String$class: 'RemoteBuildConfiguration'abortTriggeredJob (optional)
booleanauth2 (optional)
BearerTokenAuthtoken (optional)
class hudson.util.SecretCredentialsAuthcredentials (optional)
StringNoneAuthNullAuthTokenAuthapiToken (optional)
class hudson.util.SecretuserName (optional)
StringblockBuildUntilComplete (optional)
booleandisabled (optional)
booleanenhancedLogging (optional)
booleanhttpGetReadTimeout (optional)
inthttpPostReadTimeout (optional)
intjob (optional)
StringloadParamsFromFile (optional)
booleanmaxConn (optional)
intoverrideTrustAllCertificates (optional)
booleanparameterFile (optional)
Stringparameters (optional)
StringpollInterval (optional)
intpreventRemoteBuildQueue (optional)
booleanremoteJenkinsName (optional)
StringremoteJenkinsUrl (optional)
StringshouldNotFailBuild (optional)
booleantoken (optional)
StringtrustAllCertificates (optional)
It is possible to override/rewrite the 'Trust all certificate'-setting for each Job separately. Setting this checkbox to 'true' will result in accepting all certificates for the given Job.
This is unsafe and should only be used for testing or if you trust the host.
booleanuseCrumbCache (optional)
booleanuseJobInfoCache (optional)
booleancrxReplicatepackageIds (optional)
StringbaseUrls (optional)
username[:password]@ between the scheme and the hostname.
StringcredentialsId (optional)
/$username/keys/$fingerprint.
StringignoreErrors (optional)
booleanrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
longacmRepoSyncurl
StringcredentialsId
Stringforce (optional)
boolean$class: 'ReqtifyGenerateReport'reportArgumentList
StringnameReport (optional)
StringmodelReport (optional)
StringtemplateReport (optional)
StringpublishReviewdownloadOnly
booleaninstallRBTools
boolean$class: 'ReviewboardApplyPatch'$class: 'ReviewboardPollingBuilder'reviewbotJobName
StringcheckBackPeriod
StringreviewbotRepoId
StringrestrictByUser
booleandisableAdvanceNotice
boolean$class: 'RigorBuilder'credentialsId
Please select a credential of Kind Rigor API Key here.
Note: Your Rigor Optimization API key can be found on the API Credentials settings page in the Rigor Optimization application. The API key must have User or higher level permissions.
StringperformanceTestIds
List 1 or more test IDs (as a comma separated list) of Rigor Optimization Performance Tests to be run during this step. You can locate the performance test ID by hovering over the Info (i) icon on any performance test in the View Results page of your Rigor Optimization account.
If Fail build based on results is checked below, this step will wait until all tests complete before proceeding. If unchecked, this step will launch these tests, but not wait for them to complete.
StringfailOnSnapshotError
If checked, the build will be marked as failed if there are any errors running your configured performance tests. If unchecked, any errors creating tests will be treated as warnings and not fail the build.
booleanfailOnResults
If checked, the build will wait for your configured tests to complete (may take 30 seconds to a few minutes) and pass/fail based on the results configured below. If unchecked, your configured tests will run, but the build will not wait for the tests to complete nor fail this step based on any results (useful for historical change logging of your site in the Rigor Optimization application).
booleanperformanceScore
Optional
Fail the build if any test reports an overall performance score lower than this value (1-100)
StringcriticalNumber
Optional
Fail the build if any test has more than this # of critical first party content defects found.
Note: You can customize when critical defects occur by customizing your Defect Check Policy. Learn more in this article.
StringfoundDefectIds
Optional
Fail the build if any of the listed defect IDs (comma separated) are found for any first party content items in any configured test.
Note: You can locate any defect ID at the top of any defect detail page in your results, or in the Knowledge Base. See Example.
StringenforcePerformanceBudgets
Optional
Fail the build if any test exceeds its performance budgets
booleantotalContentSize
StringtotalFoundItems
StringtestTimeoutSeconds
Timeout in seconds to wait for all configured performance tests to complete. Defaults to 300 seconds (5 minutes).
This value is only used if Fail build based on test results is enabled.
StringsnRollbackAppcredentialsId (optional)
StringapiVersion (optional)
StringappScope (optional)
application system ID is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
StringappSysId (optional)
application scope is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
StringrollbackAppVersion (optional)
Stringurl (optional)
String$class: 'RollbackBuilder'changeLogFile (optional)
StringchangeLogParameters (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringinstallationName (optional)
Stringlabels (optional)
StringliquibasePropertiesPath (optional)
StringnumberOfChangesetsToRollback (optional)
Stringpassword (optional)
StringresourceDirectories (optional)
StringrollbackLastHours (optional)
StringrollbackToDate (optional)
StringrollbackToTag (optional)
StringrollbackType (optional)
Stringurl (optional)
Stringusername (optional)
StringsnRollbackPlugincredentialsId (optional)
StringapiVersion (optional)
StringpluginId (optional)
Stringurl (optional)
String$class: 'RqmBuilder'collectionStrategy
$class: 'RqmTestSuiteExectionRecordCollectionStrategy'executionRecordName
StringplanName
StringprojectName
StringiterativeTestCaseBuilders
hudson.tasks.BuildStep)preBuildSteps
hudson.tasks.BuildStep)postBuildSteps
hudson.tasks.BuildStep)credentialId
String$class: 'RubyMotionBuilder'platform
StringrakeTask
StringoutputStyle
StringoutputFileName
StringuseBundler
booleaninstallCocoaPods
booleanneedClean
booleanoutputResult
booleandeviceName
StringsimulatorVersion
StringenvVars
String$class: 'RunApplicationAction'applicationName
Application selection is mandatory
Select an existing Application in Calm or the ones provisioned in Nutanix Calm Blueprint Launch Steps.
StringactionName
Application Action selection is mandatory
StringruntimeVariables
Click on Fetch Runtime Variables to fetch all editable variables for the selected Action in JSON format. Modify the key values from the defaults as needed.The values can also reference jenkins environment variables.
StringrunFromAlmBuilderalmServerName
StringalmCredentialsScope
StringalmUserName
StringalmPassword
StringalmDomain
StringalmProject
StringalmTestSets
StringalmRunResultsMode
StringalmTimeout
StringalmRunMode
StringalmRunHost
StringalmClientID
StringalmApiKey
StringisSSOEnabled
booleanisFilterTestsEnabled (optional)
booleanfilterTestsModel (optional)
blockedCheckbox
booleanfailedCheckbox
booleannotCompletedCheckbox
booleannoRunCheckbox
booleanpassedCheckbox
booleantestName (optional)
StringalmServerSettingsModel (optional)
almServerName
StringalmServerUrl
StringalmCredentials
almUsername
StringalmPassword
StringalmSSOCredentials
almClientID
StringalmApiKeySecret
StringrunFromFSBuilderfsTests
StringfileSystemTestSetModel
fileSystemTestSet
tests
StringparallelRunnerEnvironments
environment
StringenvironmentType
StringsummaryDataLogModel
logVusersStates
booleanlogErrorCount
booleanlogTransactionStatistics
booleanpollingInterval
StringscriptRTSSetModel
scripts
scriptName
StringadditionalAttributes
name
Stringvalue
Stringdescription
StringisParallelRunnerEnabled (optional)
booleanuftSettingsModel (optional)
selectedNode (optional)
StringnumberOfReruns (optional)
StringcleanupTest (optional)
StringonCheckFailedTest (optional)
StringfsTestType (optional)
StringrerunSettingsModels (optional)
test (optional)
Stringchecked (optional)
booleannumberOfReruns (optional)
intcleanupTest (optional)
StringanalysisTemplate (optional)
StringcontrollerPollingInterval (optional)
StringdisplayController (optional)
StringfsAutActions (optional)
StringfsDeviceId (optional)
StringfsDevicesMetrics (optional)
StringfsExtraApps (optional)
StringfsInstrumented (optional)
StringfsJobId (optional)
StringfsLaunchAppName (optional)
StringfsManufacturerAndModel (optional)
StringfsOs (optional)
StringfsPassword (optional)
StringfsReportPath (optional)
StringfsTargetLab (optional)
StringfsTimeout (optional)
StringfsUftRunMode (optional)
StringfsUserName (optional)
StringignoreErrorStrings (optional)
StringmcServerName (optional)
StringmcTenantId (optional)
StringperScenarioTimeOut (optional)
StringproxySettings (optional)
fsUseAuthentication
booleanfsProxyAddress
StringfsProxyUserName
StringfsProxyPassword
class hudson.util.SecretresultFileNames (optional)
java.util.Map<java.lang.Long, java.lang.String>useSSL (optional)
boolean$class: 'RunInCloudBuilder'projectId
The Bitbar Cloud project in which to start the new test run.
StringappPath
StringtestPath
StringdataPath
StringtestRunName
Stringscheduler
StringtestRunner
StringdeviceGroupId
Stringlanguage
StringscreenshotsDirectory
StringkeyValuePairs
StringwithAnnotation
StringwithoutAnnotation
StringtestCasesSelect
StringtestCasesValue
StringfailBuildIfThisStepFailed
booleanvirusScanTimeout
StringwaitForResultsBlock
testRunStateCheckMethod (optional)
HOOK_URL, API_CALLdownloadScreenshots (optional)
booleanforceFinishAfterBreak (optional)
booleanhookURL (optional)
StringresultsPath (optional)
StringwaitForResultsTimeout (optional)
inttestTimeout
StringcredentialsId
StringcloudUrl
StringcloudUIUrl
StringframeworkId
longosType
IOS, ANDROID, DESKTOP, UNDEFINEDtpJobRunprojectId (optional)
StringjobId (optional)
StringagentId (optional)
StringwaitJobFinishSeconds (optional)
intexecutionParameters (optional)
StringjunitResultsFile (optional)
StringosfBuilderSuiteForSFCCRunJobhostname (optional)
StringocCredentialsId (optional)
StringocVersion (optional)
StringjobName (optional)
StringjobArguments (optional)
name
Stringvalue
String$class: 'RunLoadRunnerScript'scriptsPath
String$class: 'RunMatlabCommandBuilder'matlabCommand (optional)
String$class: 'RunMatlabTestsBuilder'coberturaArtifact (optional)
coberturaReportFilePath
StringjunitArtifact (optional)
junitReportFilePath
StringmodelCoverageArtifact (optional)
modelCoverageFilePath
StringpdfReportArtifact (optional)
pdfReportFilePath
StringselectByFolder (optional)
testFolderPaths
testFolders
StringselectByTag (optional)
testTag
StringsourceFolder (optional)
Specify the location of folders containing source code, relative to the project root folder. The specified folders and their subfolders are added to the top of the MATLAB search path. To generate a coverage report, MATLAB uses only the source code in the specified folders and their subfolders.
Paste the source folder path in the Folder path box. To add more folders, click Add folder.
sourceFolderPaths
srcFolderPath
StringstmResultsArtifact (optional)
stmResultsFilePath
StringtapArtifact (optional)
tapReportFilePath
String$class: 'RunPcTestBuildStep'almPassword (optional)
StringalmUser (optional)
Stringdomain (optional)
StringfailIfTaskFails (optional)
booleanoutputDir (optional)
StringpollingInterval (optional)
intpostRunActionString (optional)
Stringproject (optional)
StringretryCollateAndAnalysisAttempts (optional)
intretryCollateAndAnalysisFlag (optional)
booleanretryCollateAndAnalysisInterval (optional)
intretryCount (optional)
intretryInterval (optional)
intretryIntervalMultiplier (optional)
doubletestLabPath (optional)
StringtestPlanPath (optional)
Stringtimeout (optional)
inttimeslotDuration (optional)
intvudsMode (optional)
booleanrunPromotionartifact (optional)
StringartifactType (optional)
StringkeepTargetResources (optional)
booleankeepTargetRunProfiles (optional)
booleanplan (optional)
Stringpromotion (optional)
Stringtask (optional)
Stringworkspace (optional)
StringrunTaskenvironment (optional)
Stringparameters (optional)
Stringtask (optional)
Stringworkspace (optional)
StringtpTestRunjunitResultsFile
StringwaitTestFinishSeconds
intprojectId
StringtestId
StringagentId
Stringbrowser
Stringdevice
StringexecutionParameters
String$class: 'RunTestSetBuildStep'domain
Stringproject
StringrunMode
Stringhost
StringtestSets
StringoutputDirPath
StringtimeOut
intsnRunTestSuitecredentialsId (optional)
StringapiVersion (optional)
StringbrowserName (optional)
Valid values:
StringbrowserVersion (optional)
StringosName (optional)
StringosVersion (optional)
StringresponseBodyFormat (optional)
StringtestSuiteName (optional)
StringtestSuiteSysId (optional)
sys_id of the test suite to run. This value is located in the Test [sys_atf_test_suite] table.
Stringurl (optional)
StringwithResults (optional)
boolean$class: 'RunUftTestBuildStep'testPath
StringoutputDirPath
String$class: 'RunscopeBuilder'triggerEndPoint
StringaccessToken
Stringtimeout
ints3CopyArtifactprojectName
StringbuildSelector
downstreamupstreamProjectName
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
StringupstreamBuildNumber
StringlastWithArtifactslastCompleted$class: 'MultiJobBuildSelector'buildParameterparameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
Stringpermalinkid
String$class: 'PromotedBuildSelector'level
intlatestSavedBuildspecificbuildNumber
StringlastSuccessfulstable (optional)
booleanupstreamallowUpstreamDependencies (optional)
booleanfallbackToLastSuccessful (optional)
booleanupstreamFilterStrategy (optional)
UseGlobalSetting, UseOldest, UseNewestworkspacefilter
StringexcludeFilter
Stringtarget
Stringflatten
booleanoptional
boolean$class: 'SASUnitPlugInBuilder'This is the Jenkins Plug-In for SASUnit the unit testing framework for SAS.
sasunitBatch
StringdoxygenBatch
Please enter the relative path to the executable to create the doxygen report
StringsasunitVersion
Please pick a SASUnit installation that shall be used.
To add an installation please go to Jenins->Manage Jenkins->Setting or follow this link.
StringcreateDoxygenDocu
boolean$class: 'SBuild'sbuildVersion
Stringtargets
StringbuildFiles
Stringoptions
StringscmSkipdeleteBuild (optional)
booleanskipPattern (optional)
String$class: 'SConsBuilderCommand'sconsName
Stringoptions
Stringvariables
Stringtargets
StringrootSconsscriptDirectory
StringcommandScript
String$class: 'SConsBuilderScriptFile'sconsName
Stringoptions
Stringvariables
Stringtargets
StringrootSconsscriptDirectory
Stringsconsscript
String$class: 'SMABuilder'validateEnabled
booleanusername
Stringpassword
StringsecurityToken
StringserverType
StringtestLevel
StringprTargetBranch
String$class: 'SQLPlusRunnerBuilder'credentialsId
Stringinstance
StringscriptType
Stringscript
StringscriptContent
| SELECT sysdate from dual; show user; |
StringcustomNLSLang (optional)
StringcustomOracleHome (optional)
StringcustomSQLPath (optional)
StringcustomSQLPlusHome (optional)
StringcustomTNSAdmin (optional)
String$class: 'SSHBuilder'siteName
Stringcommand
StringexecEachLine
Execute each line in the script individually.
By default, all of the commands are concatenated into a single "command" issued over a single SSH exec channel. Selecting this option causes each line to be executed over it's own SSH exec channel, each of which is part of the same session.
This is useful in certain cases where the commands cannot be concatenated into a single script executed at one time, for example, when issuing commands using the sourceforge.net shell.
If unsure, leave this box unchecked.
booleanhideCommand (optional)
boolean$class: 'SaltAPIBuilder'authtype
StringclientInterface
hookpost
Stringtag
Stringbatchfunction
Stringarguments
StringbatchSize
StringbatchWait
Stringtarget
Stringtargettype
Stringlocalfunction
Stringarguments
Stringtarget
Stringtargettype
Stringblockbuild (optional)
booleanjobPollTime (optional)
intminionTimeout (optional)
intsubsetfunction
Stringarguments
Stringsubset
Stringtarget
Stringtargettype
Stringrunnerfunction
Stringarguments
Stringmods
Stringpillarvalue
StringcredentialsId
Stringservername (optional)
StringsaveEnvVar (optional)
booleansaveFile (optional)
booleanskipValidation (optional)
boolean$class: 'SbtPluginBuilder'name
StringjvmFlags
StringsbtFlags
Stringactions
StringsubdirPath
String$class: 'ScanBuilder'scanURL
StringapiKey
class hudson.util.Secretsource
Stringexclude
Stringrule
Stringtimeout
intisAbortBuild
booleanisPrivateScan
booleanisShowBlockedOnly
booleanisCreateLog
booleanvdooScanbaseApi (optional)
StringfailThreshold (optional)
StringfirmwareLocation (optional)
StringmaliciousFiles (optional)
StringmaxHighlightedCVEs (optional)
StringmaxHighlightedExposures (optional)
StringmaxHighlightedIssues (optional)
StringproductId (optional)
StringvdooToken (optional)
class hudson.util.SecretwaitForResults (optional)
boolean$class: 'ScriptBuildStep'buildStepId
StringdefineArgs
booleanbuildStepArgs
arg
Stringtokenized
boolean$class: 'ScriptBuilder'scriptFilePath
StringcredentialsId
StringhubUrl
StringimageName
StringvmVersion
StringcontainerWorkingDir
StringmountSettings
sourceContainer
StringsourceFolder
StringtargetFolder
StringrouteFile
StringnoBase
booleanoverwrite
booleandiagnostic
boolean$class: 'SealightsCLIBuildStep'enabled
booleanfailBuildIfStepFail
booleancommandMode
$class: 'ConfigView'appName
StringbranchName
StringbuildName
$class: 'DefaultBuildName'$class: 'EmptyBuildName'$class: 'LatestBuildName'$class: 'ManualBuildName'insertedBuildName
String$class: 'UpstreamBuildName'upstreamProjectName
StringlabId
StringbuildSessionId
StringadditionalArguments
| Argument name | Description |
|---|---|
| token | The token provided to you by SeaLights (override the global 'token' value for this build). |
| tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
| proxy | A valid URL to a proxy server. |
| agentpath | Override the path to SeaLights jar. |
| javapath | Override the path to the 'java' variable (default is 'java'). |
| filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
StringtechOptions
$class: 'DotNetOptions'namespacesIncluded
StringnamespacesExcluded
StringincludedFilePatterns
StringexcludedFilePatterns
String$class: 'JavaOptions'packagesIncluded
StringpackagesExcluded
String$class: 'EndView'buildSessionId
StringlabId
StringadditionalArguments
| Argument name | Description |
|---|---|
| token | The token provided to you by SeaLights (override the global 'token' value for this build). |
| tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
| proxy | A valid URL to a proxy server. |
| agentpath | Override the path to SeaLights jar. |
| javapath | Override the path to the 'java' variable (default is 'java'). |
| filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
| appname | Override default app name coming from build session id |
| buildname | Override default build name coming from build session id |
| branchname | Override default branch name coming from build session id |
String$class: 'ExternalReportView'report
StringbuildSessionId
StringadditionalArguments
| Argument name | Description |
|---|---|
| token | The token provided to you by SeaLights (override the global 'token' value for this build). |
| tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
| proxy | A valid URL to a proxy server. |
| agentpath | Override the path to SeaLights jar. |
| javapath | Override the path to the 'java' variable (default is 'java'). |
| filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
| appname | Override default app name coming from build session id |
| buildname | Override default build name coming from build session id |
| branchname | Override default branch name coming from build session id |
String$class: 'PrConfigView'appName
StringbranchName
StringbuildName
$class: 'DefaultBuildName'$class: 'EmptyBuildName'$class: 'LatestBuildName'$class: 'ManualBuildName'insertedBuildName
String$class: 'UpstreamBuildName'upstreamProjectName
StringlabId
StringbuildSessionId
StringadditionalArguments
| Argument name | Description |
|---|---|
| token | The token provided to you by SeaLights (override the global 'token' value for this build). |
| tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
| proxy | A valid URL to a proxy server. |
| agentpath | Override the path to SeaLights jar. |
| javapath | Override the path to the 'java' variable (default is 'java'). |
| filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
StringtechOptions
$class: 'DotNetOptions'namespacesIncluded
StringnamespacesExcluded
StringincludedFilePatterns
StringexcludedFilePatterns
String$class: 'JavaOptions'packagesIncluded
StringpackagesExcluded
StringlatestCommit
StringpullRequestNumber
StringrepoUrl
StringtargetBranch
String$class: 'StartView'testStage
StringbuildSessionId
StringlabId
StringadditionalArguments
| Argument name | Description |
|---|---|
| token | The token provided to you by SeaLights (override the global 'token' value for this build). |
| tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
| proxy | A valid URL to a proxy server. |
| agentpath | Override the path to SeaLights jar. |
| javapath | Override the path to the 'java' variable (default is 'java'). |
| filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
| appname | Override default app name coming from build session id |
| buildname | Override default build name coming from build session id |
| branchname | Override default branch name coming from build session id |
String$class: 'UploadReportsView'reportFiles
StringreportsFolders
Stringsource
StringbuildSessionId
StringlabId
StringadditionalArguments
| Argument name | Description |
|---|---|
| token | The token provided to you by SeaLights (override the global 'token' value for this build). |
| tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
| proxy | A valid URL to a proxy server. |
| agentpath | Override the path to SeaLights jar. |
| javapath | Override the path to the 'java' variable (default is 'java'). |
| filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
| appname | Override default app name coming from build session id |
| buildname | Override default build name coming from build session id |
| branchname | Override default branch name coming from build session id |
StringcliRunner
class io.sealights.plugins.sealightsjenkins.buildsteps.cli.CLIRunnerlogDestination
CONSOLE, FILElogFolder
StringlogLevel
OFF, INFO, DEBUG, WARN, ERRORlogFilename
String$class: 'SecurityCheckerBuilder'$class: 'SeleniumAutoExecBuilder'serverUrl
String$class: 'SeleniumBuilderBuilder'scriptFile
StringparallelSettings
threadPoolSize
int$class: 'SelfServiceBookmarkBuilder'delphixEngine
StringdelphixBookmark
StringdelphixOperation
StringdelphixContainer
StringloadFromProps (optional)
booleansaveToProps (optional)
boolean$class: 'SelfServiceContainerBuilder'delphixEngine
StringdelphixEnvironment
StringdelphixOperation
StringdelphixBookmark
StringloadFromProps (optional)
booleansaveToProps (optional)
boolean$class: 'SemanticVersioningBuilder'parser
StringnamingStrategy
StringuseJenkinsBuildNumber
booleanenvVariable
String$class: 'SendMessageBuildStep'message
Stringfilepath
Stringrecipients
id
StringsensediaApiDeployenviromentName
Stringrevision
StringsensediaApiJsonapiId
StringsensediaApiQArevisionNumber
intdestination
booleanlogInterceptor
booleanresourceOutOfSize
booleanresourceSize
intshellBy default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
command
StringconfiguredLocalRules (optional)
retainOnlyVariablesLimit which environment variables are passed to a build step.
Environment variables passed to the build step are filtered, unless listed below.
The behavior of this filter depends on whether the environment variable is originally defined outside Jenkins:
JOB_URL, it will not be passed to the build step unless specified here.PATH, the behavior depends on the option Process environment variables handling: If that option is set to Retain, the original value will be passed to the build step, discarding any modifications inside Jenkins. If that option is set to Remove, the variable will not be passed to the build step. The following table shows the effect of filtering on an environment variable:
| Behavior | Originally defined outside Jenkins | Originally defined inside Jenkins |
|---|---|---|
| Process environment variables handling: reset | Variable is reset to original value | Variable is removed |
| Process environment variables handling: removed | Variable is removed | Variable is removed |
processVariablesHandling (optional)
RESET, REMOVEretainCharacteristicEnvVars (optional)
When checked, characteristic environment variables will be retained in addition to the variables listed above. These environment variables are job- and build-specific, defined by Jenkins, and are used to identify and kill processes started by this build step. See the documentation for more details on starting processes.
booleanvariables (optional)
Whitespace separated, case insensitive list of environment variables that will be retained, i.e. not removed from the environment of this build step or reset to their default.
StringunstableReturn (optional)
int$class: 'SideeX'protocolMenu
The default protocol is "HTTP".
Use "HTTPS (Disable certificate checking)" to disable certificate checking.
Use "HTTPS (Enable certificate checking)" to enable certificate checking.
$class: 'HTTPItem'baseURL
String$class: 'HTTPSDisableItem'baseURL
String$class: 'HTTPSEnableItem'baseURL
StringcaFilePath
StringstateTime
StringtestCaseFilePath
StringsignAndroidApksandroidHome (optional)
zipalign tool. You can also set the ANDROID_HOME environment variable in your Jenkins system or node configuration. E.g., /usr/local/android-sdk.
StringapksToSign (optional)
myApp/build/outputs/apk/myApp-unsigned.apk or **/*-unsigned.apk or app1/**/*-unsigned.apk, app2/**/*-unsigned.apk.
StringarchiveSignedApks (optional)
SignApksBuilder-out/myApp-unsigned.apk/myApp-signed.apk, where myApp-unsigned.apk is a directory named for the input unsigned APK.
booleanarchiveUnsignedApks (optional)
booleankeyAlias (optional)
Key Store ID references. If your key store contains only one key entry, which is the most common case, you can leave this field blank.
StringkeyStoreId (optional)
StringsignedApkMapping (optional)
unsignedApkNameDirunsignedApkSiblingskipZipalign (optional)
booleanzipalignPath (optional)
zipalign executable this build step should use to align the target APKs. You can also set the ANDROID_ZIPALIGN environment variable in your Jenkins system or node configuration. E.g., /opt/android-tools/bin/zipalign
StringvenafiCodeSignWithSignTooltppName
StringfileOrGlob
A path or a glob that specifies the file(s) to be signed.
StringappendSignatures (optional)
booleanextraArgs (optional)
This plugin invokes Signtool under the hood. Here you can specify extra custom CLI arguments to pass to Signtool.
These arguments will be appended to the Signtool CLI invocation. If they overlap with any arguments implicitly passed by this plugin, then Signtool will raise an error.
argument
Stringsha1 (optional)
The SHA-1 hash of the certificate (inside the TPP) to use for code signing.
Normally you should use 'Signing certificate subject name' instead, but if that name is ambiguous, then use the SHA-1 hash to select a specific signing certificate.
Either a subject name or SHA-1 hash of the signing certificate must be given.
StringsignToolPath (optional)
StringsignatureDigestAlgos (optional)
The digest algorithm(s) to use to creating signatures.
If none specified, 'sha256' is used as the default algorithm. This is very secure, but may not be compatible with older Windows versions. If you need compatibility with older Windows versions, you should specify 'sha1' and 'sha256' (in that order).
When multiple digest algorithms are specified, they are applied in the order specified.
algorithm
StringsubjectName (optional)
The Common Name ("Issued to" or "CN") of the certificate (inside the TPP) to use for code signing.
You can obtain a list of Common Names with 'cspconfig listcertificates' and checking what comes after 'CN='.
Either a subject name or SHA-1 hash of the signing certificate must be given.
StringtimestampingServers (optional)
Specifies one or more timestamping authority servers to use during signing. Specifying this is strongly recommended, because it allows signed files to be usable even after the original signing certificate has expired.
If you specify more than one server, then a random one will be used.
Tip: here are some public timestamping authorities that you can use:
address
StringuseMachineConfiguration (optional)
booleanvenafiClientToolsDir (optional)
C:\Program Files\Venafi CodeSign Protect.StringvenafiVerifyWithSignTooltppName
StringfileOrGlob
A path or a glob that specifies the file(s) to be verified.
StringsignToolPath (optional)
StringuseMachineConfiguration (optional)
booleanvenafiClientToolsDir (optional)
C:\Program Files\Venafi CodeSign Protect.String$class: 'SilkPerformerBuilder'projectLoc
Stringworkload
StringsuccessCriteria
userType
StringmeasureCategory
StringmeasureType
StringmeasureName
StringvalueType
StringoperatorType
StringchosenValue
StringSimplifyQAapi
Stringtoken
class hudson.util.Secret$class: 'SingleConditionalBuilder'buildStep
hudson.tasks.BuildStep)condition
$class: 'AlwaysRun'$class: 'And'conditions
condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'conditions
condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
Stringrunner
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'skenaiorgId
StringappId
String$class: 'SkytapBuilder'action
$class: 'AddConfigurationToProjectStep'configurationID
StringconfigurationFile
StringprojectID
StringprojectName
String$class: 'AddTemplateToProjectStep'templateID
StringtemplateFile
StringprojectID
StringprojectName
String$class: 'ChangeConfigurationStateStep'configurationID
StringconfigurationFile
StringtargetRunState
StringhaltOnFailedShutdown
boolean$class: 'ChangeContainerStateStep'containerID
StringcontainerFile
StringtargetContainerAction
String$class: 'ChangeVMContainerHostStatus'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringcontainerHostStatus
String$class: 'ConnectToVPNTunnelStep'configurationID
StringconfigurationFile
StringconfigurationNetworkName
StringvpnID
String$class: 'CreateConfigurationStep'templateID
StringtemplateFile
StringconfigName
StringconfigFile
String$class: 'CreateContainerStep'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringcontainerRegistryName
StringrepositoryName
StringcontainerName
If no name is provided, the container will be named New_Container_[timestamp]
StringcontainerCommand
If no command is provided, will default to using the command in the image spec (if applicable).
StringexposeAllPorts
booleancontainerSaveFilename
String$class: 'CreatePublishURLStep'configurationID
StringconfigurationFile
StringurlSaveFilename
StringportalName
StringpermissionOption
Don't Publish: The Sharing Portal URL will not be available to the user in any way.
View Only: User can view the VM through the Sharing Portal URL. No mouse or keyboard control is allowed, and desktop resizing is disabled.
Use:User can view the VM through the Sharing Portal URL and interact with it using a mouse or keyboard. Desktop resizing is allowed.
Run, Suspend: User can view the VM through the Sharing Portal URL and interact with it using a mouse or keyboard. Desktop resizing is allowed, and the user can also run the machine if it is in a stopped or suspended state.
StringhasPassword
urlPassword
class hudson.util.Secret$class: 'CreatePublishedServiceStep'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringnetworkName
StringportNumber
StringpublishedServiceFile
String$class: 'CreateTemplateFromConfigurationStep'configurationID
StringconfigurationFile
StringtemplateName
StringtemplateDescription
StringtemplateSaveFilename
String$class: 'DeleteConfigurationStep'configurationID
StringconfigurationFile
String$class: 'DeleteContainerStep'containerID
StringcontainerFile
String$class: 'GetContainerMetaDataStep'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringcontainerName
StringcontainerDataFile
String$class: 'ListPublishedURLForConfigurationStep'configurationID
StringconfigurationFile
StringurlName
StringurlFile
String$class: 'ListVMPublishedServiceStep'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringnetworkName
StringportNumber
StringpublishedServiceFile
String$class: 'MergeTemplateIntoConfigurationStep'configurationID
StringconfigurationFile
StringtemplateID
StringtemplateFile
StringconfigFile
String$class: 'NetworkConnectStep'sourceNetworkConfigurationID
StringtargetNetworkConfigurationID
StringsourceNetworkConfigurationFile
StringtargetNetworkConfigurationFile
StringsourceNetworkName
StringtargetNetworkName
String$class: 'SleepBuilder'time
long$class: 'SmartFrogBuilder'smartFrogName
StringdeployHost
Stringhosts
StringsfUserHome
StringsfUserHome2
StringsfUserHome3
StringsfUserHome4
StringsfOpts
StringbuilderId
StringuseAltIni
booleansfIni
StringsfScriptSource
$class: 'FileScriptSource'scriptName
StringscriptPath
String$class: 'StringScriptSource'scriptName
StringscriptContent
String$class: 'SnapshotBuilder'xStudioPath
StringxStudioLicensePath
StringvagrantBox
Stringoverwrite
booleanpreInstallScriptPath
StringpostSnapshotScriptPath
StringresourceDirectoryPath
Stringdependencies
StringsnapshotFilesToDelete
StringinstallScriptSettings
class org.jenkinsci.plugins.spoontrigger.SnapshotBuilder$InstallScriptSettingsstartupFileSettings
class org.jenkinsci.plugins.spoontrigger.SnapshotBuilder$StartupFileSettings$class: 'SnykStepBuilder'additionalArguments (optional)
Additional runtime arguments that will be used to invoke the Snyk CLI. See the Snyk CLI help page for more details.
Use the standalone double-dash -- to pass arguments to the build tool invoked by the Snyk CLI. For example:
-- -Pprofile -Dkey=value for Maven projects.-- --configuration runtime for Gradle projects.-- -Dkey=value for SBT projects.StringfailOnError (optional)
Whether the step should fail if Snyk fails to scan the project due to an error. Errors include scenarios like: failing to download Snyk's binaries, improper Jenkins setup, bad configuration and server errors.
booleanfailOnIssues (optional)
The "When issues are found" selection specifies if builds should be failed or continued based on issues found by Snyk.
The corresponding CLI option for severity parameter: --severity-threshold
booleanmonitorProjectOnBuild (optional)
Monitor the project on every build by taking a snapshot of its current dependencies on Snyk.io. Selecting this option will keep you notified about newly disclosed vulnerabilities and remediation options in the project.
booleanorganisation (optional)
The Snyk organisation in which this project should be tested and monitored. Leave empty to use your default organisation.
The corresponding CLI option for this parameter: --org
StringprojectName (optional)
A custom name for the Snyk project created for this Jenkins project on every build. Leave empty for the project's name to be detected in the manifest file.
The corresponding CLI option for this parameter: --project-name
Stringseverity (optional)
StringsnykInstallation (optional)
Ensures that the selected version of Snyk tools are installed. In addition, the Snyk tools will be added at the start of the PATH environment variable during builds.
If no Snyk installations have been defined in the Jenkins system config, then none of the above steps will take place.
StringsnykTokenId (optional)
This needs to be the ID of an existing "Snyk API Token" credential. The token will be used to authenticate with Snyk.
If you prefer to provide the Snyk API Token another way, such using alternative credential bindings, you'll need to provide a SNYK_TOKEN build environment variable.
StringtargetFile (optional)
The path to the manifest file to be used by Snyk. Leave empty for Snyk to auto-detect the manifest file in the project's root folder.
The corresponding CLI option for this parameter: --file
StringaddALMOctaneSonarQubeListenerpushCoverage (optional)
booleanpushVulnerabilities (optional)
booleanskipWebhookCreation (optional)
booleansonarServerUrl (optional)
StringsonarToken (optional)
String$class: 'SonarRunnerBuilder'additionalArguments (optional)
StringinstallationName (optional)
StringjavaOpts (optional)
Stringjdk (optional)
Stringproject (optional)
Stringproperties (optional)
StringsonarScannerName (optional)
Stringtask (optional)
String$class: 'SoundsBuildTask'afterDelayMs
StringsoundSource
selectedSound
Stringvalue
INTERNAL, URLsoundUrl
String$class: 'SparkNotifyBuilder'disable
booleanmessageType
StringroomList
rName
StringrId
StringmessageContent (optional)
StringcredentialsId (optional)
StringsplitsplitTask
StringsplitName
StringenvironmentName
StringworkspaceName
StringtrafficTypeName
StringsplitDefinitions
StringwhitelistKey
StringtreatmentName
StringsplitYAMLFile
StringspringBootselectedIDs (optional)
StringartifactId (optional)
Stringautocomplete (optional)
StringbootVersion (optional)
Stringdescription (optional)
StringgroupId (optional)
StringjavaVersion (optional)
Stringlanguage (optional)
Stringpackaging (optional)
StringprojectName (optional)
Stringtype (optional)
StringsseBuildalmServerName
StringalmProject
StringcredentialsId
StringclientType
StringalmDomain
StringrunType
StringalmEntityId
StringtimeslotDuration
StringcdaDetails (optional)
deploymentAction
StringdeployedEnvironmentName
StringdeprovisioningAction
Stringdescription (optional)
StringenvironmentConfigurationId (optional)
StringpostRunAction (optional)
StringstackroxapiToken (optional)
StringcaCertPEM (optional)
StringenableTLSVerification (optional)
booleanfailOnCriticalPluginError (optional)
booleanfailOnPolicyEvalFailure (optional)
booleanportalAddress (optional)
StringosfBuilderSuiteStandaloneSonarLintersourcePatterns (optional)
sourcePattern
StringexcludePatterns
excludePattern
StringreportPath (optional)
String$class: 'StartBox'cloud
Stringworkspace
Stringbox
Stringinstance
StringbuildStep
StringstartETConfigure and start a preconfigured ECU-TEST installation.
Pipeline usage
startET(String toolName) : void
startET(String toolName, String workspaceDir, String settingsDir, int timeout,
boolean debugMode, boolean keepInstance, boolean updateUserLibs) : void
ETInstance.start() : void
ETInstance.start(String workspaceDir, String settingsDir, int timeout,
boolean debugMode, boolean keepInstance, boolean updateUserLibs) : void
ETInstance.start(Map<String, Object> settings) : void
startET('ECU-TEST')
def instance = ET.installation('ECU-TEST')
startET installation: instance.installation, workspaceDir: 'C:\\Data'
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.start()
def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0'
instance.start workspaceDir: 'C:\\Data', settingsDir: 'C:\\Data', timeout: 120, debugMode: true, keepInstance: false, updateUserLibs: true
toolName
StringdebugMode (optional)
booleaninstallation (optional)
name
Stringhome
Stringproperties
? extends hudson.tools.ToolProperty<?>keepInstance (optional)
booleansettingsDir (optional)
Stringtimeout (optional)
StringupdateUserLibs (optional)
booleanworkspaceDir (optional)
String$class: 'StartGrid'url
StringcloudTestServerID
Stringname
StringtimeOut
intacmStartPipelineaioProject (optional)
Stringpipeline (optional)
Stringprogram (optional)
String$class: 'StartRSDB'url
StringcloudTestServerID
Stringname
StringtimeOut
intstartTSConfigure and start Tool-Server.
Pipeline usage
startTS(String toolName) : void
startTS(String toolName, String toolLibsIniPath, int tcpPort, int timeout, boolean keepInstance) : void
ETInstance.startTS() : void
ETInstance.startTS(String toolLibsIniPath, int tcpPort, int timeout, boolean keepInstance) : void
ETInstance.startTS(Map<String, Object> settings) : void
startTS('ECU-TEST')
def instance = ET.installation('ECU-TEST')
startTS installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.startTS()
def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0'
instance.startTS toolLibsIniPath: C:\\ToolLibs.ini, tcpPort: 5017, timeout: 60, keepInstance: false
toolName
Stringinstallation (optional)
name
Stringhome
Stringproperties
? extends hudson.tools.ToolProperty<?>keepInstance (optional)
booleantcpPort (optional)
Stringtimeout (optional)
StringtoolLibsIni (optional)
String$class: 'StartTestEnvironment'url
StringcloudTestServerID
Stringname
StringtimeOut
int$class: 'StopBox'cloud
Stringworkspace
Stringbox
Stringinstance
StringbuildStep
StringstopETShutdown ECU-TEST.
Pipelines usage:
stopET(String toolName) : void
stopET(String toolName, int timeout) : void
ETInstance.stop() : void
ETInstance.stop(int timeout) : void
ETInstance.stop(Map<String, Object> settings) : void
stopET('ECU-TEST')
def instance = ET.installation('ECU-TEST')
stopET installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.stop()
def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0'
instance.stop timeout: 60
toolName
Stringinstallation (optional)
name
Stringhome
Stringproperties
? extends hudson.tools.ToolProperty<?>timeout (optional)
String$class: 'StopGrid'url
StringcloudTestServerID
Stringname
String$class: 'StopRSDB'url
StringcloudTestServerID
Stringname
StringstopTSShutdown Tool-Server.
Pipelines usage:
stopTS(String toolName) : void
stopTS(String toolName, int timeout) : void
ETInstance.stopTS() : void
ETInstance.stopTS(int timeout) : void
ETInstance.stopTS(Map<String, Object> settings) : void
stopTS('ECU-TEST')
def instance = ET.installation('ECU-TEST')
stopTS installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.stopTS()
def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0'
instance.stopTS timeout: 60
toolName
Stringinstallation (optional)
name
Stringhome
Stringproperties
? extends hudson.tools.ToolProperty<?>timeout (optional)
String$class: 'StopTestEnvironment'url
StringcloudTestServerID
Stringname
StringstrobeMeasurementconnectionId
StringcredentialsId
StringrequestType
StringjobName
Stringbody (optional)
Stringduration (optional)
Stringemailto (optional)
StringfinalAction (optional)
Stringheaders (optional)
Stringhlq (optional)
Stringlimit (optional)
Stringmethod (optional)
StringprofileName (optional)
Stringsamples (optional)
Stringtags (optional)
StringtransactionId (optional)
Stringurl (optional)
String$class: 'StudioToolsBuilder'name
Stringoperation
StringprojectDir
StringoutputArchiveFile
StringextendedClassPath
StringoverwriteOutput
booleanTRAPropertyFIle
StringtopazSubmitFreeFormJclconnectionId
StringcredentialsId
StringmaxConditionCode
Stringjcl
StringtopazSubmitJclMembersconnectionId
StringcredentialsId
StringmaxConditionCode
StringjclMember
String$class: 'SvChangeModeBuilder'serverName
Stringforce
booleanmode
OFFLINE, SIMULATING, STAND_BY, LEARNINGdataModel
selectionType
BY_NAME, NONE, DEFAULTdataModel
StringperformanceModel
selectionType
BY_NAME, NONE, OFFLINE, DEFAULTperformanceModel
StringserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
String$class: 'SvDeployBuilder'serverName
Stringforce
booleanservice
StringprojectPath
StringprojectPassword
StringfirstAgentFallback
boolean$class: 'SvExportBuilder'serverName
Stringforce
booleantargetDirectory
StringcleanTargetDirectory
booleanserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
StringswitchToStandByFirst
booleanarchive
boolean$class: 'SvUndeployBuilder'serverName
StringcontinueIfNotDeployed
booleanforce
booleanserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
StringSWEAGLEExportactionName
StringmdsName
Stringargs (optional)
Stringexporter (optional)
StringfileLocation (optional)
Stringformat (optional)
StringmapToVariables (optional)
StringmarkFailed (optional)
booleanshowResults (optional)
booleantag (optional)
StringSWEAGLESnapshotactionName
StringmdsName
Stringdescription (optional)
StringmarkFailed (optional)
booleanshowResults (optional)
booleantag (optional)
StringSWEAGLEUploadactionName
StringfileLocation
Stringformat
StringnodePath
StringallowDelete (optional)
Allow Delete If checked will delete any nodes and MDIs that are not part of the upload. If the nodes are included or inherited the nodes and MDIs at points of inclusion will also be deleted unless "Only Parent" is also checked.
booleanautoRecognize (optional)
booleandescription (optional)
StringfilenameNodes (optional)
Create Filename Nodes If checked, nodes will be created for all matching files names in the file location and file data will be placed under file name node.
booleanidentifierWords (optional)
Identifier Words To make nodes part of an array uniquely identifiable, a comma separated list of 'identifier words' can be added. If no identifierWords are provided, the behavior will default to the identifierWords listed in the find.identity_attributes_discovery.word_list preference
StringmarkFailed (optional)
booleanonlyParent (optional)
Only Parent This controls if in case the allowDelete flag is set to true if the deletion of nodes and CDIs will only happen at the node itself, or also at any other place where the node is included or in every child node that is inheriting.
booleanshowResults (optional)
booleansubDirectories (optional)
Search Sub-directories If checked sub-directories will also be searched recursively for matching files.
booleantag (optional)
StringwithSnapshot (optional)
Allow Delete If checked will delete any nodes and MDIs that are not part of the upload. In case the nodes are included or inherited, also the nodes and MDIs at points of inclusion will be deleted
Only Parent If checked will delete any nodes and MDIs that are not part of the upload. In case the nodes are included or inherited, also the nodes and MDIs at points of inclusion will be deleted
Store Snapshot. This controls if automatically a snapshot should be created for each of the impacted config data sets by this data upload.
booleanSWEAGLEValidateactionName
StringmdsName
StringerrMax (optional)
intmarkFailed (optional)
booleannoPending (optional)
booleanretryCount (optional)
intretryInterval (optional)
intshowResults (optional)
booleanstored (optional)
booleanwarnMax (optional)
int$class: 'SyncBuilder'packageid
StringserverName
StringdbName
StringserverAuth
value
Stringusername
Stringpassword
class hudson.util.SecretencryptConnection
booleantrustServerCertificate
booleanoptions
StringdataOptions
Stringfilter
StringpackageVersion
StringisolationLevel
StringupdateScript
booleansqlChangeAutomationVersionOption
value
Latest, SpecificspecificVersion
String$class: 'SyncStepBuilder'packageId
Stringserver
Stringdatabase
StringauthenticationType
StringuserName
Stringpassword
class hudson.util.SecretcompareOptions (optional)
StringfilterFile (optional)
StringtransactionIsoLvl (optional)
String$class: 'SysdigBuilder'name
StringbailOnFail (optional)
booleanbailOnPluginFail (optional)
booleanengineCredentialsId (optional)
Stringengineurl (optional)
Stringengineverify (optional)
booleanforceScan (optional)
booleaninlineScanExtraParams (optional)
StringinlineScanning (optional)
booleanrunAsUser (optional)
String$class: 'SystemGroovy'Executes a system groovy script similarly to hudson_url/script. The script is always executed on master.
Predefined variables:
build
AbstractBuild.
launcher
Launcher.
listener
BuildListener.
out
PrintStream (listener.logger).
source
$class: 'FileSystemScriptSource'scriptFile
String$class: 'StringSystemScriptSource'script
script
Stringsandbox
booleanclasspath
path
Stringbindings (optional)
Define variable bindings (in the properties file format). Specified variables can be addressed from the script.
String$class: 'TATestRunRegistrationBuildStep'This step registers new test run with given category and sets the 'dtTestrunID' build variable.
category
Stringplatform
String$class: 'TagBuilder'changeLogFile (optional)
StringchangeLogParameters (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringinstallationName (optional)
Stringlabels (optional)
StringliquibasePropertiesPath (optional)
Stringpassword (optional)
StringresourceDirectories (optional)
Stringtag (optional)
Stringurl (optional)
Stringusername (optional)
Stringtanaguruname
Stringscenario
StringurlToAudit
StringurlTanaguruWebService
StringperformanceUnstableMark
intperformanceFailedMark
intproxy_uri
Stringproxy_username
Stringproxy_password
String$class: 'TattletaleBuilder'inputDirectory
StringoutputDirectory
Stringtestcompletetestsuite (optional)
StringaccessKeyId (optional)
StringactionOnErrors (optional)
StringactionOnWarnings (optional)
StringcommandLineArguments (optional)
StringcredentialsId (optional)
StringexecutorType (optional)
StringexecutorVersion (optional)
StringgenerateMHT (optional)
booleanlaunchConfig (optional)
project (optional)
Stringroutine (optional)
Stringtags (optional)
Stringtest (optional)
Stringunit (optional)
Stringvalue (optional)
StringlaunchType (optional)
Stringproject (optional)
StringpublishJUnitReports (optional)
booleanroutine (optional)
StringsessionScreenResolution (optional)
Stringtags (optional)
Stringtest (optional)
Stringtimeout (optional)
Stringunit (optional)
StringuseActiveSession (optional)
booleanuseTCService (optional)
booleanuseTimeout (optional)
booleanuserName (optional)
StringuserPassword (optional)
String$class: 'TelegramBotBuilder'message
String$class: 'TelerikAppBuilder'applicationId
StringaccessToken
class hudson.util.Secretconfiguration
StringbuildSettingsiOS
mobileProvisionIdentifieriOS
StringcodesigningIdentityiOS
StringbuildSettingsAndroid
codesigningIdentityAndroid
StringbuildSettingsWP
booleanprismaIaCassetName
StringtemplateType
StringtemplateVersion
Stringtags
StringfailureCriteriaHigh
StringfailureCriteriaLow
StringfailureCriteriaMedium
StringfailureCriteriaOperator
String$class: 'TerminateBox'cloud
Stringworkspace
Stringbox
Stringinstance
StringbuildStep
Stringdelete
booleancfyTerraformcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringdebugOutput (optional)
booleandeploymentId (optional)
ID to assign to the created Cloudify deployment. If not provided, one will be randomly generated. You can obtain the deployment ID from the "environment data" output file.
StringechoEnvData (optional)
If checked, then the created environment's data will be printed to the job's log.
booleanechoInputs (optional)
booleanenvDataLocation (optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
StringenvironmentVariables (optional)
java.util.Map<java.lang.String, java.lang.String>environmentVariablesAsString (optional)
YAML/JSON containing environment variables to pass to the Terraform process. The provided string will be expanded for environment variables (${VAR_NAME}).
StringenvironmentVariablesFile (optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing environment variables to pass to the Terraform process.
Stringexecutable (optional)
Path, on Cloudify Manager, of the Terraform executable. If omitted, the value of the terraform_executable Cloudify secret will be used.
StringpluginsDirectory (optional)
Path, on Cloudify Manager, of Terraform's plugins directory. If omitted, the value of the terraform_plugins_dir Cloudify secret will be used.
StringstorageDirectory (optional)
Path, on Cloudify Manager, of Terraform's storage directory. If omitted, the value of the terraform_storage_dir Cloudify secret will be used.
StringtemplateUrl (optional)
URL of the Terraform template. May be a ZIP, tar.gz, or a Git repository.
Stringtenant (optional)
Stringvariables (optional)
java.util.Map<java.lang.String, java.lang.Object>variablesAsString (optional)
YAML/JSON containing variables to pass to the Terraform template. The provided string will be expanded for environment variables (${VAR_NAME}).
StringvariablesFile (optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
StringdotnetTestdotnet test command is used to execute unit tests in a given solution. It builds the solution and runs a test host application for each test project in the solution. The test host executes tests in the given project using a test framework, for example: MSTest, NUnit, or xUnit, and reports the success or failure of each test. If all tests are successful, the test runner returns 0 as an exit code; otherwise if any test fails, it returns 1.
blame (optional)
TestResults/<Guid>/<Guid>_Sequence.xml that captures the order of tests that were run before the crash.
booleanblameCrash (optional)
--blame.
VSTEST_DUMP_FORCEPROCDUMP environment variable to 1.
booleanblameCrashCollectAlways (optional)
booleanblameCrashDumpType (optional)
--blame-crash.
StringblameHang (optional)
booleanblameHangDumpType (optional)
full, mini, or none. When none is specified, the test host is terminated on timeout, but no dump is collected. Implies --blame-hang.
StringblameHangTimeout (optional)
--blame and --blame-hang.
intcollect (optional)
Stringconfiguration (optional)
Debug, but you can override the build configuration settings in your project.
Stringdiag (optional)
*.host_<date>.txt for the test host log, and *.datacollector_<date>.txt for the data collector log.
Stringfilter (optional)
Stringframework (optional)
dotnet or a .NET Framework test host for the test binaries. This option only determines which type of host to use. The actual framework version to be used is determined by the runtimeconfig.json of the test project. When not specified, the TargetFramework assembly attribute is used to determine the type of host. When that attribute is stripped from the .dll, the .NET Framework host is used.
StringlistTests (optional)
booleanlogger (optional)
dotnet test doesn't accept abbreviations: instead of "console;v=d", use "console;verbosity=detailed".
StringnoBuild (optional)
booleannoRestore (optional)
booleannologo (optional)
booleanoption (optional)
Stringoptions (optional)
StringoptionsString (optional)
StringoutputDirectory (optional)
./bin/<configuration>/<framework>/. For projects with multiple target frameworks (via the TargetFrameworks property), you also need to specify a framework when you specify this option. dotnet test always runs tests from the output directory. You can use AppDomain.BaseDirectory to consume test assets in the output directory.
Stringproject (optional)
Stringproperties (optional)
java.util.Map<java.lang.String, java.lang.String>propertiesString (optional)
StringresultsDirectory (optional)
TestResults in the directory that contains the project file.
StringrunSettings (optional)
java.util.Map<java.lang.String, java.lang.String>runSettingsString (optional)
RunSettings values, specified in in Java properties syntax.
Stringruntime (optional)
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
Stringsettings (optional)
.runsettings file to use for running the tests. Note that the TargetPlatform element (x86|x64) has no effect for dotnet test. To run tests that target x86, install the x86 version of .NET Core. The bitness of the dotnet.exe that is on the path is what will be used for running tests.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleanshutDownBuildServers (optional)
dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
hanguntil those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
booleanspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleantestAdapterPath (optional)
.TestAdapter.dll are inspected. If not specified, the directory of the test .dll is searched.
StringunstableIfWarnings (optional)
booleanverbosity (optional)
StringworkDirectory (optional)
String$class: 'TestBuilder'packageid
StringtempServer
value
StringserverName
StringdbName
StringserverAuth
value
Stringusername
Stringpassword
class hudson.util.SecretencryptConnection
booleantrustServerCertificate
booleanrunTestSet
value
StringrunOnlyParams
StringgenerateTestData
sqlgenPath
Stringoptions
StringdataOptions
Stringfilter
StringpackageVersion
StringsqlChangeAutomationVersionOption
value
Latest, SpecificspecificVersion
StringtestSource
value
scaproject, socartifactprojectPath
Stringpackageid
StringpackageVersion
String$class: 'TestCompositionRunner'url
StringcloudTestServerID
Stringcomposition
StringdeleteOldResults
maxDaysOfResults
intadditionalOptions
Stringthresholds
transactionname
Stringthresholdname
Stringthresholdvalue
Stringthresholdid
StringgeneratePlotCSV
booleantestFoldertestFile
StringexecutionConfig (optional)
timeout
StringstopOnError
booleancheckTestFile
booleanrecordWarnings
booleanfailFast (optional)
booleanpackageConfig (optional)
runTest
booleanrunTraceAnalysis
booleanparameters
name
Stringvalue
StringoutputParameters
name
StringprojectConfig (optional)
execInCurrentPkgDir
booleanfilterExpression
StringjobExecMode
NO_EXECUTION, SEQUENTIAL_EXECUTION, PARALLEL_EXECUTION, SEPARATE_SEQUENTIAL_EXECUTION, SEPARATE_PARALLEL_EXECUTION, NO_TESTCASE_EXECUTION, TEST_GUIDE_EXECUTIONrecursiveScan (optional)
booleanscanMode (optional)
PACKAGES_ONLY, PROJECTS_ONLY, PACKAGES_AND_PROJECTStestConfig (optional)
tbcFile
StringtcfFile
StringforceReload
booleanloadOnly
booleankeepConfig
booleanconstants
name
Stringvalue
String$class: 'TestLinkBuilder'testLinkName
StringtestProjectName
StringtestPlanName
StringplatformName
StringbuildName
StringcustomFields
StringtestPlanCustomFields
StringexecutionStatusNotRun
booleanexecutionStatusPassed
booleanexecutionStatusFailed
booleanexecutionStatusBlocked
booleansingleBuildSteps
hudson.tasks.BuildStep)beforeIteratingAllTestCasesBuildSteps
hudson.tasks.BuildStep)iterativeBuildSteps
hudson.tasks.BuildStep)afterIteratingAllTestCasesBuildSteps
hudson.tasks.BuildStep)transactional
booleanfailedTestsMarkBuildAsFailure
booleanfailIfNoResults
booleanfailOnNotRun
booleanresultSeekers
$class: 'JUnitCaseClassNameResultSeeker'includePattern
StringkeyCustomField
StringattachJUnitXML
booleanincludeNotes
boolean$class: 'JUnitCaseNameResultSeeker'includePattern
StringkeyCustomField
StringattachJUnitXML
booleanincludeNotes
boolean$class: 'JUnitMethodNameResultSeeker'includePattern
StringkeyCustomField
StringattachJUnitXML
booleanincludeNotes
boolean$class: 'JUnitSuiteNameResultSeeker'includePattern
StringkeyCustomField
StringattachJUnitXML
booleanincludeNotes
boolean$class: 'TAPFileNameMultiTestPointsResultSeeker'includePattern
StringkeyCustomField
StringattachTAPStream
booleanattachYAMLishAttachments
booleanincludeNotes
booleancompareFullPath
booleantestpointsAsExecutions
boolean$class: 'TAPFileNameResultSeeker'includePattern
StringkeyCustomField
StringattachTAPStream
booleanattachYAMLishAttachments
booleanincludeNotes
booleancompareFullPath
boolean$class: 'TestNGClassNameResultSeeker'includePattern
StringkeyCustomField
StringattachTestNGXML
booleanmarkSkippedTestAsBlocked
booleanincludeNotes
boolean$class: 'TestNGMethodNameDataProviderNameResultSeeker'includePattern
StringkeyCustomField
StringattachTestNGXML
booleanmarkSkippedTestAsBlocked
booleandataProviderNameKeyCustomField
StringincludeNotes
boolean$class: 'TestNGMethodNameResultSeeker'includePattern
StringkeyCustomField
StringattachTestNGXML
booleanmarkSkippedTestAsBlocked
booleanincludeNotes
boolean$class: 'TestNGSuiteNameResultSeeker'includePattern
StringkeyCustomField
StringattachTestNGXML
booleanmarkSkippedTestAsBlocked
booleanincludeNotes
boolean$class: 'TestOdysseyBuilder'jobId
StringprojectId
StringminPassPercentage
StringtestPackagetestFile
StringexecutionConfig (optional)
timeout
StringstopOnError
booleancheckTestFile
booleanrecordWarnings
booleanpackageConfig (optional)
runTest
booleanrunTraceAnalysis
booleanparameters
name
Stringvalue
StringoutputParameters
name
StringtestConfig (optional)
tbcFile
StringtcfFile
StringforceReload
booleanloadOnly
booleankeepConfig
booleanconstants
name
Stringvalue
StringtestProjecttestFile
StringexecutionConfig (optional)
timeout
StringstopOnError
booleancheckTestFile
booleanrecordWarnings
booleanprojectConfig (optional)
execInCurrentPkgDir
booleanfilterExpression
StringjobExecMode
NO_EXECUTION, SEQUENTIAL_EXECUTION, PARALLEL_EXECUTION, SEPARATE_SEQUENTIAL_EXECUTION, SEPARATE_PARALLEL_EXECUTION, NO_TESTCASE_EXECUTION, TEST_GUIDE_EXECUTIONtestConfig (optional)
tbcFile
StringtcfFile
StringforceReload
booleanloadOnly
booleankeepConfig
booleanconstants
name
Stringvalue
String$class: 'TestRunner'stack
Stringbranch
StringtestNames
Stringundeploy
booleanapiKey
String$class: 'TestStepBuilder'packageId
StringserverType
Stringserver
Stringdatabase
StringauthenticationType
StringuserName
Stringpassword
class hudson.util.SecretrunTestMode
StringrunTests
StringcompareOptions (optional)
StringdgenFile (optional)
StringfilterFile (optional)
StringgenerateTestData (optional)
booleantransactionIsoLvl (optional)
String$class: 'TestStudioAPITestBuilder'apiRunnerPath (optional)
Stringproject (optional)
Stringtest (optional)
StringstartFrom (optional)
StringstopAfter (optional)
Stringvariable (optional)
StringdontSaveContexts (optional)
booleantestAsUnit (optional)
boolean$class: 'TestStudioTestBuilder'artOfTestRunnerPath
StringtestPath
StringsettingsPath
StringdateFormat
| Letter | Date or Time Component | Presentation | Examples |
|---|---|---|---|
| G | Era designator | Text | AD |
| y | Year | Year | 1996; 96 |
| Y | Week year | Year | 2009; 09 |
| M/L | Month in year | Month | July; Jul; 07 |
| w | Week in year | Number | 27 |
| W | Week in month | Number | 2 |
| D | Day in year | Number | 189 |
| d | Day in month | Number | 10 |
| F | Day of week in month | Number | 2 |
| E | Day in week | Text | Tuesday; Tue |
| u | Day number of week | Number | 1 |
| a | Am/pm marker | Text | PM |
| H | Hour in day (0-23) | Number | 0 |
| k | Hour in day (1-24) | Number | 24 |
| K | Hour in am/pm (0-11) | Number | 0 |
| h | Hour in am/pm (1-12) | Number | 12 |
| m | Minute in hour | Number | 30 |
| s | Second in minute | Number | 55 |
| S | Millisecond | Number | 978 |
| z | Time zone | General time zone | Pacific Standard Time; PST; GMT-08:00 |
| Z | Time zone | RFC 822 time zone | -0800 |
| X | Time zone | ISO 8601 time zone | -08; -0800; -08:00 |
| Input string | Pattern |
|---|---|
| 2001.07.04 AD at 12:08:56 PDT | yyyy.MM.dd G 'at' HH:mm:ss z |
| Wed, Jul 4, '01 | EEE, MMM d, ''yy |
| 12:08 PM | h:mm a |
| 12 o'clock PM, Pacific Daylight Time | hh 'o''clock' a, zzzz |
| 0:08 PM, PDT | K:mm a, z |
| 02001.July.04 AD 12:08 PM | yyyyy.MMMM.dd GGG hh:mm aaa |
| Wed, 4 Jul 2001 12:08:56 -0700 | EEE, d MMM yyyy HH:mm:ss Z |
| 010704120856-0700 | yyMMddHHmmssZ |
| 2001-07-04T12:08:56.235-0700 | yyyy-MM-dd'T'HH:mm:ss.SSSZ |
| 2001-07-04T12:08:56.235-07:00 | yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
| 2001-W27-3 | YYYY-'W'ww-u |
StringprojectRoot (optional)
StringtestAsUnit (optional)
booleanoutputPath (optional)
String$class: 'TestSwarmBuilder'testswarmServerUrl
StringjobName
StringuserName
StringauthToken
StringmaxRuns
StringchooseBrowsers
StringpollingIntervalInSecs
StringtimeOutPeriodInMins
StringminimumPassing
StringtestSuiteList
testName
StringtestUrl
StringtestCacheCracker
booleandisableTest
booleantestweaverprojectPath
StringexperimentName
StringjUnitReportDirectory
StringacceptInconclusiveWatchers (optional)
booleanexportAsCsvDecimalSeparator (optional)
StringexportAsCsvDirectory (optional)
StringexportAsCsvNoQuote (optional)
booleanexportAsCsvQuote (optional)
StringexportAsCsvReports (optional)
StringexportAsCsvSeparator (optional)
StringhtmlReportDirectory (optional)
StringinstrumentView (optional)
booleannamespacePattern (optional)
StringparameterValues (optional)
StringrunScenarioLimit (optional)
intrunTimeLimit (optional)
longsilverParameters (optional)
String$class: 'TesteinRunBuilder'targetType
StringtargetId
StringdownloadReport
booleandownloadLogs
boolean$class: 'TesteinUploadStepBuilder'enableJs
jsFilePath
StringjsonFilePath
StringenableJar
jarFilePath
Stringoverwrite
boolean$class: 'TestingBotBuilder'name
String$class: 'TestiniumPlugin'projectId (optional)
intplanId (optional)
intabortOnError (optional)
booleanabortOnFailed (optional)
booleanfailOnTimeout (optional)
booleanignoreInactive (optional)
booleantimeoutSeconds (optional)
int$class: 'TestopiaBuilder'testopiaInstallationName
StringtestRunId
intsingleBuildSteps
hudson.tasks.BuildStep)beforeIteratingAllTestCasesBuildSteps
hudson.tasks.BuildStep)iterativeBuildSteps
hudson.tasks.BuildStep)afterIteratingAllTestCasesBuildSteps
hudson.tasks.BuildStep)failedTestsMarkBuildAsFailure
booleanresultSeekers
$class: 'JUnitCaseClassNameResultSeeker'includePattern
String$class: 'JUnitCaseNameResultSeeker'includePattern
String$class: 'JUnitMethodNameResultSeeker'includePattern
String$class: 'JUnitSuiteNameResultSeeker'includePattern
String$class: 'TAPFileNameResultSeeker'includePattern
String$class: 'TestNGClassNameResultSeeker'includePattern
StringmarkSkippedTestAsBlocked
boolean$class: 'TestNGMethodNameResultSeeker'includePattern
StringmarkSkippedTestAsBlocked
boolean$class: 'TestNGSuiteNameResultSeeker'includePattern
StringmarkSkippedTestAsBlocked
booleanconvertTestsToRun| Framework | Linux shell |
| Maven Surefire | mvn clean -Dtest=$testsToRunConverted test |
| Maven Failsafe | mvn clean -Dit.test=$testsToRunConverted verify |
| Gradle | gradle test $testsToRunConverted |
| Protractor | protractor conf.js --grep="$testsToRunConverted" |
| Cucumber-JVM over Maven/ BDD Scenario |
mvn clean -Dcucumber.options="$testsToRunConverted" test |
| JBehave over Maven | mvn clean -Dfeatures="$testsToRunConverted" test |
| Framework | Windows batch command |
| Maven Surefire | mvn clean -Dtest=%testsToRunConverted% test |
| Maven Failsafe | mvn clean -Dit.test=%testsToRunConverted% verify |
| Gradle | gradle test %testsToRunConverted% |
| Protractor | protractor conf.js --grep="%testsToRunConverted%" |
| Cucumber-JVM over Maven/ BDD Scenario |
mvn clean -Dcucumber.options="%testsToRunConverted%" test |
| JBehave over Maven | mvn clean -Dfeatures="%testsToRunConverted%" test |
| Framework | Pipeline script |
| Maven Surefire | bat 'mvn clean -Dtest=${params.testsToRunConverted} test' |
| Maven Failsafe | bat 'mvn clean -Dit.test=${params.testsToRunConverted} verify' |
| Gradle | bat 'gradle test ${params.testsToRunConverted}' |
| Protractor | bat(/protractor conf.js --grep="${params.testsToRunConverted}"/) |
| Cucumber-JVM over Maven/ BDD Scenario |
bat(/mvn clean -Dcucumber.options="${params.testsToRunConverted}" test/) |
| JBehave over Maven | bat(/mvn clean -Dfeatures="${testsToRunConverted}" test/) |
framework
Stringformat
{
"testPattern": "$package.$class#$testName",
"testDelimiter": ","
}
"replacements": [
{
"type": "replaceRegex",
"target": "$package|$class|$testName",
"regex": "aaa",
"replacement": "bbb",
"description": "Replaces all the sequence of characters matching the regex with a replacement string."
},{
"type": "replaceRegexFirst",
"target": "$package|$class|$testName",
"regex": "aaa",
"replacement": "bbb",
"description": "Replaces the first substring that matches the given regex with the given replacement. For example, given regex '@(.*)@.*' , replacement '$1', and test name '@myTag@ my test name' - will replace test name by the content located between @, that is - 'myTag'."
},{
"type": "replaceString",
"target": "$package|$class|$testName",
"string": "xxx",
"replacement": "yyy",
"description": "Replaces all occurrences of ‘string’ with ‘replacement’."
},{
"type": "joinString",
"target": "$package|$class|$testName",
"prefix": "xxx",
"suffix": "yyy",
"description": "Add prefix and suffix to the test template."
},{
"type": "toLowerCase",
"target": "$package|$class|$testName",
"description": "Convert test template to lower case."
},{
"type": "toUpperCase",
"target": "$package|$class|$testName",
"description": "Convert test template to upper case."
},{
"type": "notLatinAndDigitToOctal",
"target": "$package|$class|$testName",
"description": "Replaces all non-latin characters and digits ^[a-zA-Z0-9] to their ASCII octal value."
}]
String$class: 'TestsigmaExecutionBuilder'apiEndPoint
StringapiKey
StringtestPlanId
StringmaxWaitInMinutes
StringreportsFilePath
String$class: 'TicsAnalyzer'ticsPath
C:\Program Files (x86)\TIOBE\TICS\BuildServer. This directory should contain the TICSQServer and TICSMaintenance executables. You can leave this field empty if these executables can be found on the PATH environment variable of the Jenkins slave user.StringticsConfiguration
C:\Program Files (x86)\TIOBE\TICS\FileServer\cfg. The TICS configuration directory contains the SERVER.txt and PROJECTS.txt configuration files, among others. This setting sets the TICS environment variable before executing TICSQServer. You can leave this field empty if this variable is already set on the Jenkins slave.StringprojectName
TICSMaintenance from the command line. Note that you can use Jenkins environment variables such as $JOB_NAME here.StringbranchName
StringbranchDirectory
TICSMaintenance -branchdir. Note that you can use Jenkins variables (such as $WORKSPACE) here.StringenvironmentVariables
$WORKSPACE here. Example:
TICS_M2_OPTS=-s C:\Tools\apache-maven\conf\settings.xml TICS_COVERITY_URL=http://localhost:8080 QACBIN=C:/QAC/common/bin PATH=C:\Tools\bin;$PATH
StringcreateTmpdir
booleantmpdir
C:/temp/$JOB_NAME.StringextraArguments
Stringcalc
ABSTRACTINTERPRETATION
booleanACCUCHANGERATE
booleanACCUFIXRATE
booleanACCULINESADDED
booleanACCULINESCHANGED
booleanACCULINESDELETED
booleanALL
booleanAVGCYCLOMATICCOMPLEXITY
booleanBUILDRELATIONS
booleanCHANGEDFILES
booleanCHANGERATE
booleanCODINGSTANDARD
booleanCOMPILERWARNING
booleanDEADCODE
booleanDUPLICATEDCODE
booleanELOC
booleanFANOUT
booleanFINALIZE
booleanFIXRATE
booleanGLOC
booleanINCLUDERELATIONS
booleanINTEGRATIONTESTCOVERAGE
booleanLINESADDED
booleanLINESCHANGED
booleanLINESDELETED
booleanLOC
booleanMAXCYCLOMATICCOMPLEXITY
booleanPREPARE
booleanSECURITY
booleanSYSTEMTESTCOVERAGE
booleanTOTALTESTCOVERAGE
booleanUNITTESTCOVERAGE
booleanrecalc
ABSTRACTINTERPRETATION
booleanACCUCHANGERATE
booleanACCUFIXRATE
booleanACCULINESADDED
booleanACCULINESCHANGED
booleanACCULINESDELETED
booleanALL
booleanAVGCYCLOMATICCOMPLEXITY
booleanBUILDRELATIONS
booleanCHANGEDFILES
booleanCHANGERATE
booleanCODINGSTANDARD
booleanCOMPILERWARNING
booleanDEADCODE
booleanDUPLICATEDCODE
booleanELOC
booleanFANOUT
booleanFINALIZE
booleanFIXRATE
booleanGLOC
booleanINCLUDERELATIONS
booleanINTEGRATIONTESTCOVERAGE
booleanLINESADDED
booleanLINESCHANGED
booleanLINESDELETED
booleanLOC
booleanMAXCYCLOMATICCOMPLEXITY
booleanPREPARE
booleanSECURITY
booleanSYSTEMTESTCOVERAGE
booleanTOTALTESTCOVERAGE
booleanUNITTESTCOVERAGE
booleanrunTicsprojectName
StringbranchName
StringbranchDirectory (optional)
Stringcalc (optional)
StringenvironmentVariables (optional)
java.util.LinkedHashMap<java.lang.String, java.lang.String>extraArguments (optional)
Stringrecalc (optional)
StringticsBin (optional)
StringticsConfiguration (optional)
Stringtmpdir (optional)
StringtotaltestUTconnectionId
StringcredentialsId
StringprojectFolder
StringtestSuite
Wild carding of test scenarios/suites names can be done using '*' for any characters and '?' for a single character. 'All_Scenarios' can be used to run all test scenarios or 'All_Suites' can be used to run all test suites.
Stringjcl
StringccClearStats (optional)
booleanccDB2 (optional)
booleanccPgmType (optional)
StringccRepo (optional)
StringccSystem (optional)
StringccTestId (optional)
StringdeleteTemp (optional)
booleanhlq (optional)
StringhostPort (optional)
Stringrecursive (optional)
booleanuseStubs (optional)
booleantotaltestenvironmentId
StringfolderPath
StringserverUrl
StringserverCredentialsId
StringconnectionId
StringcredentialsId
StringsonarVersion (optional)
StringlogLevel (optional)
StringaccountInfo (optional)
Use the accounting information field to enter an account number and any other accounting information that your installation requires.
The accounting information must be entered, just as it would be on the job card. Currently only 52 characters are allowed for the accounting information.
StringccThreshold (optional)
intclearCodeCoverage (optional)
booleancollectCCRepository (optional)
StringcollectCCSystem (optional)
StringcollectCCTestID (optional)
StringcollectCodeCoverage (optional)
booleancompareJUnits (optional)
booleancontextVariables (optional)
StringcreateJUnitReport (optional)
booleancreateReport (optional)
booleancreateResult (optional)
booleancreateSonarReport (optional)
booleancustomerId (optional)
StringenterpriseDataHostPort (optional)
StringenterpriseDataWorkspace (optional)
StringhaltAtFailure (optional)
booleanhaltPipelineOnFailure (optional)
booleanjclPath (optional)
StringjsonFile (optional)
Use the JSON file field to enter a JSON file containing the tests to execute.
Note: This field is only used for Total Test CLI version 20.04.01 and later
StringlocalConfig (optional)
booleanlocalConfigLocation (optional)
StringprogramList (optional)
Use the Test list field to enter a comma separated list of program names to be tested. Will only include test scenarios that have component under test defined as one of these
Note: This field is only used for Total Test CLI version 20.04.01 and later
Stringrecursive (optional)
booleanreportFolder (optional)
StringselectEnvironmentRadio (optional)
StringselectProgramsOption (optional)
booleanselectProgramsRadio (optional)
StringsiteId (optional)
StringsourceFolder (optional)
StringstopIfTestFailsOrThresholdReached (optional)
booleanuploadToServer (optional)
booleanuseEnterpriseData (optional)
booleanuseScenarios (optional)
boolean$class: 'ToxBuilder'toxIni
Stringrecreate
booleantoxenvPattern
StringtptExecuteexePaths
StringexecutionConfiguration
tptFile
Stringconfiguration
Stringid
StringenableTest (optional)
booleanreportDir (optional)
StringtestSet (optional)
StringtestdataDir (optional)
Stringtimeout (optional)
longarguments (optional)
StringenableJunit (optional)
booleanisTptMaster (optional)
booleanjUnitLogLevel (optional)
NONE, ERROR, WARNING, INFO, ALLjUnitreport (optional)
StringslaveJob (optional)
StringslaveJobCount (optional)
StringslaveJobTries (optional)
StringtptBindingName (optional)
StringtptPort (optional)
StringtptStartUpWaitTime (optional)
StringtptAgentexePaths
StringtptBindingName (optional)
StringtptPort (optional)
StringtptStartUpWaitTime (optional)
StringtricentisCInewTricentisClientPath
StringnewEndpoint
StringconfigurationFilePath (optional)
Specify the path to the Tricentis CI test execution configuration XML file. The test configuration file includes more details about which items you would like to execute.
If you use this setting, leave the TestEvents setting of this page empty. Otherwise, this build step fails.
Stringendpoint (optional)
Specify the address of the webservice. This component triggers the test execution.
If you execute your tests via Tosca Remote Service, the endpoint needs to point to the TOSCARemoteExecutionService (e.g. http://servername:8732/TOSCARemoteExecutionService/).
If you execute your tests via Tosca Distributed Execution, the endpoint needs to point to the Manager Service of the Tosca Distribution Server (e.g. http://servername:8732/DistributionServerService/ManagerService.svc).
StringtestEvents (optional)
Input the TestEvents that you want to execute, separated by semicolons. You can identify the TestEvents with their name or their system ID.
This field is optional. It can only be used if you execute your tests via Tosca Distributed Execution.
If you use this setting, leave the Configuration File setting of this page empty. Otherwise, this build step fails.
StringtricentisClientPath (optional)
Specify the path to the Tricentis CI test execution configuration XML file. The test configuration file includes more details about which items you would like to execute.
If you use this setting, leave the TestEvents setting of this page empty. Otherwise, this build step fails.
String$class: 'TriggerBuilder'configs
projects
Stringblock
buildStepFailureThreshold
StringunstableThreshold
StringfailureThreshold
StringconfigFactories
$class: 'AllNodesBuildParameterFactory'$class: 'AllNodesForLabelBuildParameterFactory'name
StringnodeLabel
StringignoreOfflineNodes
boolean$class: 'BinaryFileParameterFactory'This implementation does not interpret the contents of those files, and instead it simply gets passed and placed into the workspace of the triggered project(s) under the name specified here.
This is useful, for example, when you have a portion of the job that can be split into concurrently executable subtasks. In such a situation, you can have an earlier step produce subtask work units by packaging necessary stuff into individual files, then use this mode to execute them all in parallel.
parameterName
StringfilePattern
StringnoFilesFoundAction
SKIP, NOPARMS, FAIL$class: 'CounterBuildParameterFactory'from
Stringto
Stringstep
StringparamExpr
StringvalidationFail
FAIL, SKIP, NOPARMS$class: 'CounterGeneratorParameterFactory'from
Stringto
Stringstep
StringparamExpr
StringvalidationFail
FAIL, SKIP, NOPARMS$class: 'FileBuildParameterFactory'filePattern
Stringencoding
StringnoFilesFoundAction
SKIP, NOPARMS, FAIL$class: 'FileGeneratorParameterFactory'filePattern
StringnoFilesFoundAction
SKIP, NOPARMS, FAIL$class: 'MultipleBinaryFileParameterFactory'parametersList
class org.jenkinsci.plugins.parallel_test_executor.MultipleBinaryFileParameterFactory$ParameterBindingnoFilesFoundAction
SKIP, NOPARMS, FAIL$class: 'NodeListBuildParameterFactory'name
StringnodeListString
Stringconfigs
$class: 'BooleanParameters'configs
name
Stringvalue
boolean$class: 'CurrentBuildParameters'$class: 'FileBuildParameters'propertiesFile
Stringencoding
StringfailTriggerOnMissing
booleanuseMatrixChild
booleancombinationFilter
StringonlyExactRuns
booleantextParamValueOnNewLine
boolean$class: 'GeneratorCurrentParameters'$class: 'GitRevisionBuildParameters'combineQueuedCommits
boolean$class: 'MatrixSubsetBuildParameters'filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggered job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String$class: 'NodeLabelBuildParameter'name
StringnodeLabel
String$class: 'NodeParameters'$class: 'PredefinedBuildParameters'properties
StringtextParamValueOnNewLine
boolean$class: 'PredefinedGeneratorParameters'properties
String$class: 'SubversionRevisionBuildParameters'includeUpstreamParameters
boolean$class: 'TwitterPublisher'tokenCredentialsID
StringconsumerCredentialsID
StringtweetText
StringUiPathAssetsassetsAction
AutoVersionCurrentVersionDeleteAssetsDeployAssetsDynamicallyjobsCount
intuser
Stringmachine
StringExternalAppaccountForApp
StringapplicationId
StringapplicationSecret
StringapplicationScope
StringCustomVersionversion
StringNonProductionRobotrobotsIds
StringTestTestProjecttestProjectPath
Stringenvironments
StringTestSettestSet
StringTokencredentialsId
StringaccountName
StringUnattendedUserPasscredentialsId
StringorchestratorAddress
StringorchestratorTenant
StringfolderName
Stringcredentials
AutoVersionCurrentVersionDeleteAssetsDeployAssetsDynamicallyjobsCount
intuser
Stringmachine
StringExternalAppaccountForApp
StringapplicationId
StringapplicationSecret
StringapplicationScope
StringCustomVersionversion
StringNonProductionRobotrobotsIds
StringTestTestProjecttestProjectPath
Stringenvironments
StringTestSettestSet
StringTokencredentialsId
StringaccountName
StringUnattendedUserPasscredentialsId
StringfilePath
StringtraceLevel
None, Critical, Error, Warning, Information, VerboseUiPathPackversion
AutoVersionCurrentVersionDeleteAssetsDeployAssetsDynamicallyjobsCount
intuser
Stringmachine
StringExternalAppaccountForApp
StringapplicationId
StringapplicationSecret
StringapplicationScope
StringCustomVersionversion
StringNonProductionRobotrobotsIds
StringTestTestProjecttestProjectPath
Stringenvironments
StringTestSettestSet
StringTokencredentialsId
StringaccountName
StringUnattendedUserPasscredentialsId
StringprojectJsonPath
StringoutputPath
StringtraceLevel
None, Critical, Error, Warning, Information, Verbosecredentials (optional)
AutoVersionCurrentVersionDeleteAssetsDeployAssetsDynamicallyjobsCount
intuser
Stringmachine
StringExternalAppaccountForApp
StringapplicationId
StringapplicationSecret
StringapplicationScope
StringCustomVersionversion
StringNonProductionRobotrobotsIds
StringTestTestProjecttestProjectPath
Stringenvironments
StringTestSettestSet
StringTokencredentialsId
StringaccountName
StringUnattendedUserPasscredentialsId
StringorchestratorAddress (optional)
StringorchestratorTenant (optional)
StringoutputType (optional)
StringrunWorkflowAnalysis (optional)
booleanuseOrchestrator (optional)
boolean$class: 'UnicornValidationBuilder'unicornUrl
StringsiteUrl
StringmaxErrorsForStable
StringmaxWarningsForStable
StringmaxErrorsForUnstable
StringmaxWarningsForUnstable
String$class: 'UninstallBuilder'packageId
StringfailOnUninstallFailure
boolean$class: 'Unity3dBuilder'For projects that use Unity3d as the build system.
This causes Jenkins to invoke the Unity3d Editor with the given command line arguments.
A non-zero exit code from Unity3d makes Jenkins mark the build as a failure.
unity3dName
StringargLine
-quit -batchmode -executeMethod YourEditorScript.YourBuildMethod [-nographics] or
-quit -batchmode -buildWindowsPlayer path/to/your/build.exe or
-quit -batchmode -buildOSXPlayer path/to/your/build.app
If this value isn't set, the globalArgLine is used.
Note: we make little to no attempt to detect conflicting arguments or arguments not suitable to the platform neither at configuration nor at runtime.
If the specified command line contains no -projectpath argument, the plugin automatically adds one with the proper parameter (the workspace of the project on the target machine). This is to make sure unity builds the proper project. Otherwise unity would reuse the last opened project. You can override it, but this hasn't been thoroughly tested.
If your build agent have multiple executors (which you should probably do), it is highly recommended to make use of a -logFile argument to avoid letting Unityed write to the standard editor.log concurrently. A recommended practise is to use something like -logFile "$WORKSPACE/unity3d_editor.log".
See the official Editor command line arguments documentation.
StringunstableReturnCodes
Stringunshelveshelf
Stringresolve
Stringtidy
booleanignoreEmpty
booleantpAppUpdateFileprojectId (optional)
StringappId (optional)
StringfilePath (optional)
StringtpAppUpdateURLprojectId (optional)
StringappId (optional)
StringapplicationUrl (optional)
String$class: 'UpdateBox'cloud
Stringworkspace
Stringbox
Stringvariables
StringtpDataSourceUpdateprojectId (optional)
StringdataSourceId (optional)
StringfilePath (optional)
StringazureVMSSUpdateInstancesazureCredentialsId
StringresourceGroup
Stringname
StringinstanceIds
,'.
String$class: 'UpdatePriority'prefix
Stringpriority
String$class: 'UpdateProjectBuilder'tpProjectParamUpdateprojectId (optional)
StringparameterId (optional)
StringparameterValue (optional)
String$class: 'UpdateReleaseStage'releasePrefix
Stringstage
String$class: 'UpdateStatus'prefix
Stringstatus
StringtpTestPackageUpdateprojectId (optional)
StringtestPackageId (optional)
StringfilePath (optional)
StringresolveConflicts (optional)
booleanupdraftPublishurl
Stringpath
String$class: 'UploadAppBuildStep'applicationLocation
StringkeystoreInfo
keystoreLocation
StringkeystorePassword
StringkeyAlias
StringkeyPassword
StringextraArguments
touchId
booleancamera
booleanallowResign
booleanuuid
StringuniqueName
String$class: 'UploadAppBuilder'mcServerName
StringmcUserName
StringmcPassword
StringmcTenantId
StringproxySettings
fsUseAuthentication
booleanfsProxyAddress
StringfsProxyUserName
StringfsProxyPassword
class hudson.util.SecretapplicationPaths
mcAppPath
StringuploadCloudifyBlueprintUse this step to upload a blueprint to Cloudify Manager.
Two paramters are mandatory:
In addition, exactly one of the following parameters is mandatory:
If you provide a blueprint's root directory, then the entire directory contents are packaged into a blueprint archive.
archivePath (optional)
StringarchiveUrl (optional)
StringblueprintId (optional)
StringcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringmainFileName (optional)
StringrootDirectory (optional)
Stringtenant (optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String$class: 'UploadBuild'tenantId
Stringid
Stringname
StringversionName
Stringrevision
Stringrequestor
Stringstatus
StringstartTime
StringendTime
StringappName
StringappId
StringappExtId
Stringdebug
booleanfatal
booleanupload-pgyeruKey
StringapiKey
StringscanDir
Stringwildcard
StringinstallType
Stringpassword
StringupdateDescription
StringchannelShortcut
StringqrcodePath
StringenvVarsPath
Stringupload-pgyer-v2apiKey
StringscanDir
Stringwildcard
StringbuildName
StringbuildInstallType
StringbuildPassword
StringbuildUpdateDescription
StringbuildChannelShortcut
StringqrcodePath
StringenvVarsPath
String$class: 'UploadDeployment'id
StringtenantId
Stringname
Stringresult
Stringinitiator
StringversionName
StringversionExtId
Stringtype
StringenvironmentId
StringenvironmentName
Stringdescription
StringstartTime
StringendTime
StringappName
StringappId
StringappExtId
Stringdebug
booleanfatal
boolean$class: 'UploadJUnitTestResult'properties
java.util.Map<java.lang.String, java.lang.String>$class: 'UploadMetricsFile'tenantId
Stringname
StringfilePath
StringtestSetName
Stringenvironment
StringcombineTestSuites
booleanfatal
booleandebug
booleanpluginType
StringdataFormat
StringrecordName
StringmetricDefinitionId
StringmetricsRecordUrl
Stringdescription
StringexecutionDate
StringbuildId
StringbuildUrl
StringappId
StringappName
StringappExtId
StringuploadProgetPackagefeedName
StringgroupName
A string of no more than fifty characters:
StringpackageName
A string of no more than fifty characters:
Stringversion
Stringartifacts
Removing Unwanted Folders
Top level folders can be excluded from the package using a custom addition to the Ant fileset - wrapping unwanted folder names in square brackets ([ ]):
StringcaseSensitive (optional)
org.apache.tools.ant.DirectoryScanner which by default is case sensitive. For instance, if the job produces *.hpi files, pattern "**/*.HPI" will fail to find them.
booleandefaultExcludes (optional)
booleandependencies (optional)
Stringdescription (optional)
Stringexcludes (optional)
Stringicon (optional)
Stringmetadata (optional)
If you need to add additional metadata, it's strongly recommended that you prefix these properties with an underscore (_) on the off-chance that a property you add will exist in a future version of the specification.
Stringtitle (optional)
A string of no more than fifty characters
StringuploadCloudifyBlueprintcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringoutputLocation (optional)
Stringtenant (optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
StringwagonLocation (optional)
StringyamlLocation (optional)
plugin.yaml file of the plugin.
String$class: 'UpmergeBuilder'commitUsername
StringuTesterUrlListTaskinitialUrl
StringurlsWhiteList
StringrulesList
rule
StringcomplianceMinimum
floatallowSimultaneousLogins
booleanloginFlowJson
StringuseRunner
booleanfetchResponseTimeout
intuseMangouseSlaveNodes
StringnodeLabel
StringprojectId
Stringtags
StringtestName
StringtestStatus
StringassignedTo
Stringvb6projectFile
StringcompileConstants (optional)
StringoutDir (optional)
StringvCommanderaction
$class: 'VCommanderRequestNewServiceAction'payload
Stringsync
booleantimeout
longpolling
long$class: 'VCommanderRunWorkflowAction'targetType
StringtargetName
StringworkflowName
Stringsync
booleantimeout
longpolling
long$class: 'VCommanderWaitForRequestNewServiceAction'requestId
Stringtimeout
longpolling
long$class: 'VCommanderWaitForRunWorkflowAction'taskId
Stringtimeout
longpolling
long$class: 'VMGRAPI'vAPIUrl
StringvAPIUser
StringvAPIPassword
StringvAPIInput
StringvJsonInputFile
StringdeleteInputFile
booleanauthRequired
booleanapiType
StringdynamicUserId
booleanapiUrl
StringrequestMethod
StringadvConfig
booleanconnTimeout
intreadTimeout
int$class: 'VMGRLaunch'vAPIUrl
StringvAPIUser
StringvAPIPassword
StringvSIFName
StringvSIFInputFile
StringcredentialInputFile
StringdeleteInputFile
booleandeleteCredentialInputFile
booleanuseUserOnFarm
booleanauthRequired
booleanvsifType
StringuserFarmType
StringdynamicUserId
booleanadvConfig
booleanconnTimeout
intreadTimeout
intenvVarible
booleanenvVaribleFile
StringinaccessibleResolver
StringstoppedResolver
StringfailedResolver
StringdoneResolver
StringsuspendedResolver
StringwaitTillSessionEnds
booleanstepSessionTimeout
intgenerateJUnitXML
booleanextraAttributesForFailures
booleanstaticAttributeList
StringmarkBuildAsFailedIfAllRunFailed
booleanfailJobIfAllRunFailed
booleanenvSourceInputFile
StringvMGRBuildArchive
booleandeleteAlsoSessionDirectory
booleangenericCredentialForSessionDelete
booleanarchiveUser
StringarchivePassword
StringfamMode
StringfamModeLocation
StringnoAppendSeed
booleanmarkBuildAsPassedIfAllRunPassed
booleanfailJobUnlessAllRunPassed
booleanuserPrivateSSHKey
booleanattrValues
booleanattrValuesFile
StringexecutionType
StringsessionsInputFile
StringdeleteSessionInputFile
booleanenvVariableType
StringenvVariableText
StringattrVariableType
StringattrVariableText
StringpauseSessionOnBuildInterruption
booleanenvSourceInputFileType
StringexecutionScript
StringexecutionShellLocation
StringexecutionVsifFile
StringdefineVaribleFile
StringdefineVarible
booleandefineVariableType
StringdefineVariableText
String$class: 'VSphereBuildStepContainer'buildStep
$class: 'Clone'sourceName
Stringclone
StringlinkedClone
booleanresourcePool
Stringcluster
Stringdatastore
Stringfolder
StringpowerOn
booleantimeoutInSeconds
intcustomizationSpec
String$class: 'ConvertToTemplate'vm
Stringforce
boolean$class: 'ConvertToVm'template
StringresourcePool
Stringcluster
String$class: 'Delete'vm
StringfailOnNoExist
boolean$class: 'DeleteSnapshot'vm
StringsnapshotName
Stringconsolidate
booleanfailOnNoExist
boolean$class: 'Deploy'template
Stringclone
StringlinkedClone
booleanresourcePool
Stringcluster
Stringdatastore
Stringfolder
StringcustomizationSpec
StringtimeoutInSeconds
intpowerOn
boolean$class: 'ExposeGuestInfo'vm
StringenvVariablePrefix
StringwaitForIp4
boolean$class: 'PowerOff'vm
StringevenIfSuspended
booleanshutdownGracefully
booleanignoreIfNotExists
booleangracefulShutdownTimeout (optional)
int$class: 'PowerOn'vm
StringtimeoutInSeconds
int$class: 'Reconfigure'vm
StringreconfigureSteps
$class: 'ReconfigureAnnotation'annotation (optional)
Stringappend (optional)
boolean$class: 'ReconfigureCpu'cpuCores
StringcoresPerSocket
String$class: 'ReconfigureDisk'diskSize
Stringdatastore
String$class: 'ReconfigureMemory'memorySize
String$class: 'ReconfigureNetworkAdapters'deviceAction
ADD, EDIT, REMOVEdeviceLabel
StringmacAddress
StringstandardSwitch
booleanportGroup
StringdistributedSwitch
booleandistributedPortGroup
StringdistributedPortId
String$class: 'Rename'oldName
StringnewName
String$class: 'RenameSnapshot'vm
StringoldName
StringnewName
StringnewDescription
String$class: 'RevertToSnapshot'vm
StringsnapshotName
String$class: 'SuspendVm'vm
String$class: 'TakeSnapshot'vm
StringsnapshotName
Stringdescription
StringincludeMemory
booleanserverName
String$class: 'VaddyPlugin'host
StringuserId
StringauthKey
StringcrawlId
StringapiServerUrl
StringproxyHost
StringproxyPort
String$class: 'VagrantDestroyCommand'vagrantFile
StringvagrantVm
String$class: 'VagrantProvisionCommand'vagrantFile
StringvagrantVm
Stringprovisioners
Stringparallel
boolean$class: 'VagrantSshCommand'vagrantFile
StringvagrantVm
Stringcommand
StringasRoot
boolean$class: 'VagrantUpCommand'vagrantFile
StringvagrantVm
StringdestroyOnError
booleanprovider
StringdontKillMe
boolean$class: 'ValgrindBuilder'valgrindExecutable
StringworkingDirectory
StringincludePattern
StringexcludePattern
StringoutputDirectory
StringoutputFileEnding
StringprogramOptions
Stringtool
$class: 'ValgrindToolHelgrind'historyLevel
String$class: 'ValgrindToolMemcheck'showReachable
booleanundefinedValueErrors
booleanleakCheckLevel
StringtrackOrigins
booleanvalgrindOptions
StringignoreExitCode
booleantraceChildren
booleanchildSilentAfterFork
booleangenerateSuppressions
booleansuppressionFiles
StringremoveOldReports
booleancrxValidatepackageIdFilters (optional)
**/*.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 validated in the order in which the filters are specified. At least one package must match each filter or the step will fail.
StringallowNonCoveredRoots (optional)
booleanforbiddenACHandlingModeSet (optional)
StringforbiddenExtensions (optional)
.jar
.zip
This field supports parameter tokens.
StringforbiddenFilterRootPrefixes (optional)
/apps/system
/apps/system/config
/apps/systemOfADown/config
StringlocalDirectory (optional)
StringpathsDeniedForInclusion (optional)
/apps/system/rep:policy
/etc/map/http/site_root_redirect
Use this test to safeguard specific paths or possible paths within unrestricted roots from overly broad workspace filters.
StringvalidationFilter (optional)
/etc # define /etc as the filter root
-/etc/packages(/.)? # exclude package paths
This field supports parameter tokens.
String$class: 'Validator'stack
Stringbranch
StringapiKey
StringcontentReplaceconfigs (optional)
filePath
StringfileEncoding
StringvariablesPrefix
StringvariablesSuffix
StringemptyValue
Stringconfigs
name
Stringvalue
String$class: 'VectorCASTCommand'winCommand
StringunixCommand
String$class: 'VectorCASTSetup'environmentSetupWin
StringenvironmentSetupUnix
StringexecutePreambleWin
StringexecutePreambleUnix
StringenvironmentTeardownWin
StringenvironmentTeardownUnix
StringoptionUseReporting
booleanoptionErrorLevel
StringoptionHtmlBuildDesc
StringoptionExecutionReport
booleanoptionClean
booleanwaitLoops
longwaitTime
longmanageProjectName
StringjobName
StringnodeLabel
String$class: 'ViberNotifier'token (optional)
Stringsender (optional)
Stringmessage (optional)
String$class: 'ViewCloner'url
StringreplacePatternString
StringniewViewName
Stringpassword
Stringusername
String$class: 'VirtualenvBuilder'pythonName
Stringhome
Stringclear
booleansystemSitePackages
booleannature
Stringcommand
StringignoreExitCode
booleanvisualexpertinstallPath
StringprojectName
StringdoAnalysis
booleancreateReferenceDocument
booleancreateCodeReviewDocument
boolean$class: 'VsCodeMetricsBuilder'toolName
Stringfiles
Assembly file(s) to analyze.
You can specify multiple analyze assemblies by separating them with new-line or space.
Command Line Argument: /file:[ assembly file path ]
StringoutputXML
Metrics results XML output file.
Command Line Argument: /out:[ output file path ]
Stringdirectory
Location to search for assembly dependencies.
You can specify multiple directories by separating them with new-line or space.
Command Line Argument: /directory:[ directory ]
StringsearchGac
Search the Global Assembly Cache for missing references.
Command Line Argument: /searchgac
booleanplatform
Location of framework assemblies, such as mscorlib.dll.
Command Line Argument: /platform:[ directory ]
Stringreference
Reference assemblies required for analysis.
You can specify multiple reference assemblies by separating them with new-line or space.
Command Line Argument: /reference:[ assembly file path ]
StringignoreInvalidTargets
Silently ignore invalid target files.
Command Line Argument: /ignoreinvalidtargets
booleanignoreGeneratedCode
Suppress analysis results against generated code.
Command Line Argument: /ignoregeneratedcode
booleancmdLineArgs
StringfailBuild
booleanvsTestcmdLineArgs (optional)
Stringenablecodecoverage (optional)
Enables data diagnostic adapter CodeCoverage in the test run.
Default settings are used if not specified using settings file.
Command Line Argument: /Enablecodecoverage
booleanfailBuild (optional)
booleanframework (optional)
Target .NET Framework version to be used for test execution.
Valid values are Framework35, Framework40 and Framework45.
Command Line Argument: /Framework: [ framework version ]
StringinIsolation (optional)
Runs the tests in an isolated process.
This makes vstest.console.exe process less likely to be stopped on an error in the tests, but tests might run slower.
booleanlogger (optional)
Specify a logger for test results. For example, to log results into a Visual Studio Test Results File (TRX) use /Logger:trx.
Command Line Argument: /Logger:[ uri/friendlyname ]
Stringplatform (optional)
Target platform architecture to be used for test execution.
Valid values are x86, x64 and ARM.
Stringsettings (optional)
Run tests with additional settings such as data collectors.
Example: Local.RunSettings
Command Line Argument: /Settings:[ file name ]
StringtestCaseFilter (optional)
Run tests that match the given expression.
<Expression> is of the format <property>=<value>[||<Expression>].
Example: TestCategory=Nightly||Name=Namespace.ClassName.MethodName
The TestCaseFilter command line option cannot be used with the Tests command line option.
Command Line Argument: /TestCaseFilter:[ expression ]
StringtestFiles (optional)
Specify the path to your VSTest compiled assemblies.
You can specify multiple test assemblies by separating them with new-line or space.
Stringtests (optional)
Run tests with names that match the provided values.
To provide multiple values, separate them by commas.
Example: TestMethod1,testMethod2
The /Tests command line option cannot be used with the /TestCaseFilter command line option.
Command Line Argument: /Tests:[ test name ]
StringuseVs2017Plus (optional)
This makes adjustments to the arguments for the sake of compatibility with Visual Studio 2017+.
Command Line Argument: /UseVs2017Plus:true
booleanuseVsixExtensions (optional)
This makes vstest.console.exe process use or skip the VSIX extensions installed (if any) in the test run.
Command Line Argument: /UseVsixExtensions:true
booleanvsTestName (optional)
String$class: 'WASBuildStep'additionalClasspath
StringappendTrace
booleancommands
StringjavaOptions
StringjobId
Stringlanguage
StringprofileScriptFiles
StringpropertiesFiles
StringrunIf
true.StringscriptFile
StringscriptParameters
StringtraceFile
StringwasServerName
Stringuser
Stringpassword
StringgreetprojectId
StringappPath
StringscriptPath
StringgroupId
Stringtimeout
The timeout of this test run.The default value is 60 minutes.
StringframeType
StringcaseTimeout
The timeout of each device running in your test.The default value is 10 minutes.
StringtargetOsType
String$class: 'WakeUpIOSDevice'url
StringcloudTestServerID
StringadditionalOptions
String$class: 'WallarmFastBuilder'appHost
StringappPort
StringfastPort
StringfastName
StringpolicyId
inttestRecordId
intwallarmApiHost
StringtestRunName
StringtestRunDesc
Stringrecord
booleanstopOnFirstFail
booleanfailBuild
booleanwithoutSudo
booleanlocalDockerNetwork
StringlocalDockerIp
StringwallarmVersion
StringfileExtensionsToExclude
StringinactivityTimeout
inttestRunRps
intwallarmApiToken (optional)
String$class: 'WarriorPluginBuilder'configType
StringgitConfigUrl
StringgitConfigCredentials
booleangitConfigTagValue
StringgitConfigCloneType
StringgitConfigUname
StringgitConfigPwd
StringgitConfigFile
StringsftpConfigIp
StringsftpConfigUname
StringsftpConfigPwd
StringsftpConfigFile
StringpythonPath
StringuploadExecLog
booleanuploadServerIp
StringuploadServerUname
StringuploadServerPwd
StringuploadServerType
StringuploadServerDir
StringrunFiles
runFile
Stringwattspeedtoken
class hudson.util.Secretprojects
int$class: 'WebLoadAnalyticsBuilder'inputLsFile
StringportfolioFile
Stringformat
JUNIT, HTML, DOC, ODT, XLS, XLSX, RTF, PDF, CSV, RAWlocation
StringreportName
StringcompareToSessions
StringcompareToPreviousBuilds
int$class: 'WebLoadConsoleBuilder'tplFile
StringlsFile
StringexecutionDuration
longvirtualClients
longprobindClient
long$class: 'WildflyBuilder'war
Stringhost
Stringport
Stringusername
Stringpassword
Stringserver
String$class: 'WinBatchBuildStep'buildStepId
StringdefineArgs
booleanbuildStepArgs
arg
String$class: 'WinDocksBuilder'ipaddress
Stringimage
StringwinRMClienthostName
StringcredentialsId
StringwinRMOperations
invokeCommandcommand
StringsendFilesource
Stringdestination
StringconfigurationName
String$class: 'WixToolsetBuilder'sources
StringmarkAsUnstable
booleancompileOnly
booleanuseUiExt
booleanuseUtilExt
booleanuseBalExt
booleanuseComPlusExt
booleanuseDependencyExt
booleanuseDifxAppExt
booleanuseDirectXExt
booleanuseFirewallExt
booleanuseGamingExt
booleanuseIISExt
booleanuseMsmqExt
booleanuseNetfxExt
booleanusePsExt
booleanuseSqlExt
booleanuseTagExt
booleanuseVsExt
booleanmsiOutput
Enter a name for the generated MSI/EXE package. If left blank, the MSI package is named setup.msi. You can also use the file ending *.exe. But keep in mind, that you have to create a Bootstrapper and activeate the BalExtension to create an Executable.
You can use environment variables like $GIT_BRANCH to define a package name.
Stringarch
String$class: 'WsapBuilder'wsapLocation
StringenvVar
StringcredentialsId
StringtargetUrl
StringipAddress
Stringport
intapiKey
StringsastAnalysis
target
StringdastAnalysis
scanMethod
scan
StringapiUrl
StringapiDefinition
StringincludeUrls
$class: 'DASTAnalysis'$class: 'ExcludeEntry'url
String$class: 'HeaderEntry'header
Stringvalue
String$class: 'IncludeEntry'url
String$class: 'LoginProperties'useLogin
booleanloginUrl
StringrequestJson
StringusernameField
StringpasswordField
StringloggedInRegex
StringloggedOutRegex
Stringheaders
$class: 'DASTAnalysis'$class: 'ExcludeEntry'url
String$class: 'HeaderEntry'header
Stringvalue
String$class: 'IncludeEntry'url
String$class: 'LoginProperties'$class: 'SASTAnalysis'target
String$class: 'ScanMethod'scan
StringapiUrl
StringapiDefinition
String$class: 'UserEntry'username
Stringpassword
Stringusers
$class: 'DASTAnalysis'$class: 'ExcludeEntry'url
String$class: 'HeaderEntry'header
Stringvalue
String$class: 'IncludeEntry'url
String$class: 'LoginProperties'$class: 'SASTAnalysis'target
String$class: 'ScanMethod'scan
StringapiUrl
StringapiDefinition
String$class: 'UserEntry'username
Stringpassword
String$class: 'SASTAnalysis'target
String$class: 'ScanMethod'scan
StringapiUrl
StringapiDefinition
String$class: 'UserEntry'username
Stringpassword
StringexcludeUrls
$class: 'DASTAnalysis'$class: 'ExcludeEntry'url
String$class: 'HeaderEntry'header
Stringvalue
String$class: 'IncludeEntry'url
String$class: 'LoginProperties'useLogin
booleanloginUrl
StringrequestJson
StringusernameField
StringpasswordField
StringloggedInRegex
StringloggedOutRegex
Stringheaders
$class: 'DASTAnalysis'$class: 'ExcludeEntry'url
String$class: 'HeaderEntry'header
Stringvalue
String$class: 'IncludeEntry'url
String$class: 'LoginProperties'$class: 'SASTAnalysis'target
String$class: 'ScanMethod'scan
StringapiUrl
StringapiDefinition
String$class: 'UserEntry'username
Stringpassword
Stringusers
$class: 'DASTAnalysis'$class: 'ExcludeEntry'url
String$class: 'HeaderEntry'header
Stringvalue
String$class: 'IncludeEntry'url
String$class: 'LoginProperties'$class: 'SASTAnalysis'target
String$class: 'ScanMethod'scan
StringapiUrl
StringapiDefinition
String$class: 'UserEntry'username
Stringpassword
String$class: 'SASTAnalysis'target
String$class: 'ScanMethod'scan
StringapiUrl
StringapiDefinition
String$class: 'UserEntry'username
Stringpassword
StringloginProperties
useLogin
booleanloginUrl
StringrequestJson
StringusernameField
StringpasswordField
StringloggedInRegex
StringloggedOutRegex
Stringheaders
$class: 'DASTAnalysis'$class: 'ExcludeEntry'url
String$class: 'HeaderEntry'header
Stringvalue
String$class: 'IncludeEntry'url
String$class: 'LoginProperties'$class: 'SASTAnalysis'target
String$class: 'ScanMethod'scan
StringapiUrl
StringapiDefinition
String$class: 'UserEntry'username
Stringpassword
Stringusers
$class: 'DASTAnalysis'$class: 'ExcludeEntry'url
String$class: 'HeaderEntry'header
Stringvalue
String$class: 'IncludeEntry'url
String$class: 'LoginProperties'$class: 'SASTAnalysis'target
String$class: 'ScanMethod'scan
StringapiUrl
StringapiDefinition
String$class: 'UserEntry'username
Stringpassword
StringxcodeBuildallowFailingBuildResults (optional)
Checking this option will prevent a build step from failing if xcodebuild exits with a non-zero return code.
This can be useful for build steps that run unit tests and also have a post-build task to publish unit test results: the test step will not fail the entire build for a failing unit test, but will instead mark the build unstable in the "publish test" phase.
booleanappURL (optional)
StringassetPackManifestURL (optional)
StringassetPacksBaseURL (optional)
StringassetPacksInBundle (optional)
booleanbuildDir (optional)
The value to use for the BUILD_DIR setting. You only need to supply this value if you want the product of the Xcode build to be in a location other than the one specified in project settings and this job 'SYMROOT' parameter.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/build
StringbuildIpa (optional)
Checking this option will create a .ipa for each .app found in the build directory.
An .ipa is basically a zipped up .app.
This is quite handy for distributing ad-hoc builds to testers as they can just double-click the .ipa and it will import into iTunes.
booleanbundleID (optional)
The new bundle ID. Usually something like com.companyname.projectname.
StringbundleIDInfoPlistPath (optional)
The path to the info.plist file which contains the CFBundleIdentifier of your project.
Usually something like:
StringcfBundleShortVersionStringValue (optional)
This will set the CFBundleShortVersionString to the specified string.
Supports all macros and also environment and build variables from the Token Macro Plugin.
StringcfBundleVersionValue (optional)
This will set the CFBundleVersion to the specified string.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example the value ${BUILD_NUMBER} will be replaced with the current build number.
We advice you to generate a unique value for each build if you want for example deploy it into a private store.
In that case, for example, you can use : ${JOB_NAME}-${BUILD_NUMBER}
StringchangeBundleID (optional)
Checking this option will replace the bundle identifier.
You will need to specify which bundle ID (CFBundleIdentifier) to use and where is the Info.plist file located.
This is handy for example when you want to use a different code signing identity in your development projects.
booleancleanBeforeBuild (optional)
This will delete the build directories before invoking the build. This will force the rebuilding of ALL dependencies and can make large projects take a lot longer.
booleancleanResultBundlePath (optional)
This will delete the ResultBundlePath before invoking the build.
If the directory already exists in the location specified by ResultBundlePath, xcodebuild will be an error and should be checked.
booleancleanTestReports (optional)
booleancompileBitcode (optional)
booleanconfiguration (optional)
This is the name of the configuration as defined in the Xcode project.
By default there are Debug and Release configurations.
StringcopyProvisioningProfile (optional)
booleandevelopmentTeamID (optional)
StringdevelopmentTeamName (optional)
StringdisplayImageURL (optional)
StringfullSizeImageURL (optional)
StringgenerateArchive (optional)
Checking this option will create an .xcarchive .app found in the build directory.
An .xcarchive is useful for submission to the app store or third party crash reporters.
You must specify a Scheme to perform an archive.
booleanignoreTestResults (optional)
booleaninterpretTargetAsRegEx (optional)
Build all entries listed under the "Targets:" section of the xcodebuild -list output that match the regexp.
booleanipaExportMethod (optional)
StringipaName (optional)
StringipaOutputDirectory (optional)
StringkeychainId (optional)
StringkeychainName (optional)
The name of this configured keychain. Each job will specify a keychain configuration by the name.
StringkeychainPath (optional)
The path of the keychain to use to retrieve certificates to sign the package (default : ${HOME}/Library/Keychains/login.keychain).
StringkeychainPwd (optional)
The password of the keychain to use to retrieve certificates to sign the package.
class hudson.util.SecretlogfileOutputDirectory (optional)
Specify the directory to output the log of xcodebuild.
If you leave it blank, it will be output to "project directory/builds/${BUILD_NUMBER}/log" with other logs.
If an output path is specified, it is output as a xcodebuild.log file in a relative directory under the "build output directory"
StringmanualSigning (optional)
booleannoConsoleLog (optional)
booleanprovideApplicationVersion (optional)
booleanprovisioningProfiles (optional)
provisioningProfileAppId
StringprovisioningProfileUUID
StringresultBundlePath (optional)
Specify the directory to output the output the test result.
If you leave it blank, it will not output a test result and will not analyze the test results.
If an output path is specified, it is output as a test result in a relative directory under the "ResultBundlePath".
The plug-in analyzes the test result here and outputs a JUnit compatible XML file under the ${WORKSPACE}/test-reports.
Stringsdk (optional)
You only need to supply this value if you want to specify the SDK to build against. If empty, the SDK will be determined by Xcode. If you wish to run OCUnit tests, you will need to use the iPhone Simulator's SDK, for example:
/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator4.1.sdk/
StringsigningMethod (optional)
StringstripSwiftSymbols (optional)
booleansymRoot (optional)
You only need to supply this value if you want to specify the SYMROOT path to use.
If empty, the default SYMROOT path will be used (it could be different depending of your Xcode version).
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/symroot
Stringtarget (optional)
The target to build. If left empty, this will build all targets in the project.
If you wish to build your binary and the unit test module, it is best to do this as two separate steps each with their own target.
This was, the iPhone Simulator SDK can be specified for the unit tests.
Stringthinning (optional)
StringunlockKeychain (optional)
booleanuploadBitcode (optional)
booleanuploadSymbols (optional)
booleanuseLegacyBuildSystem (optional)
Instead of "New Builld System" which became available from Xcode 9, we build the application using the legacy build system.
There is a possibility that you can handle old projects that cause problems with the new build system.
Also, since new output formats of logs are changed in the new build system, it is also useful when you want to handle logs with legacy third party tools.
booleanxcodeName (optional)
StringxcodeProjectFile (optional)
StringxcodeProjectPath (optional)
StringxcodeSchema (optional)
StringxcodeWorkspaceFile (optional)
StringxcodebuildArguments (optional)
Extra xcodebuild parameters, added after the command that jenkins generates based on the rest of the config
String$class: 'XFramiumBuilder'configFile
StringsuiteName
StringtestNames
StringtagNames
StringstepTags
StringdeviceTags
StringdefaultCloud
StringoverrideDefaults
boolean$class: 'XLRVarSetterBuilder'XLR_releaseId
StringXLR_varName
StringJKS_varName
Stringdebug
booleanosfBuilderSuiteXMLLintxsdsPath (optional)
StringxmlsPath (optional)
StringreportPath (optional)
String$class: 'XShellBuilder'commandLine
StringexecuteFromWorkingDir
booleanregexToKill
StringtimeAllocated
String$class: 'XrayExportBuilder'serverInstance
Stringissues
Stringfilter
StringfilePath
StringcredentialId
Stringfields (optional)
java.util.Map<java.lang.String, java.lang.String>xrayInstance (optional)
configID
Stringalias
Stringhosting
SERVER, CLOUDserverAddress
StringcredentialId
String$class: 'XrayImportFeatureBuilder'serverInstance
StringfolderPath
StringprojectKey
StringtestInfo
Stringpreconditions
StringcredentialId
StringlastModified (optional)
Stringyarncommand
StringworkspaceSubdirectory (optional)
String$class: 'ZAPBuilder'startZAPFirst
booleanzapHost
StringzapPort
Stringzaproxy
autoInstall
booleantoolUsed
StringzapHome
Stringjdk
Stringtimeout
intzapSettingsDir
StringautoLoadSession
booleanloadSession
StringsessionFilename
StringremoveExternalSites
booleaninternalSites
StringcontextName
StringincludedURL
StringexcludedURL
StringalertFilters
StringauthMode
booleanusername
Stringpassword
StringloggedInIndicator
StringloggedOutIndicator
StringauthMethod
StringloginURL
StringusernameParameter
StringpasswordParameter
StringextraPostData
StringauthScript
StringauthScriptParams
scriptParameterName
StringscriptParameterValue
StringtargetURL
StringspiderScanURL
booleanspiderScanRecurse
booleanspiderScanSubtreeOnly
booleanspiderScanMaxChildrenToCrawl
intajaxSpiderURL
booleanajaxSpiderInScopeOnly
booleanactiveScanURL
booleanactiveScanRecurse
booleanactiveScanPolicy
StringgenerateReports
booleanselectedReportMethod
StringdeleteReports
booleanreportFilename
StringselectedReportFormats
StringselectedExportFormats
StringexportreportTitle
StringexportreportBy
StringexportreportFor
StringexportreportScanDate
StringexportreportReportDate
StringexportreportScanVersion
StringexportreportReportVersion
StringexportreportReportDescription
StringexportreportAlertHigh
booleanexportreportAlertMedium
booleanexportreportAlertLow
booleanexportreportAlertInformational
booleanexportreportCWEID
booleanexportreportWASCID
booleanexportreportDescription
booleanexportreportOtherInfo
booleanexportreportSolution
booleanexportreportReference
booleanexportreportRequestHeader
booleanexportreportResponseHeader
booleanexportreportRequestBody
booleanexportreportResponseBody
booleanjiraCreate
booleanjiraProjectKey
StringjiraAssignee
StringjiraAlertHigh
booleanjiraAlertMedium
booleanjiraAlertLow
booleanjiraFilterIssuesByResourceType
booleancmdLinesZAP
cmdLineOption
StringcmdLineValue
StringzAdviserDownloadconnectionId
StringcredentialsId
Stringjcl
StringencryptedDataFile
StringunencryptedDataFile
StringencryptData (optional)
booleanuploadData (optional)
booleanzAdviserUploadconnectionId
StringuploadDataFile
String$class: 'ZOSJobSubmitter'server
Stringport
intcredentialsId
Stringwait
booleanwaitTime
intdeleteJobFromSpool
booleanjobLogToConsole
booleanjobFile
StringMaxCC
StringJESINTERFACELEVEL1
booleanFTPActiveMode
boolean$class: 'ZanataCliBuilder'projFile
StringsyncG2zanata
booleansyncZ2git
booleanzanataCredentialsId
StringextraPathEntries (optional)
String$class: 'ZanataSyncStep'zanataCredentialsId
StringpullFromZanata (optional)
booleanpushToZanata (optional)
booleansyncOption (optional)
StringzanataLocaleIds (optional)
StringzanataProjectConfigs (optional)
StringzanataURL (optional)
String$class: 'ZapRunner'host
StringzapInstallDescription
value
Stringpath
StringrepositoryURL
StringsourcePath
StringzulipSendmessage (optional)
Stringstream (optional)
Stringtopic (optional)
StringcfyCloudFormationawsCredentialsId (optional)
The ID of the credentials to use when accessing AWS. Parameters' expansion is supported when using freestyle jobs.
StringcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringdebugOutput (optional)
booleandeploymentId (optional)
ID to assign to the created Cloudify deployment. If not provided, one will be randomly generated. You can obtain the deployment ID from the "environment data" output file.
StringechoEnvData (optional)
If checked, then the created environment's data will be printed to the job's log.
booleanechoInputs (optional)
booleanenvDataLocation (optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
Stringparameters (optional)
java.util.Map<java.lang.String, java.lang.Object>parametersAsString (optional)
StringparametersFile (optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
StringregionName (optional)
AWS region to use. If not specified, the value of the aws_region_name secret is used.
StringstackName (optional)
Name of the new stack.
StringtemplateBody (optional)
StringtemplateBucketName (optional)
StringtemplateFile (optional)
StringtemplateResourceName (optional)
StringtemplateUrl (optional)
URL of the Terraform template. May be a ZIP, tar.gz, or a Git repository.
Stringtenant (optional)
StringNCScanBuilderncScanType
StringncWebsiteId
StringncProfileId
StringncDoNotFail (optional)
booleanacxServerURL (optional)
StringcredentialsId (optional)
StringncApiToken (optional)
ObjectncConfirmed (optional)
booleanncIgnoreFalsePositive (optional)
booleanncIgnoreRiskAccepted (optional)
booleanncSeverity (optional)
StringncStopScan (optional)
boolean$class: 'com.alauda.jenkins.plugins.freestyle.CreateStep'jsonyaml
StringadvancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringlogLevel (optional)
Stringproject (optional)
String$class: 'com.alauda.jenkins.plugins.freestyle.DeleteStep'advancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringignoreNotFound (optional)
booleanlogLevel (optional)
Stringproject (optional)
Stringselector (optional)
kind (optional)
Stringlabels (optional)
name
Stringvalue
Stringnames (optional)
name
String$class: 'com.alauda.jenkins.plugins.freestyle.RawStep'command
Stringarguments
StringadvancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringlogLevel (optional)
Stringproject (optional)
String$class: 'com.alauda.jenkins.plugins.freestyle.WatchStep'advancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringfailPattern (optional)
StringlogLevel (optional)
Stringproject (optional)
Stringselector (optional)
kind (optional)
Stringlabels (optional)
name
Stringvalue
Stringnames (optional)
name
StringsuccessPattern (optional)
Stringtemplate (optional)
String$class: 'com.cloudbees.dockerpublish.DockerBuilder'repoName
StringbuildAdditionalArgs (optional)
StringbuildContext (optional)
StringcreateFingerprint (optional)
booleandockerToolName (optional)
StringdockerfilePath (optional)
StringforcePull (optional)
booleanforceTag (optional)
booleannoCache (optional)
booleanregistry (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringrepoTag (optional)
Stringserver (optional)
uri
unix:///var/run/docker.sock or tcp://127.0.0.1:2376).
StringcredentialsId
StringskipBuild (optional)
booleanskipDecorate (optional)
booleanskipPush (optional)
booleanskipTagLatest (optional)
boolean$class: 'com.cloudbees.plugins.deployer.DeployBuilder'hosts
? extends com.cloudbees.plugins.deployer.hosts.DeployHost<?, ?>$class: 'com.etas.jenkins.plugins.CreateTextFile.CreateFileBuilder'textFilePath
StringtextFileContent
StringfileOption
StringuseWorkspace
boolean$class: 'com.groupon.jenkinsci.plugins.DotCiFigtemplate.HelloWorldBuilder'name
StringazureVMSSUpdateazureCredentialsId
StringresourceGroup
Stringname
StringimageReference
id (optional)
Resource ID or VHD URI of the custom image.
Example Resource ID: /subscriptions/your-subscription-id/resourceGroups/your-resource-group/providers/Microsoft.Compute/images/your-image-name
Example VHD URI: http://your-storage-account.blob.core.windows.net/vhds/your-disk-image.vhd
Stringoffer (optional)
Stringpublisher (optional)
Stringsku (optional)
Stringversion (optional)
StringNCScanBuilderncScanType
StringncWebsiteId
StringncProfileId
StringncDoNotFail (optional)
booleancredentialsId (optional)
StringncApiToken (optional)
ObjectncConfirmed (optional)
booleanncIgnoreFalsePositive (optional)
booleanncIgnoreRiskAccepted (optional)
booleanncServerURL (optional)
StringncSeverity (optional)
StringncStopScan (optional)
boolean$class: 'com.openshift.jenkins.plugins.freestyle.CreateStep'jsonyaml
StringadvancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringlogLevel (optional)
Stringproject (optional)
String$class: 'com.openshift.jenkins.plugins.freestyle.DeleteStep'advancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringignoreNotFound (optional)
booleanlogLevel (optional)
Stringproject (optional)
Stringselector (optional)
kind (optional)
Stringlabels (optional)
name
Stringvalue
Stringnames (optional)
name
String$class: 'com.openshift.jenkins.plugins.freestyle.RawStep'command
Stringarguments
StringadvancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringlogLevel (optional)
Stringproject (optional)
String$class: 'com.openshift.jenkins.plugins.freestyle.WatchStep'advancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringfailPattern (optional)
StringlogLevel (optional)
Stringproject (optional)
Stringselector (optional)
kind (optional)
Stringlabels (optional)
name
Stringvalue
Stringnames (optional)
name
StringsuccessPattern (optional)
Stringtemplate (optional)
String$class: 'com.syncapse.jenkinsci.plugins.awscloudformationwrapper.CloudFormationBuildStep'stacks
stackName
Name of the stack. The name associated with the stack. The name must be unique within your AWS account. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters. You can pass Environment Variables into this field.
Stringdescription
StringcloudFormationRecipe
Stringparameters
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.
Stringtimeout
longawsAccessKey
StringawsSecretKey
StringawsRegion
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_Paulosleep
long$class: 'com.synopsys.integration.jenkins.coverity.extensions.buildstep.CoverityBuildStep'coverityInstanceUrl
Specify which Synopsys Coverity connect instance to run this job against.
The resulting Synopsys Coverity connect instance URL is stored in the $COV_URL environment variable, and will affect both the full and incremental analysis.
StringonCommandFailure
Specify the action to take if a Coverity static analysis command fails.
StringprojectName
Specify the name of the Coverity project.
The resulting project name is stored in the $COV_PROJECT environment variable, and will affect both the full and incremental analysis.
StringstreamName
Specify the name of the Coverity stream that you would like to use for the commands.
The resulting stream name is stored in the $COV_STREAM environment variable, and will affect both the full and incremental analysis.
StringcheckForIssuesInView
viewName
Specify the name of the Coverity view that you would like to check for issues.
The resulting view name is stored in the $COV_VIEW environment variable, and affects checking for issues in both the full and incremental analysis, if configured.
StringbuildStatusForIssues
Specify the build status to set if issues are found in the configured view.
StringconfigureChangeSetPatterns
changeSetExclusionPatterns
Specify a comma separated list of filename patterns that you would like to explicitly excluded from the Jenkins change set.
The pattern is applied to the $CHANGE_SET environment variable, and will affect which files are analyzed in an incremental analysis (cov-run-desktop).
Examples:
| File Name | Pattern | Will be excluded |
|---|---|---|
| test.java | *.java | Yes |
| test.java | *.jpg | No |
| test.java | test.* | Yes |
| test.java | test.???? | Yes |
| test.java | test.????? | No |
StringchangeSetInclusionPatterns
Specify a comma separated list of filename patterns that you would like to explicitly included from the Jenkins change set.
The pattern is applied to the $CHANGE_SET environment variable, and will affect which files are analyzed in an incremental analysis (cov-run-desktop).
Examples:
| File Name | Pattern | Will be included |
|---|---|---|
| test.java | *.java | Yes |
| test.java | *.jpg | No |
| test.java | test.* | Yes |
| test.java | test.???? | Yes |
| test.java | test.????? | No |
StringcoverityRunConfiguration
$class: 'AdvancedCoverityRunConfiguration'commands
command
Provide the Coverity command you want to run.
The command should start with the name of the Coverity command you want to run. Ex: cov-build, cov-analyze, etc.
For examples and a list of the available environment variables that can be used, refer to the Command Examples documentation
String$class: 'SimpleCoverityRunConfiguration'coverityAnalysisType
Specify the way you wish to perform your Coverity analysis.
Each analysis type runs a specific Coverity command with some default arguments, followed by cov-commit-defects with some default arguments. Additional command-specific arguments can be provided below.
Full Analysis:
cov-analyze --dir ${WORKSPACE}/idir
cov-commit-defects --dir ${WORKSPACE}/idir --url ${COV_URL} --stream ${COV_STREAM}
Incremental Analysis:
cov-run-desktop --dir ${WORKSPACE}/idir --url ${COV_URL} --stream ${COV_STREAM} ${CHANGE_SET}
cov-commit-defects --dir ${WORKSPACE}/idir --url ${COV_URL} --stream ${COV_STREAM}
Determined by change set threshold
Will run the commands specified by Full Analysis if the number of files listed in the CHANGE_SET environment variable meets or exceeds the specified threshold, otherwise will run the commands specified by Incremental Analysis.
COV_ANALYZE, COV_RUN_DESKTOP, THRESHOLDsourceArgument
The argument that specifies the source for the given capture type.
For Build, this is the build command to pass to cov-build.
For Buildless Capture (Project) this is the project directory to pass to cov-capture.
For Buildless Capture (SCM) this is the scm url to pass to cov-capture.
StringcommandArguments
covBuildArguments
Specify additional arguments to apply to the invocation of the cov-build command. Affects the Build capture type.
Note:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
StringcovAnalyzeArguments
Specify additional arguments to apply to the invocation of the cov-analyze command. Affects the Full Analysis analysis type.
Note:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
StringcovRunDesktopArguments
Specify additional arguments to apply to the invocation of the cov-run-desktop command. Affects the Incremental Analysis analysis type.
Note:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
StringcovCommitDefectsArguments
Specify additional arguments to apply to the invocation of the cov-commit-defects command. Affects all analysis types.
Note:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
StringcovCaptureArguments
Specify additional arguments to apply to the invocation of the cov-capture command. Affects the Buildless Capture (Project) and Buildless Capture (SCM) capture types.
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
With the Buildless Capture (Project) capture type, the following arguments are automatically provided:
With the Buildless Capture (SCM) capture type, the following arguments are automatically provided:
StringchangeSetAnalysisThreshold (optional)
For use with the Coverity Analysis Type Determined by change set threshold. Specifies the number of files that triggers a Full Analysis.
Determined by change set threshold will run an Incremental Analysis unless the number of files specified in the $CHANGE_SET environment variable meets or exceeds the value of this field.
If the number of files specified in the $CHANGE_SET environment variable meets or exceeds the value of this field, Determined by change set threshold will run a Full Analysis
intcoverityCaptureType (optional)
Specify the way you wish to capture your source for Coverity analysis.
Each capture type runs a specific Coverity command with some default arguments. Additional command-specific arguments can be provided below.
Build
cov-build --dir ${WORKSPACE}/idir Source Argument (build command)
Buildless Capture (Project)
cov-capture --project-dir Source Argument (project directory)
Buildless Capture (SCM)
cov-capture --scm-url Source Argument (scm url)
COV_BUILD, COV_CAPTURE_PROJECT, COV_CAPTURE_SCMcustomWorkingDirectory (optional)
The fully qualified path to a directory in which to run the cov-build or cov-capture command.
StringcleanUpAction (optional)
Specify the clean up action to perform on a successful execution.
Will either persist or delete the intermediate directory created by the specified capture type.
PERSIST_INTERMEDIATE_DIRECTORY, DELETE_INTERMEDIATE_DIRECTORYcredentialsId (optional)
Specify the credentials to use with the Synopsys Coverity connect instance.
StringoverrideDefaultCredentials (optional)
boolean$class: 'eggPlantBuilder'script
Relative to the Execution Directory, specify the script or scripts, separated by commas to execute in the test relative to the workspace directory for this job, for example:
NOTE: To have scripts run against different SUTs, it is necessary to create a build step for each SUT.
StringSUT
Stringport
Set the VNC Server port for the SUT, eg. 5900. Leaving this blank will use the default port for VNC, 5900.
Stringpassword
Specifies the password for the VNC server. If there's no password, this field can be left blank.
StringcolorDepth
StringglobalResultsFolder
OPTIONAL. Specify the path to the global results folder, relative to the workspace.
StringdefaultDocumentDirectory
Specify the path to the Default Document Directory, relative to the Execution Directory. See Running Eggplant From the Command Line in the Eggplant documentation
Stringparams
Parameters to be passed to the script(s). Equivalent to the -params flag when executing from the command line.
StringreportFailures
booleancommandLineOutput
Pipe eggPlant results out as part of the console output.
booleaninstallationName
String$class: 'iOSAppInstaller'url
StringcloudTestServerID
Stringipa
StringadditionalOptions
String$class: 'iOSSimulatorLauncher'url
StringcloudTestServerID
Stringapp
Stringsdk
Stringfamily
StringdotnetRestoredotnet restore command uses NuGet to restore dependencies as well as project-specific tools that are specified in the project file. In most cases, you don't need to explicitly use the dotnet restore command, since a NuGet restore is run implicitly if necessary when you run the following commands:
dotnet restore explicitly to control when the restore occurs so that they can control network usage. To prevent the implicit NuGet restore, you can use the --no-restore flag with any of these commands to disable implicit restore.
configfile (optional)
StringdisableParallel (optional)
booleanforce (optional)
booleanforceEvaluate (optional)
booleanignoreFailedSources (optional)
booleanlockFilePath (optional)
StringlockedMode (optional)
booleannoCache (optional)
booleannoDependencies (optional)
booleanpackages (optional)
Stringproject (optional)
Stringruntime (optional)
Stringruntimes (optional)
StringruntimesString (optional)
<RuntimeIdentifiers> tag in the .csproj file. For a list of Runtime Identifiers (RIDs), see the RID catalog.
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleansource (optional)
Stringsources (optional)
StringsourcesString (optional)
StringspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleanuseLockFile (optional)
booleanverbosity (optional)
StringworkDirectory (optional)
StringdotnetToolRestoredotnet tool restore command finds the tool manifest file that is in scope for the current directory and installs the tools that are listed in it. For information about manifest files, see Install a local tool and Invoke a local tool.
additionalSource (optional)
StringadditionalSources (optional)
StringadditionalSourcesString (optional)
Stringconfigfile (optional)
StringdisableParallel (optional)
booleanignoreFailedSources (optional)
booleannoCache (optional)
booleansdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleanspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleantoolManifest (optional)
Stringverbosity (optional)
q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic].
StringworkDirectory (optional)
String$class: 'jenkins.plugins.coverity.CoverityBuildStep'The build step can be configured as any other build steps. Choose the appropriate builder and configure the command to be performed. The configured build step will be wrapped with the Coverity cov-build executables so that it captures the build and can be used to further analysis by using coverity static tools. This build step is only for capturing build of compiled sources.
buildStep
hudson.tasks.BuildStep)$class: 'org.jenkinsci.plugins.dockerbuildstep.DockerBuilder'dockerCmd
$class: 'CommitCommand'containerId
Stringrepo
Stringtag
StringrunCmd
String$class: 'CreateContainerCommand'image
Stringcommand
StringhostName
StringcontainerName
StringenvVars
Stringlinks
StringexposedPorts
StringcpuShares
StringmemoryLimit
Stringdns
StringextraHosts
StringnetworkMode
StringpublishAllPorts
This setting corresponds to the --publish-all (-P) option of the docker run CLI command.
booleanportBindings
--publish (-p) option of the docker run CLI command.
Enter one or more port binding, each on its own line. The syntax is host container where host is either hostPort or hostIp:hostPort and container is either containerPort or containerPort/protocol.
Alternatively, you can separate host and port with a colon (":"), thus using the same syntax as in the Docker CLI.
Examples
StringbindMounts
--volume (-v) option of the docker run CLI command.
Enter one or more bind mount, each on its own line. The syntax is hostPath containerPath[ rw|ro]
Stringprivileged
This setting corresponds to the --privileged option of the docker run CLI command.
booleanalwaysRestart
boolean$class: 'CreateImageCommand'dockerFolder
StringimageTag
StringdockerFile
Stringpull
booleannoCache
booleanrm
booleanbuildArgs
String$class: 'ExecCreateAndStartCommand'containerIds
Stringcommand
String$class: 'ExecCreateCommand'containerIds
Stringcommand
String$class: 'ExecStartCommand'commandIds
String$class: 'KillCommand'containerIds
String$class: 'PullImageCommand'fromImage
Stringtag
Stringregistry
StringdockerRegistryEndpoint
url
https://index.docker.io/v1/).
StringcredentialsId
String$class: 'PushImageCommand'image
Stringtag
Stringregistry
StringdockerRegistryEndpoint
url
https://index.docker.io/v1/).
StringcredentialsId
String$class: 'RemoveAllCommand'removeVolumes
booleanforce
boolean$class: 'RemoveCommand'containerIds
StringignoreIfNotFound
booleanremoveVolumes
booleanforce
boolean$class: 'RemoveImageCommand'imageName
StringimageId
StringignoreIfNotFound
boolean$class: 'RestartCommand'containerIds
Stringtimeout
int$class: 'SaveImageCommand'imageName
StringimageTag
Stringdestination
Stringfilename
StringignoreIfNotFound
boolean$class: 'StartByImageIdCommand'imageId
String$class: 'StartCommand'containerIds
StringwaitPorts
StringcontainerIdsLogging
String$class: 'StopAllCommand'$class: 'StopByImageIdCommand'imageId
String$class: 'StopCommand'containerIds
String$class: 'TagImageCommand'image
Stringrepository
Stringtag
StringignoreIfNotFound
booleanwithForce
boolean$class: 'org.jenkinsci.plugins.ios.connector.DeployBuilder'path
Stringudid
(We are looking for more ways to let you specify the target device flexibly. Please send in your suggestions.)
String$class: 'org.jenkinsci.plugins.liquibase.builder.UpdateBuilder'changeLogFile (optional)
StringchangeLogParameters (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringinstallationName (optional)
Stringlabels (optional)
StringliquibasePropertiesPath (optional)
Stringpassword (optional)
StringresourceDirectories (optional)
Stringurl (optional)
Stringusername (optional)
StringosfBuilderSuiteForSFCCDeployhostname (optional)
StringtfCredentialsId (optional)
StringocCredentialsId (optional)
StringocVersion (optional)
StringbuildVersion (optional)
StringcreateBuildInfoCartridge (optional)
booleanactivateBuild (optional)
booleansourcePaths (optional)
sourcePath
StringexcludePatterns
excludePattern
StringtempDirectory (optional)
Stringgreetname
StringuseFrench (optional)
boolean$class: 'org.quality.gates.jenkins.plugin.QGBuilder'jobConfigData
class org.quality.gates.jenkins.plugin.JobConfigDataglobalConfigDataForSonarInstance
class org.quality.gates.jenkins.plugin.GlobalConfigDataForSonarInstance$class: 'quality.gates.jenkins.plugin.QGBuilder'jobConfigData
class quality.gates.jenkins.plugin.JobConfigData$class: 'vRABlueprintBuildStep'params
serverUrl
StringuserName
Stringpassword
Stringtenant
StringpackageBlueprint
booleanblueprintPath
StringoverWrite
booleanpublishBlueprint
booleanserviceCategory
String$class: 'vRADeploymentBuildStep'params
serverUrl
StringuserName
Stringpassword
Stringtenant
StringblueprintName
StringwaitExec
booleanrequestTemplate
booleanrequestParams
json
String$class: 'ConditionalBuilder'runCondition
$class: 'AlwaysRun'$class: 'And'conditions
condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'conditions
condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
Stringrunner
A run condition evaluation may fail to run cleanly - especially if it is dependent on expanding tokens provided by the Token Macro Plugin and the values are expected to be present or look like a certain type i.e. be a number.
...its about the action to take when the condition can not be evaluated - this is not same as evaluating to false.
$class: 'DontRun'$class: 'Fail'$class: 'Run'$class: 'RunUnstable'$class: 'Unstable'conditionalbuilders
hudson.tasks.BuildStep)$class: 'ConfigFileBuildStep'managedFiles
fileId
Name of the file.
StringreplaceTokens (optional)
Decides whether the token should be replaced using macro.
booleantargetLocation (optional)
Name of the file (with optional file relative to workspace directory) where the config file should be copied.
Stringvariable (optional)
Name of the variable which can be used as the reference for further configuration.
String$class: 'ConfluenceReleaseNotesPublisher'jiraCredentialsID
StringconfluenceCredentialsID
StringspaceKey
StringjqlFilter
StringpageTitle
StringparentPageTitle
String$class: 'ConsulBuilder'installationName
StringoperationList
$class: 'ConsulGetKV'valuePath
StringenvironmentVariableName
String$class: 'ConsulServiceDiscoveryOperation'serviceName
StringserviceTag
StringenvironmentVariableName
StringhealthStatus
StringaddPort
boolean$class: 'ConsulSetKV'valuePath
Stringvalue
StringconsulSettingsProfileName
String$class: 'ConsulKVBuilder'hostUrl
Stringkey
StringaclToken (optional)
StringapiUri (optional)
StringdebugMode (optional)
ENABLED, DISABLEDenvVarKey (optional)
StringignoreGlobalSettings (optional)
booleankeyValue (optional)
StringrequestMode (optional)
READ, WRITE, DELETEtimeoutConnection (optional)
inttimeoutResponse (optional)
intassessContainerImagefailOnPluginError (optional)
booleanimageId (optional)
StringnameRules (optional)
packageNameaction
Stringcontains
StringvulnerabilityCategoryaction
Stringcontains
StringvulnerabilityTitleaction
Stringcontains
StringvulnerablePackageNameaction
Stringcontains
StringthresholdRules (optional)
criticalVulnerabilitiesaction
Stringthreshold
StringcvssV2Scoreaction
Stringthreshold
StringexploitableVulnerabilitiesaction
Stringthreshold
StringvulnerabilitiesWithMalwareKitsaction
Stringthreshold
StringmoderateVulnerabilitiesaction
Stringthreshold
StringpackageRiskScoreaction
Stringthreshold
StringriskScoreaction
Stringthreshold
StringsevereVulnerabilitiesaction
Stringthreshold
StringtotalVulnerabilitiesaction
Stringthreshold
StringtreatWarningsAsErrors (optional)
booleanworkspaceDir (optional)
StringcontentReplaceconfigs (optional)
filePath
StringfileEncoding
Stringconfigs
search
Stringreplace
StringmatchCount
int$class: 'ContinuousReleaseProperties'properties
java.util.Map<java.lang.String, java.lang.String>$class: 'CoordinatorBuilder'executionPlan
class org.jenkinsci.plugins.coordinator.model.TreeNode$class: 'CopadoBuilder'stepName
StringwebhookUrl
Stringapi_key
Stringtimeout
intcopyArtifactsprojectName
The name of the project to copy artifacts from.
Artifacts from all modules will be copied. Enter JOBNAME/MODULENAME here to copy from a particular module; you may copy/paste this from the URL for that module when browsing Jenkins.
Example: MyMavenJob/my.group$MyModule
Artifacts from all configurations will be copied, each into a subdirectory with the name of the configuration as seen in its URL when browsing Jenkins.
Example: If the target directory is given as fromMatrix then the copy could create $WORKSPACE/fromMatrix/label=agentA/dist/mybuild.jar and $WORKSPACE/fromMatrix/label=agentB/dist/mybuild.jar.
To copy from a particular configuration, enter JOBNAME/AXIS=VALUE,.. as seen in the URL for that configuration.
Example: MyMatrixJob/jdk=Java6u17
To copy artifacts from one matrix project to another, use a parameter to select the matching configuration in the source project.
Example: OtherMatrixJob/jdk=$jdk
Use a path consisting of the project name followed by the branch name.
Example: /MyMultibranchProject/MyBranch
Special letters like '/' in branch names should be escaped. You can see the exact name in "Full project name" in job pages of each branch.
Example: ../MyMultibranchProject/feature%2Fnavigation
See the wiki page "How to reference another project by name" for more information.
Stringexcludes (optional)
Stringfilter (optional)
StringfingerprintArtifacts (optional)
booleanflatten (optional)
booleanoptional (optional)
booleanparameters (optional)
Jobs may be filtered to select only builds matching particular parameters or other build variables. Use PARAM=VALUE,... to list the parameter filter; this is the same syntax as described for multiconfiguration jobs in Project name except with parameters instead of axis values. For example, FOO=bar,BAZ=true examines only builds that ran with parameter FOO set to bar and the checkbox for BAZ was checked.
You shouldn't use "Build selector for Copy Artifact" parameters here, as it doesn't preserve compatibility when you upgrade plugins, and doesn't work for builds built before upgrading.
StringresultVariableSuffix (optional)
If not specified, the source project name will be used instead (in all uppercase, and sequences of characters other than A-Z replaced by a single underscore).
Example:
| Source project name | Suffix to be used |
|---|---|
| Project-ABC | PROJECT_ABC |
| tool1-release1.2 | TOOL_RELEASE_ |
Stringselector (optional)
downstreamupstreamProjectName
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
StringupstreamBuildNumber
StringlastWithArtifactslastCompleted$class: 'MultiJobBuildSelector'buildParameterparameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
Stringpermalinkid
String$class: 'PromotedBuildSelector'level
intlatestSavedBuildspecificbuildNumber
StringlastSuccessfulstable (optional)
booleanupstreamallowUpstreamDependencies (optional)
booleanfallbackToLastSuccessful (optional)
booleanupstreamFilterStrategy (optional)
UseGlobalSetting, UseOldest, UseNewestworkspacetarget (optional)
StringcopydstFile (optional)
StringkeepMeta (optional)
booleanrecursive (optional)
booleansrcFile (optional)
String$class: 'CreateBaselineBuilder'outputFile
Path to the file that should be used to store baseline.
File location must be specified as:
StringinputFileOrFolder
Specify input folder/file for creating baseline. It should depend on input type you have selected.
Folder/file location must be specified as:
String$class: 'CreateBuildBuilder'Creates a new build for the selected BuildMaster application and sets the BUILDMASTER_BUILD_NUMBER environment variable with the value returned from BuildMaster for the new build.
If your Jenkins job has produced artifacts to be loaded into BuildMaster, you have the following options. The choice is largely dependent on how you import the build artifacts into BuildMaster:
applicationId
The identifier of the BuildMaster application to trigger the build for.
Options are:
StringreleaseNumber
The BuildMaster release number to trigger the build for. Options are:
The job will fail if there is no active BuildMaster release.
StringdeployToFirstStage (optional)
waitUntilCompleted
booleanprintLogOnFailure (optional)
booleanvariables (optional)
Provide a list of variables to pass to the build.
String$class: 'CreateCustomTaskrun'name
StringgenerateName
Stringnamespace
StringclusterName
Stringworkspaces
name
StringclaimName
Stringparams
name
Stringvalue
StringtaskRef
StringcreateCloudifyEnvCreates a topology from an environment blueprint.
The "Output File" parameter denotes where the new environment's outputs will be written to. Later build steps can inspect this file in order to grab information pertinent to them (such as IP addresses, user names and so forth).
All input fields support standard Jenkins parameters' expansion. For example, the string ${app_name} will be expanded, in runtime, to the value of a build parameter called app_name .
For explanation about the format of the outputs file, refer to the help tooltip for that parameter.
blueprintId (optional)
Unique identifier for the created deployment.
StringcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringdebugOutput (optional)
booleandeploymentId (optional)
Identifies the blueprint to create a deployment off.
StringechoInputs (optional)
booleanechoOutputs (optional)
booleaninputs (optional)
A YAML/JSON containing inputs for the deployment. These inputs will be merged with inputs provided through the " inputs file " parameter.
StringinputsFile (optional)
A path (relative to the workspace root) to a YAML/JSON file containing inputs for the deployment. These inputs will be merged with inputs provided through the " inputs " parameter.
Stringmapping (optional)
If specified, this YAML/JSON will be used to transform a YAML/JSON coming from the "inputs file" parameter. This is useful if the "inputs file" is the result of a different Cloudify environment build.
This parameter must not be provided if "mapping file" is provided.
StringmappingFile (optional)
If specified, this YAML/JSON file will be used to transform a YAML/JSON coming from the "inputs file" parameter. This is useful if the "inputs file" is the result of a different Cloudify environment build.
This parameter must not be provided if "mapping" is provided.
StringoutputFile (optional)
Name of file into which the deployment's outputs and capabilities will be written. The file will be a JSON, adhering to the following format:
{
"outputs": <outputs_dictionary>,
"capabilities": <capabilities_dictionary>
}
StringskipInstall (optional)
install workflow.
booleantenant (optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String$class: 'CreateFingerprint'Create Fingerprints of specified files during a build process
targets
StringtektonCreateRawinput
StringinputType
StringclusterName (optional)
StringenableCatalog (optional)
booleannamespace (optional)
String$class: 'CreateRelease'prefix
StringitemPrefix
StringreleaseName
Stringdescription
Stringstage
Stringowner
Stringperiod
String$class: 'CreateSnapshotBuilder'outputFile
Path to the file that should be used to store snapshots.
File location must be specified as:
StringinputFileOrFolder
Specify input folder/file for creating snapshot. It should depend on input type you have selected.
Folder/file location must be specified as:
StringcreateTagnexusInstanceId
StringtagName
StringtagAttributesJson (optional)
StringtagAttributesPath (optional)
StringcreateTaskartifact (optional)
StringautoUpgradable (optional)
booleanenvironment (optional)
StringoverrideWithDefaultParameters (optional)
booleanparameters (optional)
Stringruntime (optional)
StringruntimeType (optional)
Stringworkspace (optional)
String$class: 'CreateTemplate'cloud
Stringworkspace
StringinstanceTags
StringtemplateName
Stringprovider
Stringdatacenter
Stringfolder
Stringdatastore
StringclaimFilter
StringpolicyName
Stringclaims
String$class: 'CriticalBlockEnd'Release all resources that Critical block start had allocated for this job.
$class: 'CriticalBlockStart'Delimit the beginning of the exclusion zone. All build steps that follow will be managed by exclusion plugin.
$class: 'CucumberSlackBuildStepNotifier'channel
Stringjson
StringhideSuccessfulResults
boolean$class: 'CustomPythonBuilder'home
Stringnature
Stringcommand
StringignoreExitCode
boolean$class: 'CxScanBuilder'credentialsId
StringsastCredentialsId
StringbuildStep
StringteamPath
StringsastEnabled
booleanexclusionsSetting
StringfailBuildOnNewResults
booleanfailBuildOnNewSeverity
StringuseOwnServerCredentials (optional)
booleanserverUrl (optional)
Stringusername (optional)
Stringpassword (optional)
StringisProxy (optional)
booleanconfigAsCode (optional)
booleanprojectName (optional)
StringprojectId (optional)
longgroupId (optional)
Stringpreset (optional)
StringjobStatusOnError (optional)
GLOBAL, FAILURE, UNSTABLEpresetSpecified (optional)
booleanexcludeFolders (optional)
Conversion is done as follows:
fold1, fold2 fold3
is converted to:
!**/fold1/**/*, !**/fold2/**/*, !**/fold3/**/*,
StringfilterPattern (optional)
Example: **/*.java, **/*.html, !**\test\**\XYZ*
Pattern Syntax
A given directory is recursively scanned for all files and directories. Each file/directory is matched against a set of selectors, including special support for matching against filenames with include and exclude patterns. Only files/directories which match at least one pattern of the include pattern list, and don't match any pattern of the exclude pattern list will be placed in the list of files/directories found.
When no list of include patterns is supplied, "**" will be used, which means that everything will be matched. When no list of exclude patterns is supplied, an empty list is used, such that nothing will be excluded. When no selectors are supplied, none are applied.
The filename pattern matching is done as follows: The name to be matched is split up in path segments. A path segment is the name of a directory or file, which is bounded by File.separator ('/' under UNIX, '\' under Windows). For example, "abc/def/ghi/xyz.java" is split up in the segments "abc", "def","ghi" and "xyz.java". The same is done for the pattern against which should be matched.
The segments of the name and the pattern are then matched against each other. When '**' is used for a path segment in the pattern, it matches zero or more path segments of the name.
There is a special case regarding the use of File.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").
Stringincremental (optional)
booleanfullScansScheduled (optional)
booleanfullScanCycle (optional)
intpostScanActionId (optional)
intsourceEncoding (optional)
Stringcomment (optional)
StringskipSCMTriggers (optional)
booleanwaitForResultsEnabled (optional)
booleanvulnerabilityThresholdEnabled (optional)
booleanhighThreshold (optional)
intmediumThreshold (optional)
intlowThreshold (optional)
intosaHighThreshold (optional)
intosaMediumThreshold (optional)
intosaLowThreshold (optional)
intgeneratePdfReport (optional)
booleanenableProjectPolicyEnforcement (optional)
booleanthresholdSettings (optional)
StringvulnerabilityThresholdResult (optional)
StringavoidDuplicateProjectScans (optional)
booleanaddGlobalCommenToBuildCommet (optional)
booleangenerateXmlReport (optional)
booleanhideDebugLogs (optional)
booleanforceScan (optional)
booleancustomFields (optional)
StringdependencyScanConfig (optional)
SASTUserName (optional)
StringdependencyScanExcludeFolders (optional)
StringdependencyScanPatterns (optional)
StringdependencyScannerType (optional)
OSA, SCAfsaVariables (optional)
StringisExploitablePath (optional)
booleanisIncludeSources (optional)
booleanosaArchiveIncludePatterns (optional)
StringosaInstallBeforeScan (optional)
booleanoverrideGlobalConfig (optional)
booleansastCredentialsId (optional)
StringscaAccessControlUrl (optional)
StringscaConfigFile (optional)
StringscaCredentialsId (optional)
StringscaEnvVariables (optional)
StringscaSASTProjectFullPath (optional)
StringscaSASTProjectID (optional)
StringscaSastServerUrl (optional)
StringscaServerUrl (optional)
StringscaTenant (optional)
StringscaWebAppUrl (optional)
StringuseJobLevelSastDetails (optional)
booleanexcludeOpenSourceFolders (optional)
StringincludeOpenSourceFolders (optional)
StringosaArchiveIncludePatterns (optional)
StringosaEnabled (optional)
booleanosaInstallBeforeScan (optional)
booleanthisBuildIncremental (optional)
booleanDASTScanapikey (optional)
Your API key can be found on the Breachlock Platform under
Organization settings > Integrations > Jenkins
class hudson.util.Secretasset (optional)
Select the asset that will be scanned on build.
If the asset you are looking for is missing:
Stringemail (optional)
The email-address you registered on Breachlock Platform.
StringosfBuilderSuiteForSFCCDataImporthostname (optional)
StringtfCredentialsId (optional)
StringocCredentialsId (optional)
StringocVersion (optional)
StringarchiveName (optional)
StringsourcePath (optional)
StringincludePatterns (optional)
includePattern
StringexcludePatterns (optional)
excludePattern
StringimportStrategy (optional)
StringtempDirectory (optional)
String$class: 'DaticalDBBuilder'daticalDBProjectDir
StringdaticalDBServer
StringdaticalDBAction
StringdaticalDBCmdProject
StringdaticalDBExportSQL
StringdaticalDBExportRollbackSQL
StringdaticalDBScriptDir
String$class: 'DebianPackageBuilder'pathToDebian
StringnextVersion
StringgenerateChangelog
booleansignPackage
booleanbuildEvenWhenThereAreNoChanges
booleandebianPbuilderadditionalBuildResults (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.
Stringarchitecture (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.
StringbuildAsTag (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.
booleancomponents (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.
StringdebianDirLocation (optional)
The location of the debian/ directory, relative to workspace root
This may also be set globally
Stringdistribution (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.
StringguessComponents (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"
booleankeyring (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.
StringmirrorSite (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
StringnumberCores (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.
intpristineTarName (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.
StringrunAutomationHubBuildtestSuiteId
StringstartOnly (optional)
booleanuserKeyId (optional)
StringuserKeySecret (optional)
class hudson.util.SecretdotnetNuGetDeletedotnet nuget delete command deletes or unlists a package from the server. For nuget.org, the action is to unlist the package.
apiKeyId (optional)
StringforceEnglishOutput (optional)
booleannoServiceEndpoint (optional)
booleanpackageName (optional)
StringpackageVersion (optional)
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleansource (optional)
https://www.nuget.org, https://www.nuget.org/api/v3, and https://www.nuget.org/api/v2/package. For private feeds, replace the host name (for example, %hostname%/api/v3).
StringspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleanworkDirectory (optional)
String$class: 'DeleteApplication'serverName
StringappName
Stringdomain
StringdeleteCloudifyBlueprintblueprintId (optional)
StringcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
Stringtenant (optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
StringdeleteComponentsnexusInstanceId
StringtagName
StringdeleteCloudifyEnvcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringdebugOutput (optional)
booleandeleteBlueprintIfLast (optional)
If checked, and this is the last environment for the associated blueprint, then also delete the blueprint.
booleandeploymentId (optional)
StringignoreFailure (optional)
If checked, then failures during the removal of the environment will be ignored.
booleanskipUninstall (optional)
uninstall workflow.
booleantenant (optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String$class: 'DeleteEnvironmentBuilder'systemId
intenvironmentName
String$class: 'DeleteRaw'deleteAllStatus
resourceName
StringresourceType (optional)
StringclusterName (optional)
StringresourceName (optional)
String$class: 'DeleteVirtualizeBuilder'serverType
StringserverHost
StringserverName
StringdependencyCheckadditionalArguments (optional)
StringodcInstallation (optional)
StringskipOnScmChange (optional)
booleanskipOnUpstreamChange (optional)
boolean$class: 'DeployApplication'This plugin creates a container on the OpenShift PaaS and deploys the application into the container.
serverName
StringappName
Stringcartridges
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:
Stringdomain
StringgearProfile
StringdeploymentPackage
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.
StringenvironmentVariables
Specify a space delimited list of environment variables (key=value) to be assigned to the application. e.g. LOAD_DATA=true MVN_DEPLOY=true
StringautoScale
booleandeploymentType
GIT, BINARYopenshiftDirectory
String$class: 'DeployBox'id
Stringcloud
Stringworkspace
Stringbox
StringboxVersion
StringinstanceName
Stringprofile
Stringclaims
Stringprovider
Stringlocation
StringinstanceEnvVariable
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
Stringtags
Stringvariables
Stringexpiration
$class: 'AlwaysOn'$class: 'ShutDown'hours
Stringdate
Stringtime
String$class: 'Terminate'hours
Stringdate
Stringtime
StringautoUpdates
StringalternateAction
StringwaitForCompletion
booleanwaitForCompletionTimeout
intboxDeploymentType
StringsamDeploysettings
credentialsId
Stringregion
Strings3Bucket
StringstackName
StringtemplateFile
template.yaml
app/template.json
StringkmsKeyId (optional)
StringoutputTemplateFile (optional)
template-#jobId.yaml by default.
Stringparameters (optional)
key
Stringvalue
StringroleArn (optional)
Strings3Prefix (optional)
Stringtags (optional)
key
Stringvalue
StringcrxDeploypackageIdFilters (optional)
**/*.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.
StringbaseUrls (optional)
username[:password]@ between the scheme and the hostname.
StringacHandling (optional)
Stringautosave (optional)
intbehavior (optional)
StringcredentialsId (optional)
/$username/keys/$fingerprint.
StringdisableForJobTesting (optional)
booleanlocalDirectory (optional)
Stringrecursive (optional)
booleanreplicate (optional)
booleanrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
long$class: 'DeployPromotionBuilder'hosts
com.cloudbees.plugins.deployer.hosts.DeployHost<?, ?>$class: 'DeployScriptBuilder'out
Specify full path to target connection file.
File location must be specified as:
Stringin
Specify path to file that contains SQL script.
File location must be specified as:
StringbuildMasterDeployBuildToStageDeploys (or re-deploys) a build to a particular stage.
Note: that when used in a pipeline step that the applicationId, releaseNumber, and buildNumber fields are required:
buildMasterDeployBuildToStage(applicationId: BUILDMASTER_APPLICATION_ID, releaseNumber: BUILDMASTER_RELEASE_NUMBER, buildNumber: BUILDMASTER_BUILD_NUMBER)
applicationId
The identifier of the BuildMaster application to trigger the build for.
Options are:
StringreleaseNumber
The BuildMaster release number to trigger the build for. Options are:
The job will fail if there is no active BuildMaster release.
StringbuildNumber
The BuildMaster build number to trigger the deployment for.
The must be set to an existing build number. Typically this would be obtained from the output of the createBuild step which populates the BUILDMASTER_BUILD_NUMBER environment variable.
Stringforce (optional)
booleanprintLogOnFailure (optional)
booleanstage (optional)
Optional. If not supplied, the next stage in the pipeline will be used.
Stringvariables (optional)
Set deployment level variables.
StringwaitUntilCompleted (optional)
boolean$class: 'Deployer'stack
StringdryRun
booleanbranch
StringapiKey
StringaddDeployToDashboardenv
StringbuildNumber
String$class: 'DeploymentBuilder'url
StringuserId
Stringpassword
StringenableZipFile
booleanenableAutoDeploy
booleanenableTestCase
testcaseblock
projectname
Stringtestcasename
Stringxpath
String$class: 'DescribeWithParamsBuilder'starter
booleanseparator
Stringexcludes
String$class: 'DescriptionSetterBuilder'This plugin automatically sets a description for the build as a step during building.
A description can be based on the log output (by searching it using a regular expression), or it can be hardcoded.
The description is exposed as DESCRIPTION_SETTER_DESCRIPTION environment variable
regexp
\[INFO\] Uploading project information for [^\s]* ([^\s]*)
Stringdescription
StringsnDevOpsPackagename (optional)
StringartifactsPayload (optional)
StringsnDevOpsArtifactartifactsPayload (optional)
StringdevSpacesCreateazureCredentialsId
StringaksName (optional)
StringkubeconfigId (optional)
StringresourceGroupName (optional)
StringsharedSpaceName (optional)
StringspaceName (optional)
StringsvDeployTestDeploys 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
booleanhost
Stringport
StringmarFilePath
StringtestType
StringtokenCredentialId
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".
Stringsecured
booleansvDeployVirtualServiceDeploys 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
booleanhost
Stringport
StringvseName
StringmarFilesPaths
for files in job workspace you can specify:
for files on the DevTest machine you can specify:
StringtokenCredentialId
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".
Stringsecured
booleansvStartVirtualServiceStarts 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
booleanhost
Stringport
StringvseName
StringvsNames
StringtokenCredentialId
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".
Stringsecured
booleansvStopVirtualServiceStops 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
booleanhost
Stringport
StringvseName
StringvsNames
StringtokenCredentialId
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".
Stringsecured
booleansvUndeployVirtualServiceUndeploys (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
booleanhost
Stringport
StringvseName
StringvsNames
StringtokenCredentialId
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".
Stringsecured
booleanimportDeveloperProfileimportIntoExistingKeychain (optional)
booleankeychainId (optional)
StringkeychainName (optional)
StringkeychainPath (optional)
StringkeychainPwd (optional)
class hudson.util.SecretprofileId (optional)
String$class: 'DiawiUploader'token
StringfileName
StringproxyHost
StringproxyPort
intproxyProtocol
Stringdingtalkrobot
Stringat (optional)
StringatAll (optional)
booleanbtnLayout (optional)
H, Vbtns (optional)
title
StringactionUrl
StringhideAvatar (optional)
booleanmessageUrl (optional)
StringpicUrl (optional)
StringsingleTitle (optional)
StringsingleUrl (optional)
Stringtext (optional)
Stringtitle (optional)
Stringtype (optional)
TEXT, LINK, MARKDOWN, ACTION_CARD$class: 'DistTestingBuilder'The goal of this plugin is to enable a distributed testing of some compiled classes on multiple nodes. Tests are send one by one to nodes in the label specified for the project and run. Test results are saved in the "results" directory in the project workspace. f.e. "TEST-helloword.HelloTest.xml" for the test class "helloworld.HelloTest".
This plugin suppose that all slaves in the specified label have a shared workspace directory. (like NFS)
Only classes in the "Tests classes directory" directory with a file name containing a "test" substring (case insensitive) are automatically found by this plugin and run.
If you enable "Publish JUnit test result report" in the "Post-build Actions" section and type "results/*.xml" you will see test results in the Hudson's web UI.
Only nodes in a label which were specified for this project ("Tie this project to a node") will be used for distributed testing. This label must contain at least 2 nodes.
It's possible let this plugin to compile tests class sources which were checkout from a repository if "Compile tests" checkbox was checked. Remember to provide all necessary libraries needed for compilation.
It's possible to check a "Wait for nodes which are busy" checkbox to wait for other nodes which are busy to be freed.
distLocations
distDir
StringlibLocations
libDir
StringtestDir
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.
StringwaitForNodes
Wait for modes in the label which are now occupied by some other builds. This doesn't wait for nodes which are offline
booleancompileTests
If checked then all source codes in the "Tests classes directory" will be compiled. It's necessary to provide all libraries for compilation. Compiled tests will be saved into the directory "tests".
boolean$class: 'DockerBuilderControl'option
$class: 'DockerBuilderControlOptionProvisionAndStart'cloudName
StringtemplateId
String$class: 'DockerBuilderControlOptionRun'cloudName
Stringimage
StringpullCredentialsId
StringdnsString
Stringnetwork
StringdockerCommand
StringmountsString
StringvolumesFrom
StringenvironmentsString
Stringhostname
Stringuser
StringextraGroupsString
StringmemoryLimit
intmemorySwap
intcpuPeriod
longcpuQuota
longcpuShares
intshmSize
intbindPorts
StringbindAllPorts
booleanprivileged
booleantty
booleanmacAddress
String$class: 'DockerBuilderControlOptionStart'cloudName
StringcontainerId
String$class: 'DockerBuilderControlOptionStop'cloudName
StringcontainerId
Stringremove
boolean$class: 'DockerBuilderControlOptionStopAll'remove
boolean$class: 'DockerBuilderNewTemplate'dockerTemplate
dockerTemplateBase
$class: 'DockerTemplateBase'image
StringbindAllPorts (optional)
booleanbindPorts (optional)
StringcapabilitiesToAddString (optional)
A list of new line separated capabilities.
Each line represents an option for the --cap-add parameter sent to the docker server. Each one must be a known capability "Key" as per the docker documentation.
Please check https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities for further information.
StringcapabilitiesToDropString (optional)
A list of new line separated capabilities.
Each line represents an option for the --cap-drop parameter sent to the docker server. Each one must be a known capability "Key" as per the docker documentation.
Please check https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities for further information.
StringcpuPeriod (optional)
Set the period of CPUs to limit the container’s CPU usage.
The default CPU CFS (Completely Fair Scheduler) period is 100000us.
Consult Docker Run Documentation for further information.
longcpuQuota (optional)
Limits the container’s CPU usage.
The default 0 value allows the container to take 100% of a CPU resource.
Consult Docker Run Documentation for further information.
longcpuShares (optional)
intdevicesString (optional)
StringdnsString (optional)
StringdockerCommand (optional)
StringenvironmentsString (optional)
Zero or more environment variables that are set within the docker container. This is a multi-line text field. Each line must be of the form key=value and specify one variable name and its value.
Note that quotes are not interpreted.
e.g. foo="bar" will result in the quotes being part of foo's value.
Note also that whitespace is easily broken. Editing this field this without first expanding the box to its multi-line form will cause any whitespace within a line to be turned into end of line codes, breaking up the line and thus changing its meaning.
e.g. The single setting:
JENKINS_SLAVE_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
can be (accidentally) turned into three separate settings:
JENKINS_SLAVE_SSH_PUBKEY=ssh-rsa MyPubKey jenkins@hostname
thus preventing the configuration from working as was intended.
StringextraDockerLabelsString (optional)
A list of new line separated docker labels to be set on the container, Specified in the form "label_name=value".
This has no effect on Jenkins functionality, and is not related to the labels used by Jenkins to map jobs to agent nodes. These labels are metadata attached to the docker container itself (again, not the jenkins agent), and which can typically be read using the docker inspect command.
This can be useful when using a docker cluster (like docker swarm) to pass information to the scheduler, in conjunction with constraints; or to let other services (portainer, prometheus...) know how they should categorize or otherwise deal with this specific container.
Notes:
StringextraGroupsString (optional)
StringextraHostsString (optional)
Stringhostname (optional)
StringmacAddress (optional)
StringmemoryLimit (optional)
The operator can constrain the memory available to a container. If the host supports swap memory, then the setting can be larger than physical RAM.
When the processes inside the container exceed the memory limit, effects vary depending on your setup, e.g. out of memory errors may occur or the operating system could start killing processes.
Consult Docker Run Documentation for further information.
Note that on most Docker installations, the memory limit will not stop Jenkins/Docker from spawning so many containers that the machines total available memory will be exceeded. However, some Docker installations might be able to constrain the number of containers automatically using the memory limit.
intmemorySwap (optional)
intmountsString (optional)
Stringnetwork (optional)
Stringprivileged (optional)
booleanpullCredentialsId (optional)
StringsecurityOptsString (optional)
A list of new line separated security options.
Each line represents an option for the --security-opt parameter sent to the docker server. The options are in the format key=value.
Please check https://docs.docker.com/engine/reference/run/#security-configuration for further information.
StringshmSize (optional)
inttty (optional)
booleanuser (optional)
StringvolumesFromString (optional)
Stringconnector
For all connection methods, Jenkins will start by triggering a docker run. Then, after this step, there will optionally be more steps to establish the connection. There is currently three alternative ways to connect your Jenkins master to the dynamically provisioned Docker agents.
There are different pros and cons for each connection method. Depending on your environment, choose the one matching your needs. More detailed prerequisites are provided once you select a given method.
docker exec, all by using the Docker API. The agent does not need to be able to reach the master through the network layers to communicate ; all will go through Docker API.
docker run command with the right secret. And the remoting agent will establish the connection with the master through the network. Hence, the agent must be able to access the master through its address and port.
attachentryPointCmdString (optional)
StringjavaExe (optional)
StringjvmArgsString (optional)
Stringuser (optional)
root") will be used if this is left blank.
StringjnlpjnlpLauncher
jnlptunnel
Stringvmargs
StringwebSocket (optional)
booleanworkDirSettings (optional)
disabled
booleanworkDirPath
StringinternalDir
StringfailIfWorkDirIsMissing
booleanentryPointArgumentsString (optional)
StringjenkinsUrl (optional)
Stringuser (optional)
StringsshsshKeyStrategy
$class: 'InjectSSHKey'user
String$class: 'ManuallyConfiguredSSHKey'credentialsId
StringsshHostKeyVerificationStrategy
$class: 'KnownHostsFileKeyVerificationStrategy'Checks the known_hosts file (~/.ssh/known_hosts) for the user Jenkins is executing under, to see if an entry exists that matches the current connection.
This method does not make any updates to the Known Hosts file, instead using the file as a read-only source and expecting someone with suitable access to the appropriate user account on the Jenkins controller to update the file as required, potentially using the ssh hostname command to initiate a connection and update the file appropriately.
$class: 'ManuallyProvidedKeyVerificationStrategy'Checks the key provided by the remote host matches the key set by the user who configured this connection.
key
The SSH key expected for this connection. This key should be in the form `algorithm value` where algorithm is one of ssh-rsa or ssh-dss, and value is the Base 64 encoded content of the key.
String$class: 'ManuallyTrustedKeyVerificationStrategy'Checks the remote key matches the key currently marked as trusted for this host.
Depending on configuration, the key will be automatically trusted for the first connection, or an authorised user will be asked to approve the key. An authorised user will be required to approve any new key that gets presented by the remote host.
requireInitialManualTrust
Require a user with Computer.CONFIGURE permission to authorise the key presented during the first connection to this host before the connection will be allowed to be established.
If this option is not enabled then the key presented on first connection for this host will be automatically trusted and allowed for all subsequent connections without any manual intervention.
boolean$class: 'NonVerifyingKeyVerificationStrategy'Does not perform any verification of the SSH key presented by the remote host, allowing all connections regardless of the key they present.
javaPath (optional)
StringjvmOptions (optional)
StringlaunchTimeoutSeconds (optional)
intmaxNumRetries (optional)
Note: That this field applies first to checks that the SSH port is open for new TCP connections, and secondly to checks that the SSH service that owns the TCP port is accepting SSH connections.
e.g. a value of 3 would mean that (up to) 4 attempts (1 initial attempt plus 3 retries) would be made to check the availability of the TCP port, followed by (up to) 4 attempts (1 initial attempt plus 3 retries) to check the availability of the SSH service itself.
intport (optional)
intprefixStartSlaveCmd (optional)
StringretryWaitTime (optional)
intsuffixStartSlaveCmd (optional)
StringlabelString
StringinstanceCapStr
The maximum number of containers, based on this template, that this provider is allowed to run in total. A negative value, or zero, or 2147483647 all mean "no limit" is imposed on the this template, although the overall cloud instance limit (if any) will still apply.
Note that containers which have not been created by Jenkins are not included in this total.
As an alternative, some Docker setups can also determine the maximum number of containers automatically using memory/cpu constraints.
Stringdisabled (optional)
disabledByChoice (optional)
booleanenabledByChoice (optional)
Note: If problems are encountered then this functionality may be disabled automatically. If that happens then it will be shown here. In this situation, the disabled state is transient and will automatically clear after the stated period has elapsed.
booleanmode (optional)
NORMAL, EXCLUSIVEname (optional)
If blank or just whitespace, a default of "docker" will be used.
StringnodeProperties (optional)
? extends hudson.slaves.NodeProperty<?>pullStrategy (optional)
PULL_ALWAYS, PULL_LATEST, PULL_NEVERpullTimeout (optional)
Note: This overrides the read timeout specified for the cloud, but only for the docker pull operation (as this operation is expected to take longer than most docker operations).
intremoteFs (optional)
StringremoveVolumes (optional)
booleanretentionStrategy (optional)
Specify the strategy when docker containers shall be started and stopped:
idleMinutes
intstopTimeout (optional)
int$class: 'DockerBuilderPublisher'dockerFileDirectory
StringfromRegistry
url
https://index.docker.io/v1/).
StringcredentialsId
Stringcloud
StringtagsString
StringpushOnSuccess
booleanpushCredentialsId
StringcleanImages
booleancleanupWithJenkinsJobDelete
booleannoCache (optional)
--no-cache which disables caching of layers. See the docker build command for more information.
booleanpull (optional)
--pull to pull the latest version of the base image, instead of using the local one. See the docker build command for more information.
boolean$class: 'DockerComposeBuilder'useCustomDockerComposeFile
booleandockerComposeFile
Stringoption
$class: 'ExecuteCommandInsideContainer'privilegedMode
booleanservice
Stringcommand
Stringindex
intworkDir
String$class: 'StartAllServices'$class: 'StartService'service
Stringscale
int$class: 'StopAllServices'$class: 'StopService'service
String$class: 'DockerPullImageBuilder'registry
url
https://index.docker.io/v1/).
StringcredentialsId
Stringimage
StringdockerShellconnector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTY, OKHTTPcredentialsId (optional)
StringreadTimeout (optional)
intcontainerLifecycle (optional)
createContainer (optional)
bindAllPorts (optional)
booleanbindPorts (optional)
Stringcommand (optional)
StringcpuShares (optional)
intcpusetCpus (optional)
StringcpusetMems (optional)
StringdevicesString (optional)
StringdnsString (optional)
StringdockerLabelsString (optional)
Stringentrypoint (optional)
StringenvironmentString (optional)
StringextraHostsString (optional)
Stringhostname (optional)
StringlinksString (optional)
StringmacAddress (optional)
StringmemoryLimit (optional)
longnetworkMode (optional)
Stringprivileged (optional)
booleanrestartPolicy (optional)
policyName
NO, UNLESS_STOPPED, ALWAYS, ON_FAILUREmaximumRetryCount
intshmSize (optional)
longtty (optional)
booleanuser (optional)
StringvolumesFromString (optional)
StringvolumesString (optional)
Stringworkdir (optional)
Stringimage (optional)
StringpullImage (optional)
connector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTY, OKHTTPcredentialsId (optional)
StringreadTimeout (optional)
intcredentialsId (optional)
StringpullStrategy (optional)
PULL_ALWAYS, PULL_ONCE, PULL_LATEST, PULL_NEVERregistriesCreds (optional)
registryAddr
StringcredentialsId
StringremoveContainer (optional)
force (optional)
booleanremoveVolumes (optional)
booleanstopContainer (optional)
connector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTY, OKHTTPcredentialsId (optional)
StringreadTimeout (optional)
inttimeout (optional)
intexecutorScript (optional)
StringlongConnector (optional)
$class: 'CloudNameDockerConnector'cloudName
String$class: 'DockerConnector'serverUrl
StringapiVersion (optional)
StringconnectTimeout (optional)
intconnectorType (optional)
JERSEY, NETTY, OKHTTPcredentialsId (optional)
StringreadTimeout (optional)
intshellScript (optional)
String$class: 'DoktorStep'server
StringmarkdownIncludePatterns
value
StringmarkdownExcludePatterns
value
StringasciidocIncludePatterns
value
StringasciidocExcludePatterns
value
String$class: 'DotNetCoreRunner'targetCode
//Simple Example
public class JenkinsPlugin
{
public static void ScriptMain()
{
Console.WriteLine("Hello World from c#!!!");
}
}
// Complete example
using DotNetTools.Jenkins;
using System;
public class JenkinsPlugin
{
public static void ScriptMain(JenkinsManager manager)
{
Console.WriteLine("Hello World from c#!!!");
manager.SetSessionEnv("PI", Math.PI.ToString());
}
}
public void SetSessionEnv(string key, string value);
public string GetSessionEnv(string key);
StringadditionalPackages
StringdownloadProgetPackageDownload options are:
See Inedo documentation.
feedName
StringgroupName
StringpackageName
Stringversion
StringdownloadFormat
StringdownloadFolder
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}
StringcrxDownloadpackageIds (optional)
StringbaseUrl (optional)
username[:password]@ between the scheme and the hostname.
StringcredentialsId (optional)
/$username/keys/$fingerprint.
StringignoreErrors (optional)
booleanlocalDirectory (optional)
Stringrebuild (optional)
booleanrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
longgoogleStorageDownloadcredentialsId
StringbucketUri
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.
StringlocalDirectory
The local directory that will store the downloaded files. The path specified is considered relative to the build's workspace. Example value:
StringpathPrefix (optional)
The specified prefix will be stripped from all downloaded filenames. Filenames that do not start with this prefix will not be modified. If this prefix does not have a trailing slash, it will be added automatically.
String$class: 'DoxygenBuilder'doxyfilePath
StringinstallationName
StringcontinueOnBuildFailure
booleanunstableIfWarnings
boolean$class: 'DrMemoryBuilder'executable
Stringarguments
StringlogPath
StringtreatFailed
boolean$class: 'DropAllBuilder'changeLogFile (optional)
StringchangeLogParameters (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringinstallationName (optional)
Stringlabels (optional)
StringliquibasePropertiesPath (optional)
Stringpassword (optional)
StringresourceDirectories (optional)
Stringurl (optional)
Stringusername (optional)
String$class: 'DrupalInstanceBuilder'db
Stringroot
Stringprofile
Stringrefresh
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.
booleanupdb
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
booleancomment
booleansql
booleansecurity
booleani18n
booleanroot
Stringlogs
Stringexcept
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.
StringignoresPass
If checked, warnings flagged as ignored will pass.
Note that the ignore system was introduced in Coder 7.x-2.4. This option will be ignored if using an older version of Coder.
boolean$class: 'DrupalTestsBuilder'uri
Stringroot
Stringlogs
StringexceptGroups
Actions, Aggregator, AJAX, Batch API, Block, Blog, Book, Bootstrap, Cache, Color, Comment, Contact, Contextual, Dashboard, Database, DBLog, Entity API, Field API, Field types, Field UI, File, File API, File API (remote), Filter, Form API, Forum, Help, Image, Locale, Mail, Menu, Module, Node, OpenID, Pager, Path, Path API, PHP, Poll, Profile, RDF, Search, Session, Shortcut, SimpleTest, Statistics, Syslog, System, Taxonomy, Theme, Tracker, Translation, Trigger, Update, Update API, Upgrade path, User, XML-RPCMultiple groups can be separated by a comma.
StringexceptClasses
Specify Simpletest classes that should not be tested, for instance 'UserLoginTestCase'.
Multiple classes can be separated by a comma.
String$class: 'ECXCDMBuilder'name
Stringpassword
Stringurl
Stringjob
Stringproduction
booleanmaxWaitTime
int$class: 'EclipseBuckminsterBuilder'installationName
Stringcommands
StringlogLevel
Stringparams
StringtargetPlatformName
StringuserTemp
StringuserOutput
StringuserCommand
StringuserWorkspace
StringglobalPropertiesFile
StringequinoxLauncherArgs
String$class: 'ElasticsearchQueryBuilder'query
StringaboveOrBelow
Stringthreshold
longsince
longunits
String$class: 'EndAnalysisBuildStep'restoreBuildFile
shouldRestore
booleanfolders
StringparentPom
String$class: 'EnvInjectBuilder'propertiesFilePath
StringpropertiesContent
String$class: 'EnvPropagatorBuilder'envVariableString
String$class: 'EnvironmentManagerBuilder'systemId
intenvironmentId
intinstanceId
intcopyToServer
booleannewEnvironmentName
StringserverType
StringserverId
intserverHost
StringserverName
StringcopyDataRepo
booleanrepoType
StringrepoHost
StringrepoPort
intrepoUsername
StringrepoPassword
StringabortOnFailure
boolean$class: 'EnvironmentTagBuilder'credentials
Stringregion
String$class: 'EstimateBuilder'name
Stringtoken
StringarchiveFilePath
StringregWhichIncludedModules
StringreportConfigName
Stringuri
Stringsaasuri
Stringlanguage
StringregexExclude
StringtestOnly
booleanmaxNumberOfViolations
longfailBlockTotalVio
booleanmaxNumberOfBlockerViolations
longfailBlockBlockerVio
booleanmaxNumberOfImportantViolations
longfailBlockImportantVio
booleanmaxNumberOfOptimizationViolations
longfailBlockOptimizationVio
booleanmaxNumberOfWarningViolations
longfailBlockWarningVio
booleanexamTest_ExecutionFileexamName
StringpythonName
StringexamReport
StringsystemConfiguration (optional)
StringclearWorkspace (optional)
booleanjavaOpts (optional)
Stringlogging (optional)
booleanloglevelLibCtrl (optional)
StringloglevelTestCtrl (optional)
StringloglevelTestLogic (optional)
StringpathExecutionFile (optional)
StringpathPCode (optional)
StringpdfMeasureImages (optional)
booleanpdfReport (optional)
booleanpdfReportTemplate (optional)
StringpdfSelectFilter (optional)
StringreportPrefix (optional)
StringtestrunFilter (optional)
name
Stringvalue
StringadminCases
booleanactivateTestcases
booleantimeout (optional)
intexamTest_ModelexamName
StringpythonName
StringexamReport
StringexecutionFile (optional)
StringsystemConfiguration (optional)
StringclearWorkspace (optional)
booleanexamModel (optional)
StringjavaOpts (optional)
Stringlogging (optional)
booleanloglevelLibCtrl (optional)
StringloglevelTestCtrl (optional)
StringloglevelTestLogic (optional)
StringmodelConfiguration (optional)
StringpdfMeasureImages (optional)
booleanpdfReport (optional)
booleanpdfReportTemplate (optional)
StringpdfSelectFilter (optional)
StringreportPrefix (optional)
StringtestrunFilter (optional)
name
Stringvalue
StringadminCases
booleanactivateTestcases
booleantimeout (optional)
int$class: 'ExeBuilder'exeName
StringcmdLineArgs
StringfailBuild
booleanexecuteCerberusCampaigncampaignName
Stringenvironment
Stringbrowser
Stringscreenshot
Stringverbose
StringpageSource
StringseleniumLog
StringtimeOut
Stringretries
Stringpriority
Stringtag
Stringss_p
StringssIp
Stringrobot
StringmanualHost
StringmanualContextRoot
Stringcountry
StringcerberusUrl
StringtimeOutForCampaignExecution
intexecutor
String$class: 'ExecuteCommandAction'command
Stringsearch
StringissueInText
Stringcomment
StringcommentVisibility
StringjobDsladditionalClasspath (optional)
StringadditionalParameters (optional)
java.util.Map<java.lang.String, java.lang.Object>failOnMissingPlugin (optional)
booleanfailOnSeedCollision (optional)
booleanignoreExisting (optional)
booleanignoreMissingFiles (optional)
booleanlookupStrategy (optional)
JENKINS_ROOT, SEED_JOBremovedConfigFilesAction (optional)
Note: when using multiple Job DSL build steps in a single job, set this to "Delete" only for the last Job DSL build step. Otherwise config files may be deleted and re-created. See JENKINS-44142 for details.
IGNORE, DELETEremovedJobAction (optional)
Note: when using multiple Job DSL build steps in a single job, set this to "Delete" or "Disable" only for the last Job DSL build step. Otherwise jobs will be deleted and re-created or disabled and re-enabled and you may lose the job history of generated jobs. See JENKINS-44142 for details.
IGNORE, DISABLE, DELETEremovedViewAction (optional)
Note: when using multiple Job DSL build steps in a single job, set this to "Delete" only for the last Job DSL build step. Otherwise views may be deleted and re-created. See JENKINS-44142 for details.
IGNORE, DELETEsandbox (optional)
booleanscriptText (optional)
Stringtargets (optional)
Scripts are executed in the same order as specified. The execution order of expanded wildcards is unspecified.
StringunstableOnDeprecation (optional)
booleanuseScriptText (optional)
boolean$class: 'ExecuteJobBuilder'jobId
longjobName
StringjobType
StringabortOnFailure
booleanabortOnTimeout
booleantimeoutMinutes
intpublish
booleanprojectId
longbuildId
StringsessionTag
StringappendEnv
booleanexecuteKatalonversion
Stringlocation
StringexecuteArgs
Stringx11Display
StringxvfbConfiguration
StringexecuteKatalonTestOpscredentialsId
StringapiKey
StringserverUrl
StringprojectId
StringplanId
StringexecManrequestType (optional)
StringaltEMConfig (optional)
url
Stringcredentials
Stringbookmark (optional)
name
Stringfolder (optional)
StringexecParams (optional)
list (optional)
key
Stringvalue
StringpostExecute (optional)
action
Stringparams
StringprocessList (optional)
database
Stringproject
Stringprocesses
processPath
Stringfolder
StringrequestName
Stringrequest (optional)
name
StringwaitConfig (optional)
pollInterval
StringmaxRunTime
StringexecuteTestsFromAlmOctane| Mode | Explanation |
| Execute suite runs in ALM Octane | Execute suites according to specified suite IDs. New suite runs will be created and executed in ALM Octane. Jenkins job is finished after triggering the suite runs. The job does not wait until the suite runs are finished. This method is useful if you want to schedule suite execution in ALM Octane. By default, newly created suite runs will have name of suite and will be assigned to default release. In order to override this default behaviour, add following parameters (one or more) to job with your desired values:
|
| Get tests from suites and trigger execution jobs | Get tests from suites and trigger execution jobs : Get tests from specified suite IDs. (This method assumes that tests are assigned to test runner jobs from the current Jenkins.) Tests are send to execution by their assigned test runner jobs. The main job is finished after the test runner jobs are finished. This method is useful if you intend to add your job to the ALM Octane Pipeline module. |
configurationId
StringworkspaceId
StringexecutionMode
Stringids
StringexecuteCloudifyWorkflowcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringdebugOutput (optional)
booleandeploymentId (optional)
StringexecutionParameters (optional)
Parameters to pass to the execution, in YAML/JSON format.
StringprintLogs (optional)
booleantenant (optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
StringwaitForCompletion (optional)
booleanworkflowId (optional)
The ID of the workflow to execute.
String$class: 'ExecutorBuildStep'frameworkType
StringrunningType
Stringapp
StringtestApplication
StringdeviceQueries
Other field that can be used:
StringrunTags
StringexecutorOptions
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.
intminDevices
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.
intignoreTestsFile
StringoverallExecTimeout
intcreationTimeout
intexportIpaappURL (optional)
StringarchiveDir (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
StringassetPackManifestURL (optional)
StringcompileBitcode (optional)
booleancopyProvisioningProfile (optional)
booleandevelopmentTeamID (optional)
StringdevelopmentTeamName (optional)
StringdisplayImageURL (optional)
StringfullSizeImageURL (optional)
StringipaExportMethod (optional)
StringipaName (optional)
StringipaOutputDirectory (optional)
StringkeychainId (optional)
StringkeychainName (optional)
StringkeychainPath (optional)
StringkeychainPwd (optional)
class hudson.util.SecretmanualSigning (optional)
booleanpackResourcesAsset (optional)
booleanprovisioningProfiles (optional)
provisioningProfileAppId
StringprovisioningProfileUUID
StringresourcesAssetURL (optional)
StringsigningMethod (optional)
StringstripSwiftSymbols (optional)
booleansymRoot (optional)
Stringthinning (optional)
StringunlockKeychain (optional)
booleanuploadBitcode (optional)
booleanuploadSymbols (optional)
booleanxcodeName (optional)
StringxcodeProjectPath (optional)
StringxcodeSchema (optional)
StringxcodeWorkspaceFile (optional)
StringexportPackagesexportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ExportParametersBuilder'filePath
StringfileFormat
StringkeyPattern
StringuseRegexp
booleanexportProjectsexportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ExporterBuilder'$class: 'ExtensiveTestingBuilder'testPath
Stringlogin
Stringpassword
StringserverUrl
StringprojectName
Stringdebug
booleandownloadFeatureFilesserverAddress
StringprojectKey
StringtargetPath
String$class: 'FeedStatus'prefix
Stringstatus
String$class: 'FigletBuilder'message
StringfileOperationsfileOperations
fileCopyOperationincludes
Stringexcludes
StringtargetLocation
StringflattenFiles
booleanrenameFiles
booleansourceCaptureExpression
StringtargetNameExpression
StringfileCreateOperationfileName
StringfileContent
StringfileDeleteOperationincludes
Stringexcludes
StringfileDownloadOperationurl
StringuserName
Stringpassword
StringtargetLocation
StringtargetFileName
StringproxyHost
StringproxyPort
StringfileJoinOperationsourceFile
StringtargetFile
StringfilePropertiesToJsonOperationsourceFile
StringtargetFile
StringfileRenameOperationsource
Stringdestination
StringfileTransformOperationincludes
Stringexcludes
StringfileUnTarOperationfilePath
StringtargetLocation
StringisGZIP
booleanfileUnZipOperationfilePath
StringtargetLocation
StringfileZipOperationfolderPath
StringoutputFolderPath
StringfolderCopyOperationsourceFolderPath
StringdestinationFolderPath
StringfolderCreateOperationfolderPath
StringfolderDeleteOperationfolderPath
StringfolderRenameOperationsource
Stringdestination
String$class: 'FireLineBuilder'fireLineTarget
csp
If you select "Yes", this plugin will set the following content of CSP to allow access to HTML with JS or CSS.
sandbox allow-scripts; default-src *; style-src * http://* 'unsafe-inline' 'unsafe-eval'; script-src 'self' http://* 'unsafe-inline' 'unsafe-eval'
Warning:
There is a security risk if you select "Yes".
booleanblockBuild
If there are some questions of block level detected from your project,FireLine plugin will make build fail when you select "Yes".
booleanconfiguration
<?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>
以上配置文件去掉了日志类的规则,所以火线扫描过程中就不会执行日志类规则的检查。
StringreportPath
StringreportFileName
StringbuildWithParameter
可通过配置使用build with parameter插件,在项目构建时灵活使用火线扫描。
例如:在项目配置中设置参数化构建参数。配置boolean类型参数fireline。
则在此输入框中填写${fireline}即可
Stringjdk
JDK to be used for this FireLine analysis.
Tips:
JDK1.7 or 1.8 is compatible with FireLine.
Stringjvm
合理设置JVM参数可以有效提高扫描效率,建议JVM最低配置如下:
"-Xms1g -Xmx1g -XX:MaxPermSize=512m"
String$class: 'FitnesseBuilder'options
java.util.Map<java.lang.String, java.lang.String>$class: 'FixResultBuilder'defaultResultName
Stringsuccess
Stringunstable
Stringfailure
Stringaborted
StringflywayrunnerinstallationName
StringflywayCommand
Stringurl
Stringlocations
StringcommandLineArgs
StringcredentialsId
String$class: 'FogbugzLinkBuilder'frugalTestinguserId
StringtestId
StringrunTag
StringgetJtl
booleanserverUrl (optional)
String$class: 'FtpRenameBuilder'ftpServer
StringftpPort
if you don't specify the port, the default port is 21.
intftpUser
StringftpPassword
class hudson.util.SecretftpPath
Specify the path to your artifact.
StringartifactName (optional)
StringnewArtifactName (optional)
StringremoteDirectory (optional)
Optional destination folder.
This folder will be below the one in the global configuration, if present.
The folder won't be created if does not exist.
String$class: 'FuzzBuildStep'configurationFilePath
The file path where the test configuration file (*.set or *.testplan) for this job can be found, relative to the project's workspace.
A test configuration file defines what kind of testing is to be done, and can be created using Defensics. Configure a test suite in Defensics and save the settings file in File -> Save Settings.
StringconfigurationOverrides (optional)
Additional test configuration settings that override the settings saved in the test configuration file. This can be useful if, for example, the test target address needs to be set dynamically.
The available settings are the same as the Defensics command line settings. Each setting should follow the format '--setting-name value'. Multiple settings are separated with spaces.
Example for HTTP Server Test Suite:
--uri https://example.com --http-status-filter "1xx 2xx 3xx"
StringdefensicsInstance (optional)
StringsaveResultPackage (optional)
boolean$class: 'FxCopBuilder'toolName
Stringfiles
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 ]
StringoutputXML
FxCop project or XML report output file.
Command Line Argument: /out:[ output file path ]
StringruleSet
Rule set to be used for the analysis.
Command Line Argument: /ruleset:=[ Rule set file path ]
StringignoreGeneratedCode
Suppress analysis results against generated code.
Command Line Argument: /ignoregeneratedcode
booleanforceOutput
Write output XML and project files even in the case where no violations occurred.
Command Line Argument: /forceoutput
booleancmdLineArgs
StringfailBuild
boolean$class: 'GCloudSDKBuilder'command
String$class: 'GCloudSDKWithAuthBuilder'credentialsId
Stringcommand
String$class: 'GatekeeperCommit'commitUsername
String$class: 'GatekeeperMerge'commitUsername
StringreleaseFilePath
StringreleaseFileContentTemplate
String$class: 'GatekeeperPush'gcrImageVulnerabilityScannerimageName (optional)
StringgenexusbgxInstallationId
StringkbPath
StringkbVersion
StringkbEnvironment
StringkbDbCredentialsId
StringforceRebuild
boolean$class: 'GenerateChangeScriptBuilder'in
Specify path to input folder for generating SQL change script. This folder should contain result of previously executed "Run Compare" build step.
Folder location must be specified as:
Stringout
Path to the file that should be used to store SQL change script.
File location must be specified as:
String$class: 'GenerateCreateScriptBuilder'outputFile
Path to the file that should be used to store create SQL script.
File location must be specified as:
StringinputFileOrFolder
Specify input folder/file for generating create SQL script. It should depend on input type you have selected.
Folder/file location must be specified as:
String$class: 'GenerateJenkinsReportBuilder'Generate a HTML report based on a previous schema compare build step. This report is accessible via build detail within build history in Jenkins.
Warning: You can include only one Generate Jenkins HTML comparison report step per project.
inputFolder
Specify path to input folder containing output from "Run Compare" build step.
Folder location must be specified as:
String$class: 'GenerateStandaloneReportBuilder'inputFolder
Specify path to input folder containing output from "Run Compare" build step.
Folder location must be specified as:
StringoutputFolder
Specify path to folder where standalone report will be exported.
Folder location must be specified as:
StringghostInspectorapiKey
StringsuiteId
StringstartUrl
Stringparams
StringgitAutomergercheckoutFromRemote (optional)
booleandetailConflictReport (optional)
booleanlimitAuthorsInDetailReport (optional)
intlimitCommitsInDetailReport (optional)
intlogLevel (optional)
TRACE, DEBUG, INFO, WARN, ERRORmergeRules (optional)
path
Stringresolution
KEEP_OLDER, KEEP_NEWER, MERGE_OLDER_TOP, MERGE_NEWER_TOPreleaseBranchPattern (optional)
StringremoteName (optional)
StringgitbisectjobToRun
StringgoodStartCommit
StringbadEndCommit
StringsearchIdentifier
StringrevisionParameterName
StringretryCount
intcontinuesBuild
booleanminSuccessfulIterations
intoverrideGitCommand
booleangitCommand
StringgitHubPRStatusstatusMessage
content
String$class: 'GitHubSetCommitStatusBuilder'contextSource (optional)
$class: 'DefaultCommitContextSource'$class: 'ManuallyEnteredCommitContextSource'context
StringstatusMessage (optional)
content
String$class: 'GitStatusWrapperBuilder'The gitStatusWrapper builder wraps set of job builders and handles PENDING/SUCCESS/FAILURE git statuses automatically
Check documentation here
buildSteps
hudson.tasks.BuildStep)account (optional)
The GitHub account that owns the repos that contains the commit to notify
Default: If SCM used, plugin will attempt to get details from SCM execution
Check documentation here
StringcredentialsId (optional)
The GitHub credentials, username/password or username/accessToken
Stringdescription (optional)
StringfailureDescription (optional)
The notification description for a failure, it will be displayed by GitHub
Default: value set to description
This field can also be given a regular expression to evaluate on the entire build log. To have the expression evaluated, wrap it with "/". Example: "/^buildVersion=(.*)$/"
Check documentation here
StringgitApiUrl (optional)
If you are a user of GitHub Enterprise use this field to set your custom API endpoint
Default: https://api.github.com
StringgitHubContext (optional)
The git status context key. Keys are used by GitHub to differentiate between notifications
Default: gitStatusWrapper
Check documentation here
Stringrepo (optional)
The GitHub repository that contains the commit to validate, must be owned by the user specified in the account field
Default: If SCM used, plugin will attempt to get details from SCM execution
Check documentation here
Stringsha (optional)
The SHA that identifies the commit to notify
Default: If SCM used, plugin will attempt to get details from SCM execution
Check documentation here
StringsuccessDescription (optional)
The notification description for a success, it will be displayed by GitHub
Default: value set to description
This field can also be given a regular expression to evaluate on the entire build log. To have the expression evaluated, wrap it with "/". Example: "/^buildVersion=(.*)$/"
Check documentation here
StringtargetUrl (optional)
Use this field to specify a custom target URL for the notification
Default: Jenkins build URL
Check documentation here
String$class: 'GitToIspwPublish'app (optional)
StringbranchMapping (optional)
StringconnectionId (optional)
StringcredentialsId (optional)
StringispwConfigPath (optional)
StringruntimeConfig (optional)
Stringstream (optional)
String$class: 'GnatmakeBuilder'gnatName
Stringswitches
StringfileNames
StringmodeSwitches
StringgprbuildinstallationName (optional)
Stringnames (optional)
Stringproj (optional)
-P switch. If not specified, GPRbuild uses the project file default.gpr if there is one in the current working directory. Otherwise, if there is only one project file in the current working directory, GPRbuild uses this project file.
Stringswitches (optional)
StringgradlebuildFile (optional)
StringgradleName (optional)
StringmakeExecutable (optional)
booleanpassAllAsProjectProperties (optional)
booleanpassAllAsSystemProperties (optional)
booleanprojectProperties (optional)
StringrootBuildScriptDir (optional)
Stringswitches (optional)
StringsystemProperties (optional)
Stringtasks (optional)
StringuseWorkspaceAsHome (optional)
Gradle will write to $HOME/.gradle by default for GRADLE_USER_HOME. For a multi-executor agent in Jenkins, setting the environment variable localized files to the workspace avoid collisions accessing gradle cache.
booleanuseWrapper (optional)
booleanwrapperLocation (optional)
StringgradleForesightprojectId
StringcredentialId
StringthundraAgentVersion (optional)
StringthundraGradlePluginVersion (optional)
String$class: 'Groovy'Executes a groovy script.
scriptSource
$class: 'FileScriptSource'scriptFile
String$class: 'StringScriptSource'command
StringgroovyName
Groovy installation which will execute the script. Specify the name of the Groovy installation as specified in the Global Jenkins configuration.
Stringparameters
Parameters for the Groovy executable.
StringscriptParameters
These parameters will be passed to the script.
Stringproperties
Instead of passing properties using the -D parameter you can define them here.
StringjavaOpts
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.
StringclassPath
Specify script classpath here. Each line is one class path item.
String$class: 'GroovyRemoteBuilder'remoteName
Stringscript
StringexamRun_GroovyexamName
Stringscript (optional)
StringstartElement (optional)
StringexamModel (optional)
StringmodelConfiguration (optional)
StringjavaOpts (optional)
Stringtimeout (optional)
intuseStartElement (optional)
boolean$class: 'GsshCommandBuilder'disable
booleanserverInfo
Stringshell
String$class: 'GsshFtpDownloadBuilder'disable
booleanserverInfo
StringremoteFile
StringlocalFolder
StringfileName
String$class: 'GsshFtpUploadBuilder'disable
booleanserverInfo
StringlocalFilePath
StringremoteLocation
StringfileName
String$class: 'GsshShellBuilder'disable
booleanserverInfo
Stringshell
String$class: 'HOTPlayer'project
Stringbundle
class com.arkea.jenkins.openstack.heat.orchestration.template.Bundlehabitattask (optional)
Stringdirectory (optional)
Stringartifact (optional)
Stringchannel (optional)
Stringorigin (optional)
StringbldrUrl (optional)
StringauthToken (optional)
StringlastBuildFile (optional)
Stringformat (optional)
StringsearchString (optional)
Stringcommand (optional)
Stringbinary (optional)
Stringpath (optional)
Stringdocker (optional)
booleanhealthAnalyzerproducts
$class: 'HealthAnalyzerLrStep'checkLrInstallation
booleancheckOsVersion
booleancheckFiles
filesList
field
StringnodePoolHoldduration
Stringreason
String$class: 'HttpRequest'url
StringacceptType (optional)
NOT_SET, TEXT_HTML, TEXT_PLAIN, APPLICATION_FORM, APPLICATION_JSON, APPLICATION_JSON_UTF8, APPLICATION_TAR, APPLICATION_ZIP, APPLICATION_OCTETSTREAMauthentication (optional)
StringconsoleLogResponseBody (optional)
booleancontentType (optional)
NOT_SET, TEXT_HTML, TEXT_PLAIN, APPLICATION_FORM, APPLICATION_JSON, APPLICATION_JSON_UTF8, APPLICATION_TAR, APPLICATION_ZIP, APPLICATION_OCTETSTREAMcustomHeaders (optional)
name
Stringvalue
StringmaskValue
booleanhttpMode (optional)
GET, HEAD, POST, PUT, DELETE, OPTIONS, PATCHhttpProxy (optional)
StringignoreSslErrors (optional)
booleanmultipartName (optional)
StringoutputFile (optional)
StringpassBuildParameters (optional)
booleanproxyAuthentication (optional)
Stringquiet (optional)
booleanrequestBody (optional)
Stringtimeout (optional)
intuploadFile (optional)
StringuseSystemProperties (optional)
booleanvalidResponseCodes (optional)
StringvalidResponseContent (optional)
StringwrapAsMultipart (optional)
booleanhugobaseUrl (optional)
StringbuildFuture (optional)
booleandestination (optional)
Stringenvironment (optional)
StringhugoHome (optional)
Stringverbose (optional)
boolean$class: 'HyperBuilder'image
Stringcommands
StringipythonBuildercode
Eg: print(" Hello Jenkins, from Machine Learning Plugin ...... ! ")
StringfilePath
Eg: /home/alice/iris/ml.py
StringparserType
Stringtask
Eg: Training
StringkernelName
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)
Stringprojects
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.
Stringtestcases
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
Stringtestbed
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
Stringparams
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.
StringparamFile
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.
StringtestReportRequired
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.
booleandbCustomTag
This option enables you to define and assign a value to a custom tag.
Example: Create a tag that holds the build number so that you compare test execution results between builds.
For tests run against build 54322, use: --tag buildNumber=54322
Tip: Use a custom tag to identify executions or groups of executions on the iTest Team Server Test Execution page.
String$class: 'ImportFiles'url
StringcloudTestServerID
Stringfiles
Stringexcludes
Stringmode
StringadditionalOptions
StringimportPackagesimportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
StringimportProjectsimportConfigs (optional)
$class: 'ExportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportPackageConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ExportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ExportProjectConfig'filePath
StringexportPath
StringcreateNewPath
booleancredentialsId
Stringtimeout
String$class: 'ImportPackageAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportPackageDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectArchiveConfig'tmsPath
StringimportPath
StringimportConfigPath
StringreplaceFiles
boolean$class: 'ImportProjectAttributeConfig'filePath
StringcredentialsId
Stringtimeout
String$class: 'ImportProjectConfig'tmsPath
StringimportPath
StringimportMissingPackages
booleancredentialsId
Stringtimeout
String$class: 'ImportProjectDirConfig'tmsPath
StringimportPath
StringcredentialsId
Stringtimeout
String$class: 'InfluxDBPublisher'userCredentialsID
StringdbUrl
StringdbName
Stringcontent
StringinfluxDbQuerycheckName
StringinfluxQuery
StringexpectedThreshold
doublemarkUnstable (optional)
booleanretryCount (optional)
intretryInterval (optional)
intshowResults (optional)
booleaninsightAppSecregion
StringinsightCredentialsId
StringappId
StringscanConfigId
StringbuildAdvanceIndicator
StringvulnerabilityQuery
vulnerability.severity='HIGH'
StringmaxScanPendingDuration
0d 5h 30m
StringmaxScanExecutionDuration
0d 5h 30m
StringenableScanResults
booleansnInstallAppcredentialsId (optional)
StringapiVersion (optional)
StringappScope (optional)
application system ID is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
StringappSysId (optional)
application scope is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
StringappVersion (optional)
StringbaseAppAutoUpgrade (optional)
booleanbaseAppVersion (optional)
Stringurl (optional)
String$class: 'InstallBuilder'apkFile
StringuninstallFirst
booleanfailOnInstallFailure
booleansnInstanceScancredentialsId (optional)
StringapiVersion (optional)
StringcomboSysId (optional)
StringrequestBody (optional)
StringscanType (optional)
StringsuiteSysId (optional)
StringtargetRecordSysId (optional)
StringtargetTable (optional)
Stringurl (optional)
String$class: 'IqPolicyEvaluatorBuildStep'iqStage
StringiqApplication
manualApplicationapplicationId
StringselectedApplicationapplicationId
StringiqScanPatterns
**/target/*.war or **/target/*.ear. If unspecified, the scan will default to the patterns **/*.jar, **/*.war, **/*.ear, **/*.zip, **/*.tar.gz.
scanPattern
StringiqModuleExcludes
**/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
StringfailBuildOnNetworkError
booleanjobCredentialsId
- none -, otherwise select different credentials.
StringenableDebugLogging
booleanadvancedProperties
key1=value1
key2=value2
StringiqInstanceId (optional)
String$class: 'IspwRestApiRequest'connectionId (optional)
StringconsoleLogResponseBody (optional)
booleancredentialsId (optional)
StringispwAction (optional)
StringispwRequestBody (optional)
StringskipWaitingForSet (optional)
boolean$class: 'IssueFieldUpdateStep'issueSelector (optional)
$class: 'DefaultIssueSelector'$class: 'ExplicitIssueSelector'issueKeys
String$class: 'JqlIssueSelector'jql
String$class: 'P4JobIssueSelector'fieldId (optional)
StringfieldValue (optional)
String$class: 'IssueUpdatesBuilder'restAPIUrl
StringuserName
Stringpassword
Stringjql
StringworkflowActionName
Stringcomment
StringcustomFieldId
StringcustomFieldValue
StringresettingFixedVersions
booleancreateNonExistingFixedVersions
booleanfixedVersions
StringfailIfJqlFails
booleanfailIfNoIssuesReturned
booleanfailIfNoJiraConnection
boolean$class: 'JBossBuilder'operation
value
START_AND_WAIT, START, SHUTDOWN, CHECK_DEPLOYproperties
StringstopOnFailure
booleanserverName
String$class: 'JIRATicketEditor'jiraCredentialsID
StringnewTicketsTemplates
performDuplicateCheck
booleanparentJQL
Stringtitle
Stringtype
Stringpriority
Stringdescription
StringenvVarName
StringfieldValues
fieldHumanReadableName
StringvalueToSet
StringmodifyTicketsTemplates
jqlFilter
StringcommitRegEx
StringticketSource
Stringmodifications
$class: 'AddCommentModification'commentBody
String$class: 'ModifyArrayFieldModification'fieldHumanReadableName
StringmodificationType
StringmodificationValue
String$class: 'PerformTransitionModification'transitionName
Stringcomment
String$class: 'SetFieldModification'fieldHumanReadableName
StringvalueToSet
String$class: 'JIRAVersionEditor'jiraCredentialsID
StringversionModifiactions
versionName
StringreplaceDescription
booleandescriptionText
StringreleaseState
StringfailOnJQL
booleanfailQuery
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
StringexcludePattern
The files to exclude in an Ant-style filter. See javadoc
Example: lib/**/ModuleImportProgressDialog.js
This would omit any file named ModuleImportProgressDialog.js
Stringlogfile
The file to output to in a Checkstyle XML format
Example: target/jslint.xml
Stringarguments
The arguments to pass to JSLint. You can use any arguments that JSLint supports! Be sure, though, to prefix each argument with -D
Example: -Dadsafe=true, -Dcontinue=true
This would activate adsafe and continue
Example: -Dpredef=foo,bar,baz
This would be like having /*global foo,bar,baz*/ at the top of every JavaScript file JSLint runs on.
Example: -Dpredef=foo,bar,baz, -Dmaxlen=80
This would be like having /*global foo,bar,baz*/ at the top of every JavaScript file JSLint runs on. It also sets the maximum length of a line to 80 chars.
The default options we use are:
var defaultOptions = { bitwise: true, eqeqeq: false, immed: false, newcap: false, nomen: false, onevar: false, plusplus: false, regexp: false, rhino: true, undef: true, white: false, forin: true, sub: true, browser: true, laxbreak: true, predef: [ 'Ext', 'jQuery', 'window', '$', 'ActiveXObject', 'SWFObject' ] };
String$class: 'JabberBuilder'builderName
StringvenafiCodeSignWithJarSignertppName
StringcertLabel
StringextraArgs (optional)
This plugin invokes Jarsigner under the hood. Here you can specify extra custom CLI arguments to pass to Jarsigner.
These arguments will be appended to the Jarsigner CLI invocation, and take precedence over any arguments implicitly passed by this plugin.
argument
Stringfile (optional)
The path to the file to be signed.
Either a path or a glob must be given.
Stringglob (optional)
A glob that specifies the files to be signed.
Either a path or a glob must be given.
StringtimestampingServers (optional)
Specifies one or more timestamping authority servers to use during signing. Specifying this is strongly recommended, because it allows signed files to be usable even after the original signing certificate has expired.
If you specify more than one server, then a random one will be used.
Tip: here are some public timestamping authorities that you can use:
address
StringvenafiClientToolsDir (optional)
Specify the path to the directory in which Venafi CodeSign Protect client tools are installed. If not specified, it's autodetected as follows:
StringvenafiVerifyWithJarSignertppName
StringcertLabel
Stringfile (optional)
The path to the file to be verified.
Either a path or a glob must be given.
Stringglob (optional)
A glob that specifies the files to be verified.
Either a path or a glob must be given.
StringvenafiClientToolsDir (optional)
Specify the path to the directory in which Venafi CodeSign Protect client tools are installed. If not specified, it's autodetected as follows:
String$class: 'JbpmUrlResourceBuilder'url
StringprocessId
StringSoapUIPropathToTestrunner
StringpathToProjectFile
Stringenvironment (optional)
StringprojectPassword (optional)
StringtestCase (optional)
StringtestCaseTags (optional)
StringtestSuite (optional)
StringtestSuiteTags (optional)
String$class: 'JigomergeBuilder'source
Stringusername
Stringpassword
StringoneByOne
booleaneager
booleanvalidationScript
StringdryRun
booleanverbose
booleanignoreMergePatterns
StringcommitCommentPrefix
String$class: 'JiraEnvironmentVariableBuilder'Typical usage:
issue in (${JIRA_ISSUES})
issueSelector
$class: 'DefaultIssueSelector'$class: 'ExplicitIssueSelector'issueKeys
String$class: 'JqlIssueSelector'jql
String$class: 'P4JobIssueSelector'$class: 'JiraExtBuildStep'issueStrategy
$class: 'FirstWordOfCommitStrategy'$class: 'FirstWordOfUpstreamCommitStrategy'$class: 'MentionedInCommitStrategy'$class: 'SingleTicketStrategy'issueKey
Stringextensions
$class: 'AddComment'postCommentForEveryCommit
booleancommentText
String$class: 'AddFixVersion'fixVersion
The Fix Version to append. Must exist.
String$class: 'AddLabel'labelName
String$class: 'AddLabelToField'fieldName
StringfieldValue
String$class: 'Transition'transitionName
String$class: 'UpdateField'fieldName
StringfieldValue
String$class: 'JiraIssueUpdateBuilder'jqlSearch
Example:
or (e.g., combined with a Jira Issue Parameter, selecting one issue from a JQL result set):project = JENKINS and fixVersion = "$RELEASE_VERSION" and status not in (Resolved, Closed)
issue = $ISSUE_ID
StringworkflowActionName
Stringcomment
String$class: 'JiraReleaseVersionUpdaterBuilder'jiraProjectKey
Specify the project key. A project key is the all capitals part before the issue number in Jira.
(EXAMPLE-100)
StringjiraRelease
StringjiraDescription
String$class: 'JiraVersionCreatorBuilder'jiraVersion
StringjiraProjectKey
Specify the project key. A project key is the all capitals part before the issue number in Jira.
(EXAMPLE-100)
String$class: 'JobConfigRebrander'$class: 'JobDeleteBuilder'target
String$class: 'JobStrongAuthSimpleBuilder'jobUsers
StringuseGlobalUsers
booleanjobMinAuthUserNum
intuseJobExpireTime
booleanjobExpireTimeInHours
int$class: 'JobcopyBuilder'fromJobName
StringtoJobName
Stringoverwrite
booleanjobcopyOperationList
$class: 'DisableOperation'$class: 'EnableOperation'$class: 'ReplaceOperation'fromStr
StringexpandFromStr
booleantoStr
StringexpandToStr
booleanadditionalFilesetList
includeFile
StringexcludeFile
Stringoverwrite
booleanjobcopyOperationList
$class: 'DisableOperation'$class: 'EnableOperation'$class: 'ReplaceOperation'fromStr
StringexpandFromStr
booleantoStr
StringexpandToStr
boolean$class: 'KanboardTaskFetcher'projectIdentifier
StringtaskReference
StringtaskAttachments (optional)
StringtaskLinks (optional)
String$class: 'KarafBuildStepBuilder'useCustomKaraf
booleankarafHome
Stringflags
specify the port to connect to
-h [host]specify the host to connect to
-u [user]specify the user name
-p [password]specify the password (optional, if not provided, the password is prompted)
-vraise verbosity
-lset client logging level. Set to 0 for ERROR logging and up to 4 for TRACE
-r [attempts]retry connection establishment (up to attempts times)
-d [delay]intra-retry delay (defaults to 2 seconds)
-f [file]read commands from the specified file
-k [keyFile]specify the private keyFile location when using key login, need have BouncyCastle registered as security provider using this flag
-t [timeout]define the client idle timeout
Stringoption
$class: 'KarafCommandFileOption'file
String$class: 'KarafCommandScriptOption'script (optional)
StringunlockMacOSKeychainkeychainId (optional)
StringkeychainName (optional)
StringkeychainPath (optional)
StringkeychainPwd (optional)
class hudson.util.Secret$class: 'KlocworkBuildSpecBuilder'buildSpecConfig
buildCommand
Stringtool
Stringoutput
StringadditionalOpts
StringignoreErrors
boolean$class: 'KlocworkCiBuilder'ciConfig
buildSpec
StringprojectDir
StringcleanupProject
booleanreportFile
StringadditionalOpts
StringincrementalAnalysis
This feature allows for quick, incremental analyses of changed source files to enable pre/post-checkin/commit-like behavior . The goal is that only changed files are analyzed by the Klocwork kwciagent tool to replicate the local analysis developers would perform by using our supported IDE plugins or the command line utility. To enable this behavior, the plugin takes a list of the changed files from the SCM; this enables the system to analyze only the changed files when the workspace isn’t kept. Leave this cleared to analyze the whole project, or, if the workspace is kept, to perform a standard incremental analysis.
The diff file list is the file that contains the changed source files for Klocwork to analyze. All analyzed files must exist in the build specification generated by kwinject.
Note: All files to be analyzed must exist in the build specification.
If using Git, provide the previous commit that Git should perform a "diff" against. The change list between the current commit and the specified previous commit will be added to the diff file list for Klocwork to process by automatically calling "git diff <previous_commit>" during the build. Note: If you are using Git jenkins plugin to obtain source files for you pipeline job be sure to use 'Pipeline script from SCM' and specify the previous commit with the environment variable, 'GIT_PREVIOUS_COMMIT'. Also be aware that the first build in the job won't be able to access GIT_PREVIOUS_COMMIT and the first build will run full CI analysis.
If you are not using Git, or want to manually generate the change list by using Git, select this option. You will need to generate the diff file list by using a custom build-step (or similar). List one changed source file on each line of the file.
booleandifferentialAnalysisConfig
diffType
StringgitPreviousCommit
StringdiffFileList
String$class: 'KlocworkServerAnalysisBuilder'serverConfig
buildSpec
StringtablesDir
StringincrementalAnalysis
booleanignoreCompileErrors
booleanimportConfig
StringadditionalOpts
StringdisableKwdeploy
booleanduplicateFrom (optional)
StringenabledCreateProject (optional)
boolean$class: 'KlocworkServerLoadBuilder'serverConfig (optional)
tablesDir (optional)
StringbuildName (optional)
StringadditionalOpts (optional)
StringreportConfig (optional)
displayChart (optional)
booleanchartHeight (optional)
StringchartWidth (optional)
Stringquery (optional)
String$class: 'KlocworkXSyncBuilder'syncConfig
dryRun
booleanlastSync
StringprojectRegexp
StringstatusAnalyze
booleanstatusIgnore
booleanstatusNotAProblem
booleanstatusFix
booleanstatusFixInNextRelease
booleanstatusFixInLaterRelease
booleanstatusDefer
booleanstatusFilter
booleanadditionalOpts
String$class: 'KmapJenkinsBuilder'username
Stringpassword
StringkmapClient
Stringcategories
Stringteams
Stringusers
StringsendNotifications
booleanpublishOptional
teams
Stringusers
StringsendNotifications
booleanfilePath
StringappName
Stringbundle
Stringversion
Stringdescription
StringiconPath
String$class: 'KojiBuilder'kojiBuild
StringkojiTarget
StringkojiPackage
StringkojiOptions
StringkojiTask
StringkojiScratchBuild
booleankojiScmUrl
StringcfyKubernetesallowNodeRedefinition (optional)
booleanapiKeyCredentialsId (optional)
The ID of the credentials entry that contains the API key.
This parameter is optional; the API key may also be provided through "API options", however this method is preferred.
If provided, then this credentials entry must either be of type "text" or "file". In the latter case, the file is read as-is and the resultant string is used as the API credentials.
StringapiKeyFile (optional)
Path to file, relative to the Jenkins workspace, containing the API key.
This parameter is optional, as the API key may be provided by other means.
StringcaCert (optional)
StringcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringdebugOutput (optional)
booleandefinition (optional)
java.util.Map<java.lang.String, java.lang.Object>definitionAsString (optional)
StringdefinitionFile (optional)
StringdeploymentId (optional)
ID to assign to the created Cloudify deployment. If not provided, one will be randomly generated. You can obtain the deployment ID from the "environment data" output file.
StringechoEnvData (optional)
If checked, then the created environment's data will be printed to the job's log.
booleanechoInputs (optional)
booleanenvDataLocation (optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
StringgcpCredentialsFile (optional)
A YAML/JSON file containing GCP service account details, to use for authentication against GCP.
This parameter is optional, and is only relevant for authenticating against GCP.
If provided, it should follow the same layout as described in the "GCP Credentials ID" parameter.
StringgcpCredentialsId (optional)
The ID of the credentials to be used for authentication against GCP.
This parameter is optional, and is only relevant for authenticating against GCP.
If provided, it should be the ID of either a string-type or file-type credentials entry, with the standard GCP service account YAML/JSON syntax:
{
"type": "...",
"project_id": "...",
"private_key_id": "...",
"private_key": "...",
"client_email": "...",
"client_id": "...",
"auth_uri": "...",
"token_uri": "...",
"auth_provider_x509_cert_url": "...",
"client_x509_cert_url": "..."
}
Stringk8sDebug (optional)
booleank8sMaster (optional)
Stringnamespace (optional)
namespace value in the options field, if exists.
Stringoptions (optional)
java.util.Map<java.lang.String, java.lang.Object>optionsAsString (optional)
StringoptionsFile (optional)
StringskipSslVerification (optional)
booleansslCertFile (optional)
StringsslKeyFile (optional)
Stringtenant (optional)
StringvalidateStatus (optional)
boolean$class: 'KubernetesDeploy'context
configs (optional)
The path patterns for the Kubernetes configurations you want to deploy, in the form of Ant glob syntax.
StringcredentialsType (optional)
Choose how to get the kubeconfig file to authenticate with the Kubernetes cluster management endpoint.
3 options are supported:
~/.kube/config file through an SSH connection to the master node.See also: Configure kubectl
StringdeleteResource (optional)
Whether to delete the resource, if it is true, delete all resources in the config file.
booleandockerCredentials (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringenableConfigSubstitution (optional)
Substitute variables (in the form $VARIABLE or ${VARIABLE}) in the configuration with values from Jenkins environment variables.
This allows you to use dynamic values produced during the build in your Kubernetes configurations, e.g., a dynamically generated Docker image tag which will be used later in the deployment.
booleankubeConfig (optional)
path (optional)
kubeconfig file path relative to the current Jenkins workspace.
StringkubeconfigId (optional)
StringsecretName (optional)
imagePullSecrets entry. Environment variable substitution are supported for the name input, so you can use available environment variables to construct the name dynamically, e.g., some-secret-$BUILD_NUMBER. The name should be in the pattern [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*, i.e., dot (.) concatenated sequences of hyphen (-) separated alphanumeric words. (See Kubernetes Names)
If left blank, the plugin will generate a name based on the build name.
The secret name will be exposed with the environment variable $KUBERNETES_SECRET_NAME. You can use this in your Kubernetes configuration to reference the updated secret when the "Enable Variable Substitution in Config" option is enabled.
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: nginx
spec:
replicas: 1
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: some.private.registry.domain/nginx
ports:
- containerPort: 80
imagePullSecrets:
- name: $KUBERNETES_SECRET_NAME
Note that once the secret is created, it will only be updated by the plugin. You have to manually delete it when it is not used anymore. If this is a problem, you may use fixed name so every time the job runs, the secret gets updated and no new secret is created.
StringsecretNamespace (optional)
Stringssh (optional)
sshCredentialsId (optional)
StringsshServer (optional)
<host>[:<port>]) of the Kubernetes master node. If port is omitted, the default SSH port 22 will be used.
StringtextCredentials (optional)
certificateAuthorityData (optional)
clusters.cluster.certificate-authority-data value in the kubeconfig file.
StringclientCertificateData (optional)
users.user.client-certificate-data value in the kubeconfig file.
StringclientKeyData (optional)
users.user.client-key-data value in the kubeconfig file.
StringserverUrl (optional)
clusters.cluster.server address in the kubeconfig. Generally, it should start with https://.
StringkubernetesEngineDeploycluster (optional)
StringclusterName (optional)
StringcredentialsId (optional)
Stringlocation (optional)
StringmanifestPattern (optional)
Stringnamespace (optional)
StringprojectId (optional)
StringverboseLogging (optional)
booleanverifyDeployments (optional)
booleanverifyServices (optional)
booleanverifyTimeoutInMinutes (optional)
intzone (optional)
Stringloadcompletetestproject (optional)
Stringtest (optional)
StringactionOnErrors (optional)
StringactionOnWarnings (optional)
StringexecutorVersion (optional)
StringgenerateMHT (optional)
booleangeneratePDF (optional)
booleantimeout (optional)
StringuseTimeout (optional)
booleanleanIXMicroserviceIntelligenceapitoken (optional)
class hudson.util.Secretdependencymanager (optional)
Stringdeploymentstage (optional)
Stringdeploymentversion (optional)
Stringhostname (optional)
Stringjobresultchoice (optional)
Stringlxmanifestpath (optional)
Stringuseleanixconnector (optional)
booleaneventSourceLambdalambdaEventSourceBuildStepVariables
awsRegion
StringfunctionName
StringeventSourceArn
StringawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringfunctionAlias (optional)
StringuseInstanceCredentials (optional)
booleaninvokeLambdalambdaInvokeBuildStepVariables
awsRegion
StringfunctionName
Stringsynchronous
booleanawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringjsonParameters (optional)
envVarName
StringjsonPath (optional)
Stringpayload (optional)
StringuseInstanceCredentials (optional)
booleanpublishLambdalambdaPublishBuildStepVariables
awsRegion
StringfunctionARN
StringfunctionAlias
StringversionDescription
StringawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringuseInstanceCredentials (optional)
booleandeployLambdalambdaUploadBuildStepVariables
awsRegion
StringfunctionName
StringupdateMode
Stringalias (optional)
StringartifactLocation (optional)
StringawsAccessKeyId (optional)
StringawsSecretKey (optional)
StringcreateAlias (optional)
booleandeadLetterQueueArn (optional)
Stringdescription (optional)
StringenableDeadLetterQueue (optional)
booleanenvironmentConfiguration (optional)
environment
key
Stringvalue
StringconfigureEnvironment (optional)
booleankmsArn (optional)
Stringhandler (optional)
StringmemorySize (optional)
Stringpublish (optional)
booleanrole (optional)
Stringruntime (optional)
StringsecurityGroups (optional)
Stringsubnets (optional)
Stringtimeout (optional)
StringuseInstanceCredentials (optional)
boolean$class: 'LeapworkJenkinsBridgeBuilder'leapworkHostname
StringleapworkPort
StringleapworkAccessKey
StringleapworkSchNames
StringleapworkSchIds
StringleapworkDelay (optional)
StringleapworkDoneStatusAs (optional)
StringleapworkReport (optional)
StringleapworkScheduleVariables (optional)
StringleapworkWritePassedFlowKeyFrames (optional)
boolean$class: 'LeiningenBuilder'task
StringsubdirPath
StringcheckETLicenseCheck ECU-TEST license.
Pipelines usage:
checkETLicense(String toolName) : void
checkETLicense('ECU-TEST')
toolName
Stringinstallation (optional)
name
Stringhome
Stringproperties
? extends hudson.tools.ToolProperty<?>timeout (optional)
StringlighthouseReportfile
Stringname (optional)
StringdotnetListPackagedotnet list package command provides a convenient option to list all NuGet package references for a specific project or a solution. You first need to build the project in order to have the assets needed for this command to process.
config (optional)
Stringdeprecated (optional)
booleanframework (optional)
Stringframeworks (optional)
StringframeworksString (optional)
StringhighestMinor (optional)
booleanhighestPatch (optional)
booleanincludePrerelease (optional)
booleanincludeTransitive (optional)
booleanoutdated (optional)
booleanproject (optional)
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleansource (optional)
Stringsources (optional)
StringsourcesString (optional)
StringspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleanverbosity (optional)
StringworkDirectory (optional)
String$class: 'LoadImpactTestRunTask'apiTokenId
StringloadTestId
intcriteriaDelayValue
intcriteriaDelayUnit
StringcriteriaDelayQueueSize
intabortAtFailure
booleanthresholds
metric
Stringoperator
Stringvalue
intresult
StringpollInterval
intlogHttp
booleanlogJson
boolean$class: 'LoadNinjaBuilder'apiKey
StringscenarioId
Stringoeb
errorPassCriteria
Stringodb
durationPassCriteria
String$class: 'LoadPluginBuilder'url
Stringusername
Stringpassword
Stringfile
StringgreettestId
StringcredentialsId
String$class: 'LoadtestBuilder'loadtestBuilderModel
environmentShortName
StringauthToken
StringpresetName
StringloadtestScenario
StringloadtestThresholdParameters
metricType
StringevaluationDirection
StringnumericValue
doubledotnetNuGetLocalsdotnet nuget locals command clears or lists local NuGet resources in the http-request cache, temporary cache, or machine-wide global packages folder.
cacheLocation (optional)
all: Indicates that the specified operation is applied to all cache types: http-request cache, global packages cache, and the temporary cache. global-packages: Indicates that the specified operation is applied only to the global packages cache. The other cache locations aren't affected. http-cache: Indicates that the specified operation is applied only to the http-request cache. The other cache locations aren't affected. temp: Indicates that the specified operation is applied only to the temporary cache. The other cache locations aren't affected. StringforceEnglishOutput (optional)
booleanoperation (optional)
clear: The contents of the cache directories are deleted recursively. The executing user/group must have permission to the files in the cache directories. If not, an error is displayed indicating the files/folders that weren't cleared. list: Displays the path to the specified cache location.Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleanspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleanworkDirectory (optional)
String$class: 'LoginBuilder'credentialsId
StringhubUrl
StringmablrestApiKeyId
StringenvironmentId
StringapplicationId
StringapiBaseUrl (optional)
StringappBaseUrl (optional)
StringcontinueOnMablError (optional)
booleancontinueOnPlanFailure (optional)
booleandisableSslVerification (optional)
booleanlabels (optional)
StringmablBranch (optional)
String$class: 'MailCommandBuilder'| POP3 mail server address | Set POP3 mail server's hostname or ip address. |
| POP3 mail server port | Set POP3 mail server's port. Default value is 110. |
| POP3 User Name | Set POP3 mail server's user account. |
| POP3 Password | Set POP3 mail server's password. |
address
Stringport
Stringusername
Stringpassword
String$class: 'MakeAppTouchTestable'url
StringcloudTestServerID
StringinputType
StringprojectFile
Stringtarget
StringlaunchURL
StringbackupModifiedFiles
booleanadditionalOptions
StringjavaOptions
String$class: 'ManageInstance'cloud
Stringworkspace
Stringoperations
? extends com.elasticbox.jenkins.builders.Operation$class: 'MatlabBuilder'matlabRoot (optional)
Note: If the job runs on a remote agent, you must specify the full path to MATLAB root folder on the remote agent.
StringtestRunTypeList (optional)
$class: 'RunTestsAutomaticallyOption'taCoberturaChkBx (optional)
booleantaJunitChkBx (optional)
booleantaModelCoverageChkBx (optional)
booleantaPDFReportChkBx (optional)
booleantaSTMResultsChkBx (optional)
booleantatapChkBx (optional)
boolean$class: 'RunTestsWithCustomCommandOption'customMatlabCommand (optional)
Stringmaventargets
Stringname
Stringpom
Stringproperties
# comment name1=value1 name2=value2These are passed to Maven like "-Dname1=value1 -Dname2=value2"
StringjvmOptions
StringusePrivateRepository
booleansettings
settings.xml file contains elements used to define values which configure Maven execution in various ways, like the pom.xml, but should not be bundled to any specific project, or distributed to an audience. These include values such as the local repository location, alternate remote repository servers, and authentication information.
settings.xml file per default may live:
$M2_HOME/conf/settings.xml${user.home}/.m2/settings.xml see also: settings.xml reference
standardfilePathpath
String$class: 'MvnSettingsProvider'settingsConfigId
StringglobalSettings
standard$class: 'FilePathGlobalSettingsProvider'path
String$class: 'MvnGlobalSettingsProvider'settingsConfigId
StringinjectBuildVariables
boolean$class: 'Maven3Builder'mavenName
StringrootPom
Stringgoals
StringmavenOpts
StringuseWrapper
boolean$class: 'MavenDeploymentDownloader'projectName
StringfilePattern
.*)
StringpermaLink
StringtargetDir
StringstripVersion
booleanstripVersionPattern
StringfailIfNoArtifact
booleancleanTargetDir
boolean$class: 'MavenSealightsBuildStep'beginAnalysis
logLevel
OFF, INFO, DEBUG, WARN, ERRORbuildSessionId
StringappName
StringmoduleName
Stringbranch
StringenableMultipleBuildFiles
booleanoverrideJars
booleanmultipleBuildFiles
booleanlabId
StringtestStage
StringpackagesIncluded
StringpackagesExcluded
StringfilesIncluded
StringfilesExcluded
StringclassLoadersExcluded
Stringrecursive
booleanworkspacepath
StringbuildScannerJar
StringtestListenerJar
StringtestListenerConfigFile
StringautoRestoreBuildFile
booleansealightsMavenPluginInstallationArguments
StringbuildFilesPatterns
StringbuildFilesFolders
StringlogEnabled
booleanlogDestination
CONSOLE, FILElogFolder
StringbuildStrategy
ONE_BUILD, BUILD_EACH_MODULEslMvnPluginVersion
StringbuildName
$class: 'DefaultBuildName'$class: 'EmptyBuildName'$class: 'LatestBuildName'$class: 'ManualBuildName'insertedBuildName
String$class: 'UpstreamBuildName'upstreamProjectName
StringexecutionType
FULL, TESTS_ONLY, ONLY_LISTENERoverride_customerId
Stringoverride_url
Stringoverride_proxy
StringadditionalArguments
| Argument name | Description |
|---|---|
| token | The token provided to you by SeaLights (override the global 'token' value for this build). |
| tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
| buildsessionidfile | Set build session id file for this build. |
| createbuildsessionid | When set to 'true' - forces SeaLights Maven Plugin to create new build session id (true by default). |
| proxy | A valid URL to a proxy server. |
| agentpath | Override the path to SeaLights jar. |
| javapath | Override the path to the 'java' variable (default is 'java'). |
| filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
| sealightsJvmParams | Key value pairs of environments variables which will be added to both buildscanner and test listener ('$$$'- separated pairs, ':'- separated key and value. i.e: sealightsJvmParams=param:value$$$anotherparam:anothervalue) |
| buildScannerParams | Key value pairs of environments variables which will be added to buildscanner ('$$$'- separated pairs, ':'- separated key and value. i.e: buildScannerParams=param:value$$$anotherparam:anothervalue) |
| testListenerJvmParams | Key value pairs of environments variables which will be added to test listener ('$$$'- separated pairs, ':'- separated key and value i.e: testListenerJvmParams=param:value$$$anotherparam:anothervalue) |
StringincludeResources
booleanbuildStepMode
$class: 'DisableSealightsView'targets
String$class: 'InvokeMavenCommandView'targets
String$class: 'OffView'$class: 'PrepareSealightsView'additionalMavenArguments
Stringname
Stringpom
Stringproperties
# comment name1=value1 name2=value2These are passed to Maven like "-Dname1=value1 -Dname2=value2"
StringjvmOptions
StringusePrivateRepository
booleansettings
settings.xml file contains elements used to define values which configure Maven execution in various ways, like the pom.xml, but should not be bundled to any specific project, or distributed to an audience. These include values such as the local repository location, alternate remote repository servers, and authentication information.
settings.xml file per default may live:
$M2_HOME/conf/settings.xml${user.home}/.m2/settings.xml see also: settings.xml reference
standardfilePathpath
String$class: 'MvnSettingsProvider'settingsConfigId
StringglobalSettings
standard$class: 'FilePathGlobalSettingsProvider'path
String$class: 'MvnGlobalSettingsProvider'settingsConfigId
StringmavenSnapshotCheckcheck (optional)
boolean$class: 'MdtoolSolutionBuilder'installationName
StringsolutionPath
Stringtarget
value
Stringconfiguration
value
Stringproject
value
Stringruntime
value
StringredmineMetricsReportsettings (optional)
url
StringapiKey
Specify Redmine API Key which can be found in Redmine's [My Account] -> API access key
If can't find "API access key", Redmine admin needs to enable a setting. "Administration > Settings > Authentication > Enable REST web service".
StringprojectName
Specify Redmine Project's Identifier which you want to generate report for, use Identifier not Name in the Redmine project setting page.
StringcustomQueryId
intsprintSize
Specify the time span(day). e.g.: if you want to generate report on a weekly basis you should specify 7.
int$class: 'MicroDocsChecker'microDocsReportFile
StringmicroDocsProjectName
StringmicroDocsGroupName
StringmicroDocsEnvironments
StringmicroDocsSourceFolder
StringmicroDocsFailBuild
booleanmicroDocsPublish
booleanmicroDocsNotifyPullRequest
booleanminiobucket
Stringincludes
StringcredentialsId (optional)
Stringexcludes (optional)
Stringhost (optional)
StringtargetFolder (optional)
StringminioDeletebucket
Stringfiles
StringcredentialsId (optional)
StringfailOnNonExisting (optional)
booleanhost (optional)
StringminioDownloadbucket
Stringfile
StringcredentialsId (optional)
Stringexcludes (optional)
StringfailOnNonExisting (optional)
booleanhost (optional)
StringtargetFolder (optional)
String$class: 'MobileStudioTestBuilder'mobileStudioRunnerPath
StringtestPath
StringmsgServer (optional)
StringdeviceId (optional)
StringprojectRoot (optional)
StringtestAsUnit (optional)
boolean$class: 'MockLoadBuilder'mock-artifact-*.txt. There will be a JUnit test report with the file name mock-junit.xml. Approximately 5% of the time, the build will "fail" its tests and thus no artifacts will be generated.
averageDuration
long$class: 'ModelBuilder'pushGuardSettings
minBufferSize
StringhubUrls
String$class: 'MonitorRemoteJobBuilder'hostName
StringjobName
StringtimeBefore
StringuserName
Stringpassword
StringuseSSL
boolean$class: 'MonkeyBuilder'filename
StringpackageId
StringeventCount
intthrottleMs
intseed
Stringcategories
StringextraParameters
StringmoveComponentsnexusInstanceId
Stringdestination
Stringsearch (optional)
java.util.Map<java.lang.String, java.lang.String>tagName (optional)
StringmsbuildmsBuildName
StringmsBuildFile
Give the .proj or .sln file from the module root (SCM root directory or workspace directory) that MSBuild will use to build.
You can use build variables through the syntax ${var}.
StringcmdLineArgs
This is a whitespace separated-list of command-line arguments you can specify. These can be the same as if you were to run MSBuild from the command line.
StringbuildVariablesAsProperties
If set to true, Jenkins build variables will be passed to MSBuild as /p:name=value pairs.
Beware : Sensitive build variables such as passwords will not be added.
booleancontinueOnBuildFailure
If set to true, Job will continue despite MSBuild build failure.
booleanunstableIfWarnings
If set to true and warnings on compilation, the build will be unstable.
booleandoNotUseChcpCommand
boolean$class: 'MsBuildSQRunnerBegin'additionalArguments (optional)
StringmsBuildScannerInstallationName (optional)
StringprojectKey (optional)
StringprojectName (optional)
StringprojectVersion (optional)
StringsonarInstallationName (optional)
String$class: 'MsBuildSQRunnerEnd'$class: 'MsTestBuilder'msTestName
StringtestFiles
Specify the path to your MSTest compiled assemblies.
You can specify multiple test assemblies by separating them with new-line.
You can use either relative path to the workspace or full path. Spaces in the path are allowed.
You can use Ant-style filters. i.e - foo/*, foo/**/bar.dll, foo/*.dll
Command Line Argument: /testcontainer
Stringcategories
Optional field, if you do not enter all test will run. If entered specify the test categories to run. You can use logical operators like:
| Cateogry Filter | Result |
| Priority1 | Any test with category Priority1 |
| Priority1&SpeedTest | Test that have both Priority1 and SpeedTest categories |
| Priority1|SpeedTest | Tests that have either Priority1 or SpeedTest categories |
| Priority1&!SpeedTest | Test that have Priority1 category and also do not have SpeedTest category. |
Command Line Argument: /category
StringresultFile
Specify name of the result file to create. The result file will be delete before each run and will be created relative to the workspace directory.
Command Line Argument: /resultsfile
StringcmdLineArgs
StringcontinueOnFail
Specify if the build should fail if a test fail (unchecked) or continue even if a test failed (checked).
boolean$class: 'MultiJobBuilder'phaseName
StringphaseJobs
jobName
StringjobAlias
StringjobProperties
StringcurrParams
booleanconfigs
$class: 'BooleanParameters'configs
name
Stringvalue
boolean$class: 'CurrentBuildParameters'$class: 'FileBuildParameters'propertiesFile
Stringencoding
StringfailTriggerOnMissing
booleanuseMatrixChild
booleancombinationFilter
StringonlyExactRuns
booleantextParamValueOnNewLine
boolean$class: 'GeneratorCurrentParameters'$class: 'GitRevisionBuildParameters'combineQueuedCommits
boolean$class: 'MatrixSubsetBuildParameters'filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggered job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String$class: 'NodeLabelBuildParameter'name
StringnodeLabel
String$class: 'NodeParameters'$class: 'PredefinedBuildParameters'properties
StringtextParamValueOnNewLine
boolean$class: 'PredefinedGeneratorParameters'properties
String$class: 'SubversionRevisionBuildParameters'includeUpstreamParameters
booleankillPhaseOnJobResultCondition
FAILURE, NEVER, UNSTABLEdisableJob
booleanenableRetryStrategy
booleanparsingRulesPath
StringmaxRetries
intenableCondition
booleanabortAllJob
booleancondition
StringbuildOnlyIfSCMChanges
booleanapplyConditionOnlyIfNoSCMChanges
booleanaggregatedTestResults
booleancontinuationCondition
ALWAYS, SUCCESSFUL, COMPLETED, UNSTABLE, FAILUREexecutionType
PARALLEL, SEQUENTIALLYquietPeriodGroovy
StringmavenForesightprojectId
StringcredentialId
StringthundraAgentVersion (optional)
String$class: 'MystBuilder'mystAction
Stringconfig
StringmystWorkspace
Stringproperties
StringmystInstallationName
String$class: 'NISConnection'viewUrl
Stringaddress
Stringport
intprozent
intnpmcommand
StringworkspaceSubdirectory (optional)
StringapiKeyvalidateDnsUrlConnection
booleanapiUrl (optional)
Stringgroup (optional)
StringbinaryName (optional)
Stringdescription (optional)
StringwaitForResults (optional)
booleanwaitMinutes (optional)
intbreakBuildOnScore (optional)
booleanscoreThreshold (optional)
intapiKey (optional)
StringuseBuildEndpoint (optional)
booleanartifactsDir (optional)
Stringdebug (optional)
booleanpassword (optional)
StringproxyEnabled (optional)
booleanshowStatusMessages (optional)
booleanstopTestsForStatusMessage (optional)
Stringusername (optional)
StringvalidateDnsUrlConnectionEnabled (optional)
boolean$class: 'NSiqBuilder'srcDir
StringfileFilter
String$class: 'NantBuilder'nantBuildFile
StringnantName
Stringtargets
Stringproperties
String$class: 'NeoBuildAction'executable
/opt/NeoLoad 6.5/bin/NeoLoadCmd, C:\Program Files\NeoLoad 6.5\bin\NeoLoadCmd.exe or /Applications/NeoLoad 6.5/bin/NeoLoadCmd.
StringprojectType
StringreportType
StringlocalProjectFile
/home/ajohnson/neoload_projects/JenkinsExample/JenkinsExample.nlp, C:\neoload_projects\JenkinsExample\JenkinsExample.nlp or /Users/ajohnson/neoload_projects/JenkinsExample/JenkinsExample.nlp or C:\neoload_projects\JenkinsExample\JenkinsExample.yaml.
StringsharedProjectName
MyProjectName.
StringscenarioName
StringhtmlReport
${WORKSPACE}/neoload-report/report.html.
StringxmlReport
${WORKSPACE}/neoload-report/report.xml.
StringpdfReport
${WORKSPACE}/neoload-report/report.pdf.
StringjunitReport
${WORKSPACE}/neoload-report/junit-sla-results.xml.
StringscanAllBuilds
booleandisplayTheGUI
booleantestResultName
$Date{hh:mm - dd MMM yyyy} is replaced by the current date by NeoLoad and the value ${BUILD_NUMBER} is replaced by the current build number by Jenkins.
$Date{hh:mm - dd MMM yyyy} (build $${BUILD_NUMBER}).
StringtestDescription
StringlicenseType
StringlicenseVUCount
StringlicenseVUSAPCount
StringlicenseDuration
StringcustomCommandLineOptions
StringpublishTestResults
booleansharedProjectServer
uniqueID
Stringurl
StringloginUser
StringloginPassword
class hudson.util.Secretlabel
StringlicenseServer
uniqueID
Stringurl
StringloginUser
StringloginPassword
class hudson.util.Secretlabel
StringcollabPath
StringlicenseID
StringshowTrendAverageResponse
booleanshowTrendErrorRate
booleangraphOptionsInfo
name
Stringcurve
path
Stringstatistic
StringmaxTrends
int$class: 'NerrvanaPlugin'settingsXmlString
Stringloglevel
String$class: 'NetStormBuilder'URLConnectionString
Stringusername
Stringpassword
Stringproject
StringsubProject
Stringscenario
StringtestMode
StringbaselineType
StringpollInterval
Stringprotocol
StringrepoIp
StringrepoPort
StringrepoPath
StringrepoUsername
StringrepoPassword
Stringprofile
Stringscript
Stringpage
StringadvanceSett
StringurlHeader
StringhiddenBox
StringgitPull
StringgenerateReport
booleandoNotWaitForTestCompletion
booleantotalusers
StringrampUpSec
Stringrampupmin
Stringrampuphour
Stringduration
Stringserverhost
Stringsla
StringtestName
StringscriptPath
StringrampupDuration
Stringemailid
StringemailidCC
StringemailidBcc
Stringtestsuite
StringdataDir
StringcheckRuleFileUpload
Stringneuvectorrepository
StringregistrySelection
StringnameOfVulnerabilityToExemptFour (optional)
StringnameOfVulnerabilityToExemptOne (optional)
StringnameOfVulnerabilityToExemptThree (optional)
StringnameOfVulnerabilityToExemptTwo (optional)
StringnameOfVulnerabilityToFailFour (optional)
StringnameOfVulnerabilityToFailOne (optional)
StringnameOfVulnerabilityToFailThree (optional)
StringnameOfVulnerabilityToFailTwo (optional)
StringnumberOfHighSeverityToFail (optional)
StringnumberOfMediumSeverityToFail (optional)
StringscanLayers (optional)
booleanstandaloneScanner (optional)
booleantag (optional)
String$class: 'NexusArtifactUploader'nexusVersion
Stringprotocol
StringnexusUrl
StringgroupId
Stringversion
Stringrepository
StringcredentialsId
Stringartifacts
artifactId
Stringtype
Stringclassifier
Stringfile
String$class: 'NexusPublisherBuildStep'nexusInstanceId
StringnexusRepositoryId
Stringpackages
$class: 'MavenPackage'mavenCoordinate
groupId
StringartifactId
Stringversion
Stringpackaging
StringmavenAssetList
filePath
Stringclassifier
Stringextension
StringtagName (optional)
Stringnirmatabuilder
Delete App in Environment
Deletes the specified application from the specified environment.
Deploy App in Environment
Deploys the specified application from catalog to specified application.
Update App in Catalog
Updates the specified application in specified catalog.
Update App in Environment
Updates the specified application in specified environment.
deleteAppInEnvironmentendpoint
Stringapikey
Stringenvironment
Stringapplication
Stringtimeout
intdeployAppInEnvironmentendpoint
Stringapikey
Stringenvironment
Stringapplication
Stringtimeout
intcatalog
Stringdirectories
Stringincludescheck
booleanincludes
Stringexcludescheck
booleanexcludes
StringdeployType
StringupdateAppInCatalogendpoint
Stringapikey
Stringcatalog
Stringtimeout
intdirectories
Stringincludescheck
booleanincludes
Stringexcludescheck
booleanexcludes
StringupdateAppInEnvironmentendpoint
Stringapikey
Stringenvironment
Stringapplication
Stringtimeout
intdirectories
Stringincludescheck
booleanincludes
Stringexcludescheck
booleanexcludes
Stringnodejscicommand
StringnodeJSInstallationName
StringcacheLocationStrategy (optional)
defaultexecutorworkspaceconfigId (optional)
String$class: 'NopmdCheckPublisher'filesetList
pattern
StringexcludePattern
String$class: 'NotifyEventsBuilder'token
Stringtitle
Stringmessage
Stringpriority
Stringlevel
StringattachBuildLog
booleanattachment
String$class: 'NouvolaBuilder'planID
StringapiKey
StringcredsPass
StringwaitTime
StringreturnURL
StringlistenTimeOut
String$class: 'NucleiBuilder'targetUrl
StringadditionalFlags (optional)
nuclei --help
or visit:StringnucleiVersion (optional)
StringreportingConfiguration (optional)
String$class: 'NvEmulationBuilder'serverName
StringincludeClientIPs
StringexcludeServerIPs
StringreportFiles
StringthresholdsFile
StringuseProxyCheckbox
envVariable
Stringsteps
hudson.tasks.BuildStep)profileNames (optional)
profileName
String$class: 'OOBuildStep'ooServer
Stringbasepath
Default path: /Library
E.g.:
Library/Tutorials/subflows/
Library/Templates
StringselectedFlow
Stringargs
name
Stringvalue
StringretVariableToCheck
StringcomparisonOrdinal
intvalueToCompareWith
StringdesiredResultType
StringstepExecutionTimeout
xxx ms. The plugin will wait for this amount of time, then it will finish the Jenkins job and it will automatically put the build in the fail/unstable state.
StringrunName
StringostorlabScanwaitForResults
booleanriskThreshold
HIGH, MEDIUM, LOW, POTENTIALLY, HARDENINGfilePath (optional)
Stringtitle (optional)
Stringplan (optional)
Stringplatform (optional)
StringwaitMinutes (optional)
intbreakBuildOnScore (optional)
booleanscoreThreshold (optional)
HIGH, MEDIUM, LOW, POTENTIALLY, HARDENINGwaitingForResults (optional)
boolean$class: 'Oak9Builder'orgId (optional)
StringprojectId (optional)
StringcredentialsId (optional)
StringmaxSeverity (optional)
intbaseUrl (optional)
String$class: 'OctoperfBuilder'credentialsId (optional)
StringworkspaceId (optional)
StringprojectId (optional)
StringscenarioId (optional)
StringstopConditions (optional)
? extends org.jenkinsci.plugins.octoperf.conditions.TestStopConditionoctopusPacktoolId
StringpackageId
StringpackageFormat
StringsourcePath
StringadditionalArgs (optional)
StringincludePaths (optional)
StringoutputPath (optional)
StringoverwriteExisting (optional)
booleanpackageVersion (optional)
StringverboseLogging (optional)
booleanoctopusPushBuildInformationserverId
StringspaceId
StringtoolId
StringpackageId
StringpackageVersion
StringcommentParser
StringoverwriteMode
FailIfExists, OverwriteExisting, IgnoreIfExistsadditionalArgs (optional)
StringgitBranch (optional)
StringgitCommit (optional)
StringgitUrl (optional)
StringverboseLogging (optional)
booleanoctopusPushPackageserverId
StringtoolId
StringpackagePaths
StringoverwriteMode
FailIfExists, OverwriteExisting, IgnoreIfExistsadditionalArgs (optional)
StringspaceId (optional)
StringverboseLogging (optional)
booleanOneSkyprojectId (optional)
StringresourcesPath (optional)
String$class: 'OntrackDSLStep'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
booleanignoreFailure
boolean$class: 'OpenShiftBuildVerifier'apiURL
StringbldCfg
Stringnamespace
StringauthToken
Stringverbose
StringcheckForTriggeredDeployments
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftBuilder'apiURL
StringbldCfg
Stringnamespace
Stringenv
name
Stringvalue
StringauthToken
Stringverbose
StringcommitID
StringbuildName
StringshowBuildLogs
StringcheckForTriggeredDeployments
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftCreator'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringjsonyaml
String$class: 'OpenShiftDeleterJsonYaml'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringjsonyaml
String$class: 'OpenShiftDeleterLabels'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringtypes
Stringkeys
Stringvalues
String$class: 'OpenShiftDeleterList'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringtypes
Stringkeys
String$class: 'OpenShiftDeployer'apiURL
StringdepCfg
Stringnamespace
StringauthToken
Stringverbose
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftDeploymentVerifier'apiURL
StringdepCfg
Stringnamespace
StringreplicaCount
StringauthToken
Stringverbose
StringverifyReplicaCount
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftExec'apiURL
Stringnamespace
StringauthToken
Stringverbose
Stringpod
Stringcontainer
Stringcommand
Stringarguments
value
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftImageTagger'apiURL
StringtestTag
StringprodTag
Stringnamespace
StringauthToken
Stringverbose
StringtestStream
StringprodStream
StringdestinationNamespace
StringdestinationAuthToken
Stringalias
String$class: 'OpenShiftScaler'apiURL
StringdepCfg
Stringnamespace
StringreplicaCount
StringauthToken
Stringverbose
StringverifyReplicaCount
StringwaitTime
StringwaitUnit
String$class: 'OpenShiftServiceVerifier'apiURL
StringsvcName
Stringnamespace
StringauthToken
Stringverbose
String$class: 'OrchestratorBuilder'serverUrl
StringuserName
Stringpassword
Stringtenant
StringworkflowName
StringwaitExec
booleaninputParams
name
Stringtype
Stringvalue
StringcfyOutputsToInputsThis step maps outputs and capabilities, of an environment created by Cloudify, into inputs of another deployment.
This step takes two inputs:
The format of the mapping JSON is as follows:
{
"outputs": {
"<output_name>": "<input_name>",
"<output_name>": "<input_name>",
...
},
"capabilities": {
"<capability_name>": "<input_name>",
"<capability_name>": "<input_name>",
...
}
}
At the end, a file will be generated, containing a JSON compatible with Cloudify's standard "Deployment Inputs" structure, namely:
{
"<input_name>": "<intput_value>",
"<input_name>": "<intput_value>",
...
For example, if the "outputs file" is as follows:
{
"outputs": {
"endpoint": "10.0.0.130",
"username": "centos"
},
"capabilities": {
"public_key": "/tmp/public_key"
}
}
And the mapping is as follows:
{
"outputs": {
"username": "app_username"
},
"capabilities": {
"public_key": "app_data"
}
}
Then the resultant inputs file will be as follows:
{
"app_username": "centos",
"app_data": "/tmp/public_key"
}
credentialsId (optional)
StringinputsLocation (optional)
Path to the inputs file to be created.
Stringmapping (optional)
A JSON containing mapping between outputs/capabilities and inputs. For information about the structure, refer to the tooltip of this build step.
StringmappingLocation (optional)
A JSON containing mapping between outputs/capabilities and inputs. For information about the structure, refer to the tooltip of this build step.
StringoutputsLocation (optional)
Location of the outputs JSON file, containing outputs and capabilities of another deployment. The file must be in the following format:
{
"outputs": {
"<output_name>": "<output_value>",
"<output_name>": "<output_value>",
...
},
"capabilities": {
"<capability_name>": "<capability_value>",
"<capability_name>": "<capability_value>",
...
}
}
Stringtenant (optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
StringoversecuredUploadapkPath
StringintegrationId
StringdotnetPackdotnet pack command builds the project and creates NuGet packages. The result of this command is a NuGet package (that is, a .nupkg file).
configuration (optional)
Debug, but you can override the build configuration settings in your project.
Stringforce (optional)
booleanincludeSource (optional)
src folder within the symbols package.
booleanincludeSymbols (optional)
booleannoBuild (optional)
booleannoDependencies (optional)
booleannoRestore (optional)
booleannologo (optional)
booleanoption (optional)
Stringoptions (optional)
StringoptionsString (optional)
StringoutputDirectory (optional)
Stringproject (optional)
Stringproperties (optional)
java.util.Map<java.lang.String, java.lang.String>propertiesString (optional)
Stringruntime (optional)
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleanshutDownBuildServers (optional)
dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
hanguntil those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
booleanspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleanunstableIfWarnings (optional)
booleanverbosity (optional)
StringversionSuffix (optional)
$(VersionSuffix) MSBuild property in the project.
StringworkDirectory (optional)
StringuTesterPageCountTaskinitialUrl
StringurlsWhiteList
StringpageCount
intrulesList
rule
StringcomplianceMinimum
floatallowSimultaneousLogins
booleanloginFlowJson
StringuseRunner
booleanfetchResponseTimeout
int$class: 'ParallelTestExecutor'This builder can be used with any test job that (1) produce JUnit-compatible XML files, and (2) accept a test-exclusion list in a file. This builder looks at the test execution time from the last time, and divide tests into multiple units of roughly equal size. Each unit is then converted into the exclusion list (by excluding all but the tests that assigned to that unit), and the test job is triggered for each unit, with the exclusion file placed inside the workspace at your specified location.
Optionally, if your test job supports it, you may provide a test-inclusion file name. If defined, the plugin will generate inclusion lists for all parallel units but one which will still use exclusion list. This avoids new test cases from being included in all units on their first run. If you don't use an inclusion file, when a new test is added, the first build afterward will be executed in all the sub-builds, because it's not in the exclusion list on any of the units.
You are responsible for configuring the build script in the test job to honor the exclusion and inclusion file. A standard technique is to write the build script to always refer to a fixed exclusion list file, and check in an empty file by that name to your SCM. You can then specify that file as the "exclusion file name" in the configuration of this builder, and the builder will overwrite the empty file from SCM by the generated one.
Similarly, you are responsible for checking "Execute concurrent builds if necessary" on the test job to allow the concurrent execution.
At the end of the executions of the test job, the specified report directories are brought back into this job's workspace, then the standard JUnit test report collector will tally them.
parallelism
countsize
inttimeThis value counts just the time spent on executing tests, and not including other time such as checking out the code, building the test, etc. For example, if your test job spends 50 minutes in tests and 60 minutes total from start to finish, then you have 10 minutes "fixed" overhead regardless of the number of tests it executes. If you use this mode and set the value to "10 minutes", then you'll have 5 parallel sub-tasks that all ends in roughly 20 minutes (20 mins = 10 mins tests time + 10 mins overhead.)
"N minutes per a sub-task" is a goal, not a hard constraint. So a sub-task can take longer (for example if you have a single test that takes more than N minutes.)
mins
inttestJob
StringpatternFile
StringtestReportFiles
The path is relative to the workspace of the test job. For Maven builds, this value is normally "**/target/surefire-reports/".
StringarchiveTestResults
booleanparameters
$class: 'BooleanParameters'configs
name
Stringvalue
boolean$class: 'CurrentBuildParameters'$class: 'FileBuildParameters'propertiesFile
Stringencoding
StringfailTriggerOnMissing
booleanuseMatrixChild
booleancombinationFilter
StringonlyExactRuns
booleantextParamValueOnNewLine
boolean$class: 'GeneratorCurrentParameters'$class: 'GitRevisionBuildParameters'combineQueuedCommits
boolean$class: 'MatrixSubsetBuildParameters'filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggered job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String$class: 'NodeLabelBuildParameter'name
StringnodeLabel
String$class: 'NodeParameters'$class: 'PredefinedBuildParameters'properties
StringtextParamValueOnNewLine
boolean$class: 'PredefinedGeneratorParameters'properties
String$class: 'SubversionRevisionBuildParameters'includeUpstreamParameters
booleanestimateTestsFromFiles
booleanincludesPatternFile (optional)
String$class: 'ParameterPoolBuilder'projects
Stringname
Stringvalues
StringpreferError
boolean$class: 'PartialReleaseMgrSuccessfulBuilder'pcBuildserverAndPort
StringpcServerName
StringcredentialsId
StringalmDomain
StringalmProject
StringtestId
StringtestInstanceId
StringautoTestInstanceID
StringtimeslotDurationHours
StringtimeslotDurationMinutes
StringpostRunAction
COLLATE, COLLATE_AND_ANALYZE, DO_NOTHINGvudsMode
booleanstatusBySLA
booleandescription
StringaddRunToTrendReport
StringtrendReportId
StringHTTPSProtocol
booleanproxyOutURL
StringcredentialsProxyId
Stringretry
StringretryDelay
StringretryOccurrences
StringauthenticateWithToken
booleanpcGitBuilddescription
StringpcServerName
StringhttpsProtocol
booleancredentialsId
StringalmDomain
StringalmProject
StringserverAndPort
StringproxyOutURL
StringcredentialsProxyId
StringsubjectTestPlan
StringuploadScriptMode
RUNTIME_FILES, ALL_FILESremoveScriptFromPC
YES, NOimportTests
Note:
| Parameter | Description | Required |
|---|---|---|
| controller |
Defines the Controller to be used during the test run (it must be an available host in the LoadRunner Enterprise project). If not specified, a Controller will be chosen from the different controllers available in the LoadRunner Enterprise project.
From Performance Center 12.62 and plugin version 1.1.1, the option to provision a Controller as a Docker image is available by specifying the value "Elastic" and providing a value for the 'controller_elastic_configuration' parameter (see 'controller_elastic_configuration' table below).
|
No |
| lg_amount | Number of load generators to allocate to the test (every group in the test will be run by the same load generators). | Not required if each group defined in the 'group' parameter defines the load generators it will be using via the 'lg_name' parameter (see 'group' table below). |
| group | Lists all groups or scripts defined in the test. The parameter to be used in each group are specified in the 'group' table below. | Yes |
| scheduler | Defines the duration of a test, and determines whether virtual users are started simultaneously or gradually. See the 'scheduler' table below. | No |
| lg_elastic_configuration | Defines the image to be used in order to provision load generators. See the 'lg_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if a load generator is defined to be provisioned from a Docker image. |
| controller_elastic_configuration | Defines the image to be used in order to provision the Controller. See the 'controller_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if the Controller is defined to be provisioned from a Docker image. |
| Parameter | Description | Required |
|---|---|---|
| group_name | Name of the group (it must be a unique name if several groups are defined). | Yes |
| vusers | Number of virtual users to allocate to the group for running the script. | Yes |
| script_id | ID of the script in the LoadRunner Enterprise project. | Not required if the 'script_path' parameter is specified. |
| script_path | Path and name of the script to be added to the group, separated by double backslashes (\\). For example "MyMainFolder\\MySubFolder\\MyScriptName'. Do not include the LoadRunner Enterprise root folder (named "Subject"). | Not required if 'script_id' parameter is specified |
| lg_name | List of load generators to allocate to the group for running the script. The supported values are:
|
No |
| command_line | The command line applied to the group. | No |
| rts | Object defining the runtime settings of the script. See the 'rts' table below. | No |
| Parameter | Description | Required |
|---|---|---|
| pacing | Can be used to define the number of iterations the script will run and the required delay between iterations (see the 'pacing' table below). | No |
| thinktime | Can be used to define think time (see the 'thinktime' table below). | No |
| java_vm | Can be used when defining Java environment runtime settings (see the 'java_vm' table below). | No |
| jmeter | Can be used to define JMeter environment runtime settings (see the 'jmeter' table below). | No |
| Parameter | Description | Required |
|---|---|---|
| number_of_iterations | Specifies the number of iterations to run; this must be a positive number. | Yes |
| type | Possible values for type attribute are:
|
No |
| delay | Non-negative number (less than 'delay_at_range_to_seconds' when specified). | Depends on the value provided for the 'type' parameter. |
| delay_random_range | Non-negative number. It will be added to the value given to the 'delay' parameter (the value will be randomly chosen between the value given to 'delay' parameter and the same value to which is added the value of this parameter). | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| type | The ThinkTime Type attribute is one of:
|
No |
| min_percentage | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| max_percentage | This must be a positive number (it must be larger than the value provided for the 'min_percentage' parameter). | Depends on the value provided for the 'type' parameter. |
| limit_seconds | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| multiply_factor | The recorded think time is multiplied by this factor at runtime. | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| jdk_home | The JDK installation path. | No |
| java_vm_parameters | List the Java command line parameters. These parameters can be any JVM argument. The common arguments are the debug flag (-verbose) or memory settings (-ms, -mx). In additional, you can also pass properties to Java applications in the form of a -D flag. | No |
| use_xboot | Boolean: Instructs VuGen to add the Classpath before the Xbootclasspath (prepend the string). | No |
| enable_classloader_per_vuser | Boolean: Loads each Virtual User using a dedicated class loader (runs Vusers as threads). | No |
| java_env_class_paths | A list of classpath entries. Use a double backslash (\\) for folder separators. | No |
| Parameter | Description | Required |
|---|---|---|
| start_measurements | Boolean value to enable JMX measurements during performance test execution. | No |
| jmeter_home_path | Path to JMeter home. If not defined, the path from the %JMETER_HOME% environment variable is used. | No |
| jmeter_min_port | This number must be lower than the value provided in the 'jmeter_max_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_max_port | This number must be higher than the value provided in the 'jmeter_min_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_additional_properties | JMeter additional properties file. Use double slash (\\) for folder separator. | No |
| Parameter | Description | Required |
|---|---|---|
| rampup | Time, in seconds, to gradually start all virtual users. Additional virtual users are added every 15 seconds until the time specified in the parameter ends. If no value is specified, all virtual users are started simultaneously at the beginning of the test. | No |
| duration | Time, in seconds, that it will take to run the test after all virtual users are started. After this time, the test run ends. If not specified, the test will run until completion. | No |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if one of the load generator is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if the Controller is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
##################################################
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
Duration: '300'
##################################################
##################################################
controller: "mycontroller"
lg_amount: 3
group:
- group_name: "JavaVuser_LR_Information_pacing_immediately_thinktime_ignore"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "immediately"
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
use_xboot: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "ignore"
- group_name: "JavaHTTP_BigXML_pacing_fixed_delay_thinktime_replay"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed delay"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
thinktime:
type: "replay"
limit_seconds: 30
- group_name: "JavaVuser_LR_Information_immediately_pacing_random_delay_thinktime_modify"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "random delay"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "modify"
limit_seconds: 30
multiply_factor: 2
- group_name: "JavaHTTP_BigXML_pacing_fixed_interval_thinktime_random"
vusers: 50
#script_id: 392
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed interval"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "random"
limit_seconds: 30
min_percentage: 2
max_percentage: 3
- group_name: "JavaHTTP_BigXML_pacing_random_interval"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
- group_name: "Mtours_pacing_random_interval"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
jmeter_home_path: "c:\\jmeter"
jmeter_min_port: 2001
jmeter_max_port: 3001
jmeter_additional_properties: "jmeter_additional_properties"
- group_name: "Mtours_pacing_random_interval_Jmeter_default_port"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
scheduler:
rampup: 120
duration: 600
##################################################
YES, NOauthenticateWithToken
booleanpcRunBuildserverAndPort
StringpcServerName
StringcredentialsId
StringalmDomain
StringalmProject
StringtestToRun
StringtestId
StringtestContentToCreate
The content of the field must either be:
Note:
| Parameter | Description | Required |
|---|---|---|
| test_name | The test name. | Yes |
| test_folder_path | The location of the test in the Test Management folder tree of the LoadRunner Enterprise project. The folders should be separated by double backslashes (\\). For example, "MyMainFolder\\MySubfolder\\MySubSubFolder". Do not include the LoadRunner Enterprise root folder (named "Subject") | Yes |
| test_content | The content of the test that requires additional parameters specified in the 'test_content' table below. | Yes |
| Parameter | Description | Required |
|---|---|---|
| controller |
Defines the Controller to be used during the test run (it must be an available host in the LoadRunner Enterprise project). If not specified, a Controller will be chosen from the different controllers available in the LoadRunner Enterprise project.
From Performance Center 12.62 and plugin version 1.1.1, the option to provision a Controller as a Docker image is available by specifying the value "Elastic" and providing a value for the 'controller_elastic_configuration' parameter (see 'controller_elastic_configuration' table below).
|
No |
| lg_amount | Number of load generators to allocate to the test (every group in the test will be run by the same load generators). | Not required if each group defined in the 'group' parameter defines the load generators it will be using via the 'lg_name' parameter (see 'group' table below). |
| group | Lists all groups or scripts defined in the test. The parameter to be used in each group are specified in the 'group' table below. | Yes |
| scheduler | Defines the duration of a test, and determines whether virtual users are started simultaneously or gradually. See the 'scheduler' table below. | No |
| lg_elastic_configuration | Defines the image to be used in order to provision load generators. See the 'lg_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if a load generator is defined to be provisioned from a Docker image. |
| controller_elastic_configuration | Defines the image to be used in order to provision the Controller. See the 'controller_elastic_configuration' table below. Available from Performance Center 12.62 and plugin version 1.1.1. | Yes, if the Controller is defined to be provisioned from a Docker image. |
| Parameter | Description | Required |
|---|---|---|
| group_name | Name of the group (it must be a unique name if several groups are defined). | Yes |
| vusers | Number of virtual users to allocate to the group for running the script. | Yes |
| script_id | ID of the script in the LoadRunner Enterprise project. | Not required if the 'script_path' parameter is specified. |
| script_path | Path and name of the script to be added to the group, separated by double backslashes (\\). For example "MyMainFolder\\MySubFolder\\MyScriptName'. Do not include the LoadRunner Enterprise root folder (named "Subject"). | Not required if 'script_id' parameter is specified |
| lg_name | List of load generators to allocate to the group for running the script. The supported values are:
|
No |
| command_line | The command line applied to the group. | No |
| rts | Object defining the runtime settings of the script. See the 'rts' table below. | No |
| Parameter | Description | Required |
|---|---|---|
| pacing | Can be used to define the number of iterations the script will run and the required delay between iterations (see the 'pacing' table below). | No |
| thinktime | Can be used to define think time (see the 'thinktime' table below). | No |
| java_vm | Can be used when defining Java environment runtime settings (see the 'java_vm' table below). | No |
| jmeter | Can be used to define JMeter environment runtime settings (see the 'jmeter' table below). | No |
| Parameter | Description | Required |
|---|---|---|
| number_of_iterations | Specifies the number of iterations to run; this must be a positive number. | Yes |
| type | Possible values for type attribute are:
|
No |
| delay | Non-negative number (less than 'delay_at_range_to_seconds' when specified). | Depends on the value provided for the 'type' parameter. |
| delay_random_range | Non-negative number. It will be added to the value given to the 'delay' parameter (the value will be randomly chosen between the value given to 'delay' parameter and the same value to which is added the value of this parameter). | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| type | The ThinkTime Type attribute is one of:
|
No |
| min_percentage | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| max_percentage | This must be a positive number (it must be larger than the value provided for the 'min_percentage' parameter). | Depends on the value provided for the 'type' parameter. |
| limit_seconds | This must be a positive number. | Depends on the value provided for the 'type' parameter. |
| multiply_factor | The recorded think time is multiplied by this factor at runtime. | Depends on the value provided for the 'type' parameter. |
| Parameter | Description | Required |
|---|---|---|
| jdk_home | The JDK installation path. | No |
| java_vm_parameters | List the Java command line parameters. These parameters can be any JVM argument. The common arguments are the debug flag (-verbose) or memory settings (-ms, -mx). In additional, you can also pass properties to Java applications in the form of a -D flag. | No |
| use_xboot | Boolean: Instructs VuGen to add the Classpath before the Xbootclasspath (prepend the string). | No |
| enable_classloader_per_vuser | Boolean: Loads each Virtual User using a dedicated class loader (runs Vusers as threads). | No |
| java_env_class_paths | A list of classpath entries. Use a double backslash (\\) for folder separators. | No |
| Parameter | Description | Required |
|---|---|---|
| start_measurements | Boolean value to enable JMX measurements during performance test execution. | No |
| jmeter_home_path | Path to JMeter home. If not defined, the path from the %JMETER_HOME% environment variable is used. | No |
| jmeter_min_port | This number must be lower than the value provided in the 'jmeter_max_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_max_port | This number must be higher than the value provided in the 'jmeter_min_port' parameter. Both 'jmeter_min_port' and 'jmeter_max_port' parameters must be specified otherwise the default port values is used. | No |
| jmeter_additional_properties | JMeter additional properties file. Use double slash (\\) for folder separator. | No |
| Parameter | Description | Required |
|---|---|---|
| rampup | Time, in seconds, to gradually start all virtual users. Additional virtual users are added every 15 seconds until the time specified in the parameter ends. If no value is specified, all virtual users are started simultaneously at the beginning of the test. | No |
| duration | Time, in seconds, that it will take to run the test after all virtual users are started. After this time, the test run ends. If not specified, the test will run until completion. | No |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if one of the load generator is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> Press Assign LG button -> in the Elastic section, select DOCKER1 -> select the relevant image (based on the image name) -> use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| Parameter | Description | Required |
|---|---|---|
| image_id | This number can be retrieved from:
|
Yes if the Controller is defined to be provisioned from Docker image. |
| memory_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'Memory(GB)' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
| cpu_limit | This parameter can be retrieved from LoadRunner Enterprise Application -> Test Management -> edit a test -> select the Controller -> choose Elastic option -> select the relevant image -> Under the Resource Limits label, find and use the values provided in the 'CUPs' dropdown list (if not specified, this parameter should be ignored). | Yes, if the image is defined with resource limits |
##################################################
test_name: mytestname
test_folder_path: "Tests\\mytests"
test_content:
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
duration: '300'
##################################################
##################################################
group:
- group_name: "TEstInt"
vusers: '20'
script_path: "plugin\\TEstInt"
lg_name:
- "LG1"
- "LG2"
- group_name: "Mtours"
vusers: '20'
script_path: "plugin\\mtours"
lg_name:
- "LG3"
- "LG4"
scheduler:
rampup: '45'
duration: '300'
##################################################
##################################################
controller: "mycontroller"
lg_amount: 3
group:
- group_name: "JavaVuser_LR_Information_pacing_immediately_thinktime_ignore"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "immediately"
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
use_xboot: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "ignore"
- group_name: "JavaHTTP_BigXML_pacing_fixed_delay_thinktime_replay"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed delay"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
thinktime:
type: "replay"
limit_seconds: 30
- group_name: "JavaVuser_LR_Information_immediately_pacing_random_delay_thinktime_modify"
vusers: 50
script_id: 394
rts:
pacing:
number_of_iterations: 2
type: "random delay"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "modify"
limit_seconds: 30
multiply_factor: 2
- group_name: "JavaHTTP_BigXML_pacing_fixed_interval_thinktime_random"
vusers: 50
#script_id: 392
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "fixed interval"
delay: 10
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
thinktime:
type: "random"
limit_seconds: 30
min_percentage: 2
max_percentage: 3
- group_name: "JavaHTTP_BigXML_pacing_random_interval"
vusers: 50
script_path: "scripts\\java_protocols\\JavaHTTP_BigXML"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
java_vm:
jdk_home: "C:\\Program Files\\Java\\jdk1.8.0_191"
java_vm_parameters: "java_vm_parameters"
enable_classloader_per_vuser: true
java_env_class_paths:
- "java_env_class_path1"
- "java_env_class_path2"
- group_name: "Mtours_pacing_random_interval"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
jmeter_home_path: "c:\\jmeter"
jmeter_min_port: 2001
jmeter_max_port: 3001
jmeter_additional_properties: "jmeter_additional_properties"
- group_name: "Mtours_pacing_random_interval_Jmeter_default_port"
vusers: 50
script_path: "scripts\\Mtours"
rts:
pacing:
number_of_iterations: 2
type: "random interval"
delay: 10
delay_random_range: 20
jmeter:
start_measurements: true
scheduler:
rampup: 120
duration: 600
##################################################
StringtestInstanceId
StringautoTestInstanceID
StringtimeslotDurationHours
StringtimeslotDurationMinutes
StringpostRunAction
COLLATE, COLLATE_AND_ANALYZE, DO_NOTHINGvudsMode
booleanstatusBySLA
booleandescription
StringaddRunToTrendReport
StringtrendReportId
StringHTTPSProtocol
booleanproxyOutURL
StringcredentialsProxyId
Stringretry
StringretryDelay
StringretryOccurrences
StringauthenticateWithToken
booleanactivateDTConfigurationdynatraceProfile
Stringconfiguration
StringcreateMemoryDumpdynatraceProfile
Stringagent
Stringhost
StringautoPostProcess (optional)
booleancapturePrimitives (optional)
booleancaptureStrings (optional)
booleandogc (optional)
booleanlockSession (optional)
booleantype (optional)
StringstartSessiondynatraceProfile
StringtestCase
StringlockSession (optional)
booleanrecordingOption (optional)
StringstopSessiondynatraceProfile
StringcreateThreadDumpdynatraceProfile
Stringagent
Stringhost
StringlockSession (optional)
boolean$class: 'PerformanceAnalysisBuilder'testjob
Specify the data set name that contains the mainframe job that you want to run the performance benchmarking for, for example, TEST.POC.JCLLIB(TESTJOB).
The maximum length is 44 characters.
Ensure that the job is included in the monitoring scope of the CA MAT Performance Benchmarking plugin by Broadcom.
StringblazeMeterTestcredentialsId (optional)
StringworkspaceId (optional)
StringtestId (optional)
StringabortJob (optional)
booleanadditionalTestFiles (optional)
StringgetJtl (optional)
booleangetJunit (optional)
booleanjobApiKey (optional)
StringjtlPath (optional)
StringjunitPath (optional)
StringmainTestFile (optional)
Stringnotes (optional)
StringreportLinkName (optional)
StringserverUrl (optional)
StringsessionProperties (optional)
Stringbztparams
StringalwaysUseVirtualenv (optional)
booleanbztVersion (optional)
StringgeneratePerformanceTrend (optional)
booleanprintDebugOutput (optional)
booleanuseBztExitCode (optional)
booleanuseSystemSitePackages (optional)
booleanvirtualEnvCommand (optional)
StringworkingDirectory (optional)
Stringworkspace (optional)
String$class: 'PhingBuilder'name
StringbuildFile
If your build requires a custom -buildfile, specify it here. By default Phing will use the build.xml in the module directory, this option can be used to use build files with a different name or in somewhere outside the top directory.
And you can use environment variables such like ''$WORKSPACE''.
Stringtargets
Stringproperties
# comment name1=value1 name2=value2These are passed to Phing like "-Dname1=value1 -Dname2=value2"
StringuseModuleRoot
booleanoptions
String$class: 'PipelineGenerationStep'project
Name of the project. It is used as an identifier in the corresponding pipelines, folders and jobs being generated.
StringprojectScmType
Type of the SCM. Currently only svn and git are supported.
StringprojectScmUrl
URL to the project SCM. Without any branch indication.
For example:
svn, URL to the root of the project, without trunk or branches. git, URL of the remote.StringprojectScmCredentials
ID or UUID of the Jenkins credentials to use when connecting to the project SCM.
Stringbranch
SCM branch.
StringseedProject
Project name useable for folders, job names, etc.
StringseedBranch
Branch name useable for folders, job names, etc.
StringdisableDslScript
If checked, the pipeline generation disallows the direct execution of a DSL Groovy script. Only DSL libraries, configured through a seed.properties file are allowed. By default, both modes are allowed.
booleanscriptDirectory
Path to the directory which contains the pipeline script. Defaults to seed if not filled.
Stringplotgroup
Stringstyle
StringcsvFileName
StringcsvSeries (optional)
file
Stringurl
StringinclusionFlag
StringexclusionValues
StringdisplayTableFlag
booleandescription (optional)
StringexclZero (optional)
booleankeepRecords (optional)
booleanlogarithmic (optional)
booleannumBuilds (optional)
StringpropertiesSeries (optional)
file
Stringlabel
Stringtitle (optional)
StringuseDescr (optional)
booleanxmlSeries (optional)
file
Stringxpath
StringnodeType
Stringurl
Stringyaxis (optional)
StringyaxisMaximum (optional)
StringyaxisMinimum (optional)
String$class: 'PolarisBuildStep'createChangeSetFile (optional)
Creates a file at $CHANGE_SET_FILE_PATH (by default, the workspace directory) containing a list of files generated from the Jenkins-provided scm changeset.
Used for Incremental analysis (--incremental) as the file containing the list of changed files for analysis.
buildStatusOnSkip (optional)
The action to take when static analysis is skipped because the changeset contained no files to analyze. Defaults to "Mark the build as Unstable".
SUCCESS, FAILURE, UNSTABLEchangeSetExclusionPatterns (optional)
Specify a comma separated list of filename patterns that you would like to explicitly excluded from the Jenkins-provided SCM changeset.
The pattern is applied to determine which files will be populated in the changeset file, stored at $CHANGE_SET_FILE_PATH.
If blank, will exclude none.
Examples:
| File Name | Pattern | Will be excluded |
|---|---|---|
| test.java | *.java | Yes |
| test.java | *.jpg | No |
| test.java | test.* | Yes |
| test.java | test.???? | Yes |
| test.java | test.????? | No |
StringchangeSetInclusionPatterns (optional)
Specify a comma separated list of filename patterns that you would like to explicitly included Jenkins-provided SCM changeset.
The pattern is applied to determine which files will be populated in the changeset file, stored at $CHANGE_SET_FILE_PATH.
If blank, will include all. Examples:
| File Name | Pattern | Will be included |
|---|---|---|
| test.java | *.java | Yes |
| test.java | *.jpg | No |
| test.java | test.* | Yes |
| test.java | test.???? | Yes |
| test.java | test.????? | No |
StringpolarisArguments (optional)
The command line arguments to pass to the CLI
StringpolarisCliName (optional)
The CLI installation to execute
StringwaitForIssues (optional)
Check this box to wait for CLI jobs to complete and set the build status based on issues discovered
buildStatusForIssues (optional)
The build status to set the project to if there are issues
SUCCESS, FAILURE, UNSTABLEjobTimeoutInMinutes (optional)
The maximum number of minutes to wait for jobs started by the Polaris CLI to complete when the Polaris CLI is executed without -w (nonblocking mode). Must be a positive integer, defaults to 30 minutes.
intfortiCWPScannerimageName
Stringblock (optional)
booleanportshift_vulnerability_scanneraccessKey
StringsecretKey
StringimageName
StringimageTag
Stringurl
StringscannerIp
String$class: 'PowerShell'command
StringstopOnError
Stops script when some step fails. Similar to Shell set -e. Translates to $ErrorActionPreference Stop or Continue. See documentation.
booleanuseProfile
Runs script with default profile or no profile. See documentation.
booleanunstableReturn (optional)
int$class: 'PowerShellBuildStep'buildStepId
StringdefineArgs
booleanbuildStepArgs
arg
String$class: 'PreflightBuilder'clientId
StringclientSecret
StringtestId
StringgroupId
StringenvironmentId
Stringplatforms
win-chrome.win-chrome,win-firefoxwinchrome, ie, edge, firefoxStringsizes
1440x900.1920x1080, 1440x9001920x1080, 1440x900, 1024x768, 480x640StringcaptureScreenshots
booleanwaitResults
boolean$class: 'PrereqBuilder'projects
StringwarningOnly
booleanprobelyScantargetId
ID of the target you want Probely to scan.
StringauthToken (optional)
Raw Probely API authentication key.
Please use the credentialsId field instead, unless you understand the security implications of using this mechanism. Passing the API authentication token directly is not advised, unless it is properly secured using a secret storage mechanism, such as HashiCorp Vault.
StringcredentialsId (optional)
Credential identifier for the Probely API authentication key.
StringfailThreshold (optional)
Mark the build as failed if a vulnerability with the following severity level is found.
StringstopIfFailed (optional)
If the build fails because the target is vulnerable, stop scanning for more vulnerabilities.
booleanwaitForScan (optional)
Wait for the scan to complete before proceeding to the next step in the pipeline.
Since a scan can take a long time, the plugin will return as soon as the scan starts. This is enabled by default to make the build faster.
Please note that disabling this option implies that the build step always finishes successfully, even if vulnerabilities are found later on.
Enabling this option allows the plugin to mark the build as failed if it finds any vulnerabilities.
boolean$class: 'ProjectGenerationStep'projectConfig
pipelineConfig
destructor
booleanauthorisations
StringbranchSCMParameter
booleanbranchParameters
StringgenerationExtension
StringpipelineGenerationExtension
StringdisableDslScript
booleanscriptDirectory
StringnamingStrategy
projectFolderPath
StringbranchFolderPath
StringprojectSeedName
StringprojectDestructorName
StringbranchSeedName
StringbranchStartName
StringbranchName
StringignoredBranchPrefixes
StringeventStrategy
delete
booleanauto
booleantrigger
booleancommit
Stringproject
StringscmType
StringscmUrl
StringscmCredentials
StringtriggerIdentifier
StringtriggerType
StringtriggerSecret
String$class: 'ProjectPrerequisitesInstaller'protecodesccredentialsId (optional)
StringprotecodeScGroup (optional)
Group ID can be found from the BDBA service by looking at the URL when browsing an individual group: https://protecode-sc.mydomain.com/group/1234/ or with Groups API https://protecode-sc.mydomain.com/api/groups/.
StringconvertToSummary (optional)
protecodesc.xml.
booleancustomHeader (optional)
StringdirectoryToScan (optional)
StringdontZipFiles (optional)
booleanendAfterSendingFiles (optional)
booleanfailIfVulns (optional)
booleanincludeSubdirectories (optional)
booleanpattern (optional)
StringprotecodeScanName (optional)
StringscanOnlyArtifacts (optional)
booleanscanTimeout (optional)
int$class: 'ProxyBuilder'projectName
StringdotnetPublishdotnet publish compiles the application, reads through its dependencies specified in the project file, and publishes the resulting set of files to a directory. The output includes the following assets:
dotnet publish command's output is ready for deployment to a hosting system (for example, a server, PC, Mac, laptop) for execution. It's the only officially supported way to prepare the application for deployment. Depending on the type of deployment that the project specifies, the hosting system may or may not have the .NET Core shared runtime installed on it. For more information, see Publish .NET Core apps with the .NET Core CLI .
configuration (optional)
Debug, but you can override the build configuration settings in your project.
Stringforce (optional)
booleanframework (optional)
Stringmanifest (optional)
Stringmanifests (optional)
StringmanifestsString (optional)
dotnet store command.
StringnoBuild (optional)
booleannoDependencies (optional)
booleannoRestore (optional)
booleannologo (optional)
booleanoption (optional)
Stringoptions (optional)
StringoptionsString (optional)
StringoutputDirectory (optional)
dotnet publish commands result in nested output folders. For example, if the project folder is myproject, and the publish output folder is myproject/publish, and you run dotnet publish twice, the second run puts content files such as .config and .json files in myproject/publish/publish. To avoid nesting publish folders, specify a publish folder that is not directly under the project folder, or exclude the publish folder from the project.
PublishDir property instead of this option. Stringproject (optional)
Stringproperties (optional)
java.util.Map<java.lang.String, java.lang.String>propertiesString (optional)
dotnet publish:
PublishProfile=Properties\PublishProfiles\profile.pubxml: Use a .pubxml to set publish-related properties. See Visual Studio publish profiles (.pubxml) for ASP.NET Core app deployment for more information. PublishReadyToRun=true: Compiles application assemblies as ReadyToRun (R2R) format. R2R is a form of ahead-of-time (AOT) compilation. For more information, see ReadyToRun images.PublishSingleFile=true: Packages the app into a platform-specific single-file executable. The executable is self-extracting and contains all dependencies (including native) that are required to run the app. When the app is first run, the application is extracted to a directory based on the app name and build identifier. Startup is faster when the application is run again. The application doesn't need to extract itself a second time unless a new version is used.PublishTrimmed=true: Trims unused libraries to reduce the deployment size of an app when publishing a self-contained executable. For more information, see Trim self-contained deployments and executables .PublishProfile, in a publish profile rather than here.
Stringruntime (optional)
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringselfContained (optional)
booleanshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleanshutDownBuildServers (optional)
dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
hanguntil those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
booleanspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleanunstableIfWarnings (optional)
booleanverbosity (optional)
StringversionSuffix (optional)
*) in the version field of the project file.
StringworkDirectory (optional)
StringsnPublishAppcredentialsId (optional)
StringapiVersion (optional)
StringappScope (optional)
application system ID is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
StringappSysId (optional)
application scope is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
StringappVersion (optional)
StringdevNotes (optional)
StringincrementBy (optional)
intisAppCustomization (optional)
booleanobtainVersionAutomatically (optional)
booleanurl (optional)
String$class: 'PublishBuilder'packageid
StringnugetFeedUrl
StringnugetFeedApiKey
class hudson.util.SecretpackageVersion
StringsqlChangeAutomationVersionOption
value
Latest, SpecificspecificVersion
String$class: 'PublishStepBuilder'packageId
StringnugetFeedUrl
StringnugetFeedUrlApi
StringpackageVersion
String$class: 'PullRequestCommenter'comment
StringdotnetNuGetPushdotnet nuget push command pushes a package to the server and publishes it. The push command uses server and credential details found in the system's NuGet config file or chain of config files. For more information on config files, see Configuring NuGet Behavior. NuGet's default configuration is obtained by loading %AppData%\NuGet\NuGet.config (Windows) or $HOME/.local/share (Linux/macOS), then loading any nuget.config or .nuget\nuget.config starting from the root of drive and ending in the current directory.
dotnet pack.
apiKeyId (optional)
StringdisableBuffering (optional)
booleanforceEnglishOutput (optional)
booleannoServiceEndpoint (optional)
booleannoSymbols (optional)
booleanroot (optional)
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleanskipDuplicate (optional)
booleansource (optional)
https://www.nuget.org, https://www.nuget.org/api/v3, and https://www.nuget.org/api/v2/package. For private feeds, replace the host name (for example, %hostname%/api/v3).
DefaultPushSource config value is set in the NuGet config file.
StringspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleansymbolApiKeyId (optional)
StringsymbolSource (optional)
Stringtimeout (optional)
intworkDirectory (optional)
String$class: 'PushBuilder'remoteImageStrategy
DO_NOT_USE, GENERATE_GIT, FIXEDhubUrls
Stringorganization
StringoverwriteOrganization
booleanremoteImageName
StringdateFormat
| y|Y | Year |
| M | Month |
| w | Week in year |
| W | Week in month |
| D | Day in year |
| d | Day in month |
| F | Day of week in month |
| E | Day name in week |
| u | Day number of week (1 = Monday, ..., 7 = Sunday) |
| H | Hour in day (0-23) |
| k | Hour in day (1-24) |
| K | Hour in am/pm (0-11) |
| h | Hour in am/pm (1-12) |
StringappendDate
booleanincrementVersion
boolean$class: 'Python'Runs a Python script (defaults to python interpreter) for building the project. The script will be run with the workspace as the current directory.
command
String$class: 'PythonBuilder'pythonName
Stringnature
Stringcommand
StringignoreExitCode
booleanqualityCloudsScancredentialsId
StringinstanceUrl
StringissuesCountThreshold
inttechDebtThreshold
intqcThreshold
inthighSeverityThreshold
int$class: 'QFTestConfigBuilder'The QF-Test build step. Invokes QF-Test binary during your Jenkins job. If not listed in your PATH variable, the location of the QF-Test binary can be specified explicitly.
The actual test configuration is set via pairs of arguments and suite file fields. The Advanced Test result control button allows to adjust the mapping between the QF-Test result and the Jenkins build result.
All report files that are produced will be stored in an output directory relative to your workspace, whose structure is as follows:
<LOGDIR>
├── html (HTML report directory)
├── junit (junit report directory)
└── qrz (QF-Test runlogs)
The resulting runlogs are automatically declared as Jenkins build artificats and should appear as such on the Jenkins build page. The junit and html reports can be processed further by the junit respectively the publishHTML plugin.
suitefield
suitename
StringcustomParam
StringcustomPath (optional)
StringonTestError (optional)
StringonTestException (optional)
StringonTestFailure (optional)
StringonTestWarning (optional)
StringreportDirectory (optional)
StringreportGenArgs (optional)
String$class: 'QualityCenter'qcClientInstallationName
StringqcQTPAddinInstallationName
StringqcServerURL
qcbin folder of the Quality Center Web application.
StringqcLogin
StringqcPass
StringqcDomain
StringqcProject
StringqcTSFolder
StringqcTSName
StringqcTSLogFile
Name of the report that will be generated.
If several test sets are run in one build step, one report will be generated per test set. As such, you must ensure that the name will be unique by including the test set name in it (through the ${TS_NAME} variable). If it's not the case, then the name will be automatically post fixed with an underscore followed by the test set name.
You can use all standard environment variables plus:
${QC_DOMAIN} for the current Quality Center domain;${QC_PROJECT} for the current Quality Center project;${TS_FOLDER} for the current TestSet folder;${TS_NAME} for the TestSet name.StringqcTimeOut
intrunMode
StringrunHost
StringacrQuickTaskazureCredentialsId
StringresourceGroupName
StringregistryName
Stringarchitecture (optional)
StringbuildArgs (optional)
docker build --build-arg.
key
Stringvalue
Stringsecrecy
booleandockerfile (optional)
StringgitPath (optional)
StringgitRefspec (optional)
StringgitRepo (optional)
https://PAT@github.com/user/repo.git for private repo.
StringimageNames (optional)
image
Stringlocal (optional)
StringnoCache (optional)
no-cache flag when build as docker build --no-cache
booleanos (optional)
StringsourceType (optional)
Stringtarball (optional)
http://remoteserver/myapp.tar.gz
Stringtimeout (optional)
intvariant (optional)
String$class: 'R'Runs an R script (defaults to RScript interpreter) for building the project. The script will be run with the workspace as the current directory.
command
String$class: 'RAD'activateProjectWorkspaceVar
WORKSPACE environment variable through the PROJECT_WORKSPACE one.
WORKSPACE variable during this build step as it doesn't refer to the workspace of the project: It is internally used by RAD.
booleanbuildFile
build.xml one in the project's workspace. The base directory is the workspace.
StringdeleteRadWorkspaceContent
.metadata folder.
booleandeleteRadWorkspaceMetadata
.metadata folder of RAD's workspace has to be removed before RAD is actually run.
booleanproperties
# comment
name1=value1
name2=value2
These are passed to RAD like "-Dname1=value1 -Dname2=value2"
StringradInstallationName
StringradWorkspace
Stringtargets
String$class: 'RPDCreateInstance'pack
StringinstanceName
StringcustomProfile
String$class: 'RPDDeployInstance'instanceName
Stringpack
Stringenvironment
Stringroute
StringcustomProfile
StringuseCustomProfile
boolean$class: 'RTCGitBuilder'serverURI
The Jazz Repository connection URI for the Rational Team Concert (RTC) server
StringcredentialsId
Credentials to use for the build user. A user name and password credential for the Jazz Repository should be configured.
StringannotateChangeLog
Optionally hyperlink bug numbers that appear in git commit descriptions as links to Rational Team Concert Work Items.
booleanbuildDefinition (optional)
The ID of the Hudson/Jenkins build definition within the Rational Team Concert (RTC) server. The build definition should not have any Source Control option.
StringjenkinsRootURI (optional)
StringjenkinsRootURIOverride (optional)
Optionally specify the HTTP address of the Jenkins installation, such as http://yourhost.yourdomain/jenkins/. This is necessary because the Rational Team Concert Git plugin cannot reliably detect such a URL from within itself.
booleantimeout (optional)
The timeout period in seconds for Jazz repository requests made during the build.
inttrackBuildWorkItem (optional)
Specify an Id of a Work Item in Rational Team Concert. The Work Item will be updated with the execution status of the Jenkins build.
StringuseBuildDefinition (optional)
booleanuseTrackBuildWorkItem (optional)
booleanuseWorkItems (optional)
booleanworkItemUpdateType (optional)
StringrabbitMQPublisherrabbitName
Stringexchange
Stringdata
Stringconversion (optional)
booleanroutingKey (optional)
StringtoJson (optional)
boolean$class: 'RadarGunBuilder'radarGunInstance
$class: 'RadarGunCustomInstallation'home
String$class: 'RadarGunInstallationWrapper'radarGunName
StringscenarioSource
$class: 'FileScenarioSource'scenarioPath
String$class: 'TextScenarioSource'scenario
StringnodeSource
$class: 'FileNodeConfigSource'nodeListPath
String$class: 'TextNodeConfigSource'nodes
StringscriptSource
$class: 'BuildInScriptSource'$class: 'FileScriptSource'mainPath
StringworkerPath
String$class: 'TextScriptSource'mainScript
StringworkerScript
StringremoteLoginProgram
StringremoteLogin
StringworkspacePath
StringpluginPath
StringpluginConfigPath
StringreporterPath
String$class: 'Rake'rakeInstallation
StringrakeFile
Stringtasks
StringrakeLibDir
StringrakeWorkingDir
Stringsilent
booleanbundleExec
boolean$class: 'RallyBuild'preRallyState
stateName
StringissueString
StringupdateOnce
booleanpreComment
preCommentText
StringpreReady
preReadyState
booleanchangeReady
issueReady
booleancreateComment
commentText
StringchangeRallyState
issueRallyState
StringchangeDefectRallyState
defectRallyState
StringrancherRedeploycredential
Stringworkload
since endpoint part has bean set in Credential, you only need specify path from "/p/" or "/project", eg:
/project/c-h4hxd:p-c9j8z/workloads/deployment:default:busybox
or /p/c-h4hxd:p-dwqfr/workload/deployment:jenkins:jenkins
Stringimages
nginx;nginx:1.0;myteam/myproject:v2.0;docker.io/team/image:v1.0.${BUILD_NUMBER}
this plugin will update all images in this workload by match the name part exactly, and simply set version part as you specified. so you may need Jenkins variables to dynamic generate new version number.StringalwaysPull
booleanrancherenvironmentId
Stringendpoint
StringcredentialId
Stringservice
Stringimage
Stringconfirm
booleanstartFirst
booleanports
Stringenvironments
Stringtimeout
intranorexcmdLineArgs (optional)
| Flag | Function |
|---|---|
| config | cfg:<config parameter name>=<value> | Set values for configuration parameters. |
| reportlevel | rl: Debug|Info|Warn|Error|Success|Failure|<any integer> | Sets the minimum report level that log messages need to have in order to be included in the log file. Specify 'None' to completely disable reporting. These levels correspond to the following integer values: Debug=10,Info=20,Warn=30,Error=40,Success=110,Failure=120 |
| testcase | tc:<name or guid of test case> | Runs this test case only. |
| testsuite | ts:<path to test suite file> | Runs the test cases defined by the test suite (rxtst) file. By default the rxtst file with the same name as the <TestSuiteExe> is used or the first rxtst file in the same folder as <TestSuiteExe>. |
| module | mo:<module name or guid> | Runs the module with the specified name or guid. Assemblies loaded by <TestSuiteExe> and assemblies referenced in the rxtst file are searched. |
| testcaseparam | tcpa:<name or guid of test case>:<parameter name>=<value> | Creates or overrides values for testcase parameters specified in the test suite. |
| runlabel | rul:<custom value> | Sets a custom runlabel for the test run. |
| testcasedatarange | tcdr:<name or guid of test case>=<data range> | Sets the data range for a testcase. |
StringrxGlobalParameter (optional)
StringrxJUnitReport (optional)
booleanrxReportDirectory (optional)
StringrxReportExtension (optional)
StringrxReportFile (optional)
StringrxRunConfiguration (optional)
StringrxTestRail (optional)
booleanrxTestRailPassword (optional)
StringrxTestRailRID (optional)
StringrxTestRailRunName (optional)
StringrxTestRailUser (optional)
StringrxTestSuiteFilePath (optional)
StringrxZippedReport (optional)
booleanrxZippedReportDirectory (optional)
StringrxZippedReportFile (optional)
String$class: 'RapidDeployJobPlanRunner'serverUrl
StringauthenticationToken
StringjobPlan
StringasynchronousJob
booleanshowIndividualLogs
booleanshowFullLog
boolean$class: 'RapidDeployJobRunner'serverUrl
StringauthenticationToken
Stringproject
Stringtarget
StringpackageName
StringasynchronousJob
booleanshowFullLog
boolean$class: 'RapidDeployPackageBuilder'serverUrl
StringauthenticationToken
Stringproject
StringenableCustomPackageName
booleanpackageName
StringarchiveExtension
String$class: 'RawCliBuilder'changeLogFile (optional)
StringchangeLogParameters (optional)
StringcommandArguments (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringinstallationName (optional)
Stringlabels (optional)
StringliquibasePropertiesPath (optional)
Stringpassword (optional)
StringresourceDirectories (optional)
Stringurl (optional)
Stringusername (optional)
String$class: 'RebaseBuilder'You can rebase from the latest revision in the upstream branch, but you can also do safer rebase by choosing the permalink. For example, if you specify "last stable", then Jenkins will look for the last stable build, then rebase with the corresponding Subversion revision. Thus you know that you are rebasing to the known good state.
If you don't want Jenkins to automatically rebase, you can still use the "Rebase From Upstream" link from the left to manually initiate the rebase.
permalink
StringstopBuildIfMergeFails
booleansetUnstableIfMergeFails
boolean$class: 'RebootIOSDevice'url
StringcloudTestServerID
StringadditionalOptions
String$class: 'ReconfigureBox'id
Stringcloud
Stringworkspace
Stringbox
Stringinstance
Stringvariables
StringbuildStep
StringbuildStepVariables
String$class: 'ReinstallBox'cloud
Stringworkspace
Stringbox
Stringinstance
StringbuildStep
String$class: 'ReleaseMarker'releaseName
Stringservices (optional)
name
StringscopedTo (optional)
applications
name
Stringapplications (optional)
name
StringreleaseEndTimestamp (optional)
StringreleaseStartTimestamp (optional)
StringandroidApkMoveapkFilesPattern (optional)
StringapplicationId (optional)
StringfilesPattern (optional)
StringfromVersionCode (optional)
booleangoogleCredentialsId (optional)
StringinAppUpdatePriority (optional)
StringreleaseName (optional)
StringrolloutPercent (optional)
doublerolloutPercentage (optional)
StringtrackName (optional)
StringversionCodes (optional)
StringaddRelizaReleaseartId (optional)
StringartType (optional)
StringenvSuffix (optional)
StringprojectId (optional)
Stringstatus (optional)
Stringuri (optional)
StringuseCommitList (optional)
Stringversion (optional)
String$class: 'RemoteBuildConfiguration'abortTriggeredJob (optional)
booleanauth2 (optional)
BearerTokenAuthtoken (optional)
class hudson.util.SecretCredentialsAuthcredentials (optional)
StringNoneAuthNullAuthTokenAuthapiToken (optional)
class hudson.util.SecretuserName (optional)
StringblockBuildUntilComplete (optional)
booleandisabled (optional)
booleanenhancedLogging (optional)
booleanhttpGetReadTimeout (optional)
inthttpPostReadTimeout (optional)
intjob (optional)
StringloadParamsFromFile (optional)
booleanmaxConn (optional)
intoverrideTrustAllCertificates (optional)
booleanparameterFile (optional)
Stringparameters (optional)
StringpollInterval (optional)
intpreventRemoteBuildQueue (optional)
booleanremoteJenkinsName (optional)
StringremoteJenkinsUrl (optional)
StringshouldNotFailBuild (optional)
booleantoken (optional)
StringtrustAllCertificates (optional)
It is possible to override/rewrite the 'Trust all certificate'-setting for each Job separately. Setting this checkbox to 'true' will result in accepting all certificates for the given Job.
This is unsafe and should only be used for testing or if you trust the host.
booleanuseCrumbCache (optional)
booleanuseJobInfoCache (optional)
booleancrxReplicatepackageIds (optional)
StringbaseUrls (optional)
username[:password]@ between the scheme and the hostname.
StringcredentialsId (optional)
/$username/keys/$fingerprint.
StringignoreErrors (optional)
booleanrequestTimeout (optional)
longserviceTimeout (optional)
longwaitDelay (optional)
longacmRepoSyncurl
StringcredentialsId
Stringforce (optional)
boolean$class: 'ReqtifyGenerateReport'reportArgumentList
StringnameReport (optional)
StringmodelReport (optional)
StringtemplateReport (optional)
StringpublishReviewdownloadOnly
booleaninstallRBTools
boolean$class: 'ReviewboardApplyPatch'$class: 'ReviewboardPollingBuilder'reviewbotJobName
StringcheckBackPeriod
StringreviewbotRepoId
StringrestrictByUser
booleandisableAdvanceNotice
boolean$class: 'RigorBuilder'credentialsId
Please select a credential of Kind Rigor API Key here.
Note: Your Rigor Optimization API key can be found on the API Credentials settings page in the Rigor Optimization application. The API key must have User or higher level permissions.
StringperformanceTestIds
List 1 or more test IDs (as a comma separated list) of Rigor Optimization Performance Tests to be run during this step. You can locate the performance test ID by hovering over the Info (i) icon on any performance test in the View Results page of your Rigor Optimization account.
If Fail build based on results is checked below, this step will wait until all tests complete before proceeding. If unchecked, this step will launch these tests, but not wait for them to complete.
StringfailOnSnapshotError
If checked, the build will be marked as failed if there are any errors running your configured performance tests. If unchecked, any errors creating tests will be treated as warnings and not fail the build.
booleanfailOnResults
If checked, the build will wait for your configured tests to complete (may take 30 seconds to a few minutes) and pass/fail based on the results configured below. If unchecked, your configured tests will run, but the build will not wait for the tests to complete nor fail this step based on any results (useful for historical change logging of your site in the Rigor Optimization application).
booleanperformanceScore
Optional
Fail the build if any test reports an overall performance score lower than this value (1-100)
StringcriticalNumber
Optional
Fail the build if any test has more than this # of critical first party content defects found.
Note: You can customize when critical defects occur by customizing your Defect Check Policy. Learn more in this article.
StringfoundDefectIds
Optional
Fail the build if any of the listed defect IDs (comma separated) are found for any first party content items in any configured test.
Note: You can locate any defect ID at the top of any defect detail page in your results, or in the Knowledge Base. See Example.
StringenforcePerformanceBudgets
Optional
Fail the build if any test exceeds its performance budgets
booleantotalContentSize
StringtotalFoundItems
StringtestTimeoutSeconds
Timeout in seconds to wait for all configured performance tests to complete. Defaults to 300 seconds (5 minutes).
This value is only used if Fail build based on test results is enabled.
StringsnRollbackAppcredentialsId (optional)
StringapiVersion (optional)
StringappScope (optional)
application system ID is not specified. The scope name of the application for which to apply the changes, such as x_aah_custom_app. You can locate this value in the scope field in the Custom Application [sys_app] table.
StringappSysId (optional)
application scope is not specified. The system id of the application for which to apply the changes. You can locate this value in the Sys ID field in the Custom Application [sys_app] table.
StringrollbackAppVersion (optional)
Stringurl (optional)
String$class: 'RollbackBuilder'changeLogFile (optional)
StringchangeLogParameters (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringinstallationName (optional)
Stringlabels (optional)
StringliquibasePropertiesPath (optional)
StringnumberOfChangesetsToRollback (optional)
Stringpassword (optional)
StringresourceDirectories (optional)
StringrollbackLastHours (optional)
StringrollbackToDate (optional)
StringrollbackToTag (optional)
StringrollbackType (optional)
Stringurl (optional)
Stringusername (optional)
StringsnRollbackPlugincredentialsId (optional)
StringapiVersion (optional)
StringpluginId (optional)
Stringurl (optional)
String$class: 'RqmBuilder'collectionStrategy
$class: 'RqmTestSuiteExectionRecordCollectionStrategy'executionRecordName
StringplanName
StringprojectName
StringiterativeTestCaseBuilders
hudson.tasks.BuildStep)preBuildSteps
hudson.tasks.BuildStep)postBuildSteps
hudson.tasks.BuildStep)credentialId
String$class: 'RubyMotionBuilder'platform
StringrakeTask
StringoutputStyle
StringoutputFileName
StringuseBundler
booleaninstallCocoaPods
booleanneedClean
booleanoutputResult
booleandeviceName
StringsimulatorVersion
StringenvVars
String$class: 'RunApplicationAction'applicationName
Application selection is mandatory
Select an existing Application in Calm or the ones provisioned in Nutanix Calm Blueprint Launch Steps.
StringactionName
Application Action selection is mandatory
StringruntimeVariables
Click on Fetch Runtime Variables to fetch all editable variables for the selected Action in JSON format. Modify the key values from the defaults as needed.The values can also reference jenkins environment variables.
StringrunFromAlmBuilderalmServerName
StringalmCredentialsScope
StringalmUserName
StringalmPassword
StringalmDomain
StringalmProject
StringalmTestSets
StringalmRunResultsMode
StringalmTimeout
StringalmRunMode
StringalmRunHost
StringalmClientID
StringalmApiKey
StringisSSOEnabled
booleanisFilterTestsEnabled (optional)
booleanfilterTestsModel (optional)
blockedCheckbox
booleanfailedCheckbox
booleannotCompletedCheckbox
booleannoRunCheckbox
booleanpassedCheckbox
booleantestName (optional)
StringalmServerSettingsModel (optional)
almServerName
StringalmServerUrl
StringalmCredentials
almUsername
StringalmPassword
StringalmSSOCredentials
almClientID
StringalmApiKeySecret
StringrunFromFSBuilderfsTests
StringfileSystemTestSetModel
fileSystemTestSet
tests
StringparallelRunnerEnvironments
environment
StringenvironmentType
StringsummaryDataLogModel
logVusersStates
booleanlogErrorCount
booleanlogTransactionStatistics
booleanpollingInterval
StringscriptRTSSetModel
scripts
scriptName
StringadditionalAttributes
name
Stringvalue
Stringdescription
StringisParallelRunnerEnabled (optional)
booleanuftSettingsModel (optional)
selectedNode (optional)
StringnumberOfReruns (optional)
StringcleanupTest (optional)
StringonCheckFailedTest (optional)
StringfsTestType (optional)
StringrerunSettingsModels (optional)
test (optional)
Stringchecked (optional)
booleannumberOfReruns (optional)
intcleanupTest (optional)
StringanalysisTemplate (optional)
StringcontrollerPollingInterval (optional)
StringdisplayController (optional)
StringfsAutActions (optional)
StringfsDeviceId (optional)
StringfsDevicesMetrics (optional)
StringfsExtraApps (optional)
StringfsInstrumented (optional)
StringfsJobId (optional)
StringfsLaunchAppName (optional)
StringfsManufacturerAndModel (optional)
StringfsOs (optional)
StringfsPassword (optional)
StringfsReportPath (optional)
StringfsTargetLab (optional)
StringfsTimeout (optional)
StringfsUftRunMode (optional)
StringfsUserName (optional)
StringignoreErrorStrings (optional)
StringmcServerName (optional)
StringmcTenantId (optional)
StringperScenarioTimeOut (optional)
StringproxySettings (optional)
fsUseAuthentication
booleanfsProxyAddress
StringfsProxyUserName
StringfsProxyPassword
class hudson.util.SecretresultFileNames (optional)
java.util.Map<java.lang.Long, java.lang.String>useSSL (optional)
boolean$class: 'RunInCloudBuilder'projectId
The Bitbar Cloud project in which to start the new test run.
StringappPath
StringtestPath
StringdataPath
StringtestRunName
Stringscheduler
StringtestRunner
StringdeviceGroupId
Stringlanguage
StringscreenshotsDirectory
StringkeyValuePairs
StringwithAnnotation
StringwithoutAnnotation
StringtestCasesSelect
StringtestCasesValue
StringfailBuildIfThisStepFailed
booleanvirusScanTimeout
StringwaitForResultsBlock
testRunStateCheckMethod (optional)
HOOK_URL, API_CALLdownloadScreenshots (optional)
booleanforceFinishAfterBreak (optional)
booleanhookURL (optional)
StringresultsPath (optional)
StringwaitForResultsTimeout (optional)
inttestTimeout
StringcredentialsId
StringcloudUrl
StringcloudUIUrl
StringframeworkId
longosType
IOS, ANDROID, DESKTOP, UNDEFINEDtpJobRunprojectId (optional)
StringjobId (optional)
StringagentId (optional)
StringwaitJobFinishSeconds (optional)
intexecutionParameters (optional)
StringjunitResultsFile (optional)
StringosfBuilderSuiteForSFCCRunJobhostname (optional)
StringocCredentialsId (optional)
StringocVersion (optional)
StringjobName (optional)
StringjobArguments (optional)
name
Stringvalue
String$class: 'RunLoadRunnerScript'scriptsPath
String$class: 'RunMatlabCommandBuilder'matlabCommand (optional)
String$class: 'RunMatlabTestsBuilder'coberturaArtifact (optional)
coberturaReportFilePath
StringjunitArtifact (optional)
junitReportFilePath
StringmodelCoverageArtifact (optional)
modelCoverageFilePath
StringpdfReportArtifact (optional)
pdfReportFilePath
StringselectByFolder (optional)
testFolderPaths
testFolders
StringselectByTag (optional)
testTag
StringsourceFolder (optional)
Specify the location of folders containing source code, relative to the project root folder. The specified folders and their subfolders are added to the top of the MATLAB search path. To generate a coverage report, MATLAB uses only the source code in the specified folders and their subfolders.
Paste the source folder path in the Folder path box. To add more folders, click Add folder.
sourceFolderPaths
srcFolderPath
StringstmResultsArtifact (optional)
stmResultsFilePath
StringtapArtifact (optional)
tapReportFilePath
String$class: 'RunPcTestBuildStep'almPassword (optional)
StringalmUser (optional)
Stringdomain (optional)
StringfailIfTaskFails (optional)
booleanoutputDir (optional)
StringpollingInterval (optional)
intpostRunActionString (optional)
Stringproject (optional)
StringretryCollateAndAnalysisAttempts (optional)
intretryCollateAndAnalysisFlag (optional)
booleanretryCollateAndAnalysisInterval (optional)
intretryCount (optional)
intretryInterval (optional)
intretryIntervalMultiplier (optional)
doubletestLabPath (optional)
StringtestPlanPath (optional)
Stringtimeout (optional)
inttimeslotDuration (optional)
intvudsMode (optional)
booleanrunPromotionartifact (optional)
StringartifactType (optional)
StringkeepTargetResources (optional)
booleankeepTargetRunProfiles (optional)
booleanplan (optional)
Stringpromotion (optional)
Stringtask (optional)
Stringworkspace (optional)
StringrunTaskenvironment (optional)
Stringparameters (optional)
Stringtask (optional)
Stringworkspace (optional)
StringtpTestRunjunitResultsFile
StringwaitTestFinishSeconds
intprojectId
StringtestId
StringagentId
Stringbrowser
Stringdevice
StringexecutionParameters
String$class: 'RunTestSetBuildStep'domain
Stringproject
StringrunMode
Stringhost
StringtestSets
StringoutputDirPath
StringtimeOut
intsnRunTestSuitecredentialsId (optional)
StringapiVersion (optional)
StringbrowserName (optional)
Valid values:
StringbrowserVersion (optional)
StringosName (optional)
StringosVersion (optional)
StringresponseBodyFormat (optional)
StringtestSuiteName (optional)
StringtestSuiteSysId (optional)
sys_id of the test suite to run. This value is located in the Test [sys_atf_test_suite] table.
Stringurl (optional)
StringwithResults (optional)
boolean$class: 'RunUftTestBuildStep'testPath
StringoutputDirPath
String$class: 'RunscopeBuilder'triggerEndPoint
StringaccessToken
Stringtimeout
ints3CopyArtifactprojectName
StringbuildSelector
downstreamupstreamProjectName
Copy artifacts from a build that is a downstream of a build of the specified project. You can use variable expressions.
Downstream builds are found using fingerprints of files. That is, a build that is triggered from a build isn't always considered downstream, but you need to fingerprint files used in builds to let Jenkins track them.
Note: "Downstream build of" is applicable only to AbstractProject based projects (both upstream and downstream projects).
StringupstreamBuildNumber
StringlastWithArtifactslastCompleted$class: 'MultiJobBuildSelector'buildParameterparameterName
You can pass not only the parameter name, but also the parameter value itself. This is useful especially used with workflow-plugin.
Stringpermalinkid
String$class: 'PromotedBuildSelector'level
intlatestSavedBuildspecificbuildNumber
StringlastSuccessfulstable (optional)
booleanupstreamallowUpstreamDependencies (optional)
booleanfallbackToLastSuccessful (optional)
booleanupstreamFilterStrategy (optional)
UseGlobalSetting, UseOldest, UseNewestworkspacefilter
StringexcludeFilter
Stringtarget
Stringflatten
booleanoptional
boolean$class: 'SASUnitPlugInBuilder'This is the Jenkins Plug-In for SASUnit the unit testing framework for SAS.
sasunitBatch
StringdoxygenBatch
Please enter the relative path to the executable to create the doxygen report
StringsasunitVersion
Please pick a SASUnit installation that shall be used.
To add an installation please go to Jenins->Manage Jenkins->Setting or follow this link.
StringcreateDoxygenDocu
boolean$class: 'SBuild'sbuildVersion
Stringtargets
StringbuildFiles
Stringoptions
StringscmSkipdeleteBuild (optional)
booleanskipPattern (optional)
String$class: 'SConsBuilderCommand'sconsName
Stringoptions
Stringvariables
Stringtargets
StringrootSconsscriptDirectory
StringcommandScript
String$class: 'SConsBuilderScriptFile'sconsName
Stringoptions
Stringvariables
Stringtargets
StringrootSconsscriptDirectory
Stringsconsscript
String$class: 'SMABuilder'validateEnabled
booleanusername
Stringpassword
StringsecurityToken
StringserverType
StringtestLevel
StringprTargetBranch
String$class: 'SQLPlusRunnerBuilder'credentialsId
Stringinstance
StringscriptType
Stringscript
StringscriptContent
| SELECT sysdate from dual; show user; |
StringcustomNLSLang (optional)
StringcustomOracleHome (optional)
StringcustomSQLPath (optional)
StringcustomSQLPlusHome (optional)
StringcustomTNSAdmin (optional)
String$class: 'SSHBuilder'siteName
Stringcommand
StringexecEachLine
Execute each line in the script individually.
By default, all of the commands are concatenated into a single "command" issued over a single SSH exec channel. Selecting this option causes each line to be executed over it's own SSH exec channel, each of which is part of the same session.
This is useful in certain cases where the commands cannot be concatenated into a single script executed at one time, for example, when issuing commands using the sourceforge.net shell.
If unsure, leave this box unchecked.
booleanhideCommand (optional)
boolean$class: 'SaltAPIBuilder'authtype
StringclientInterface
hookpost
Stringtag
Stringbatchfunction
Stringarguments
StringbatchSize
StringbatchWait
Stringtarget
Stringtargettype
Stringlocalfunction
Stringarguments
Stringtarget
Stringtargettype
Stringblockbuild (optional)
booleanjobPollTime (optional)
intminionTimeout (optional)
intsubsetfunction
Stringarguments
Stringsubset
Stringtarget
Stringtargettype
Stringrunnerfunction
Stringarguments
Stringmods
Stringpillarvalue
StringcredentialsId
Stringservername (optional)
StringsaveEnvVar (optional)
booleansaveFile (optional)
booleanskipValidation (optional)
boolean$class: 'SbtPluginBuilder'name
StringjvmFlags
StringsbtFlags
Stringactions
StringsubdirPath
String$class: 'ScanBuilder'scanURL
StringapiKey
class hudson.util.Secretsource
Stringexclude
Stringrule
Stringtimeout
intisAbortBuild
booleanisPrivateScan
booleanisShowBlockedOnly
booleanisCreateLog
booleanvdooScanbaseApi (optional)
StringfailThreshold (optional)
StringfirmwareLocation (optional)
StringmaliciousFiles (optional)
StringmaxHighlightedCVEs (optional)
StringmaxHighlightedExposures (optional)
StringmaxHighlightedIssues (optional)
StringproductId (optional)
StringvdooToken (optional)
class hudson.util.SecretwaitForResults (optional)
boolean$class: 'ScriptBuildStep'buildStepId
StringdefineArgs
booleanbuildStepArgs
arg
Stringtokenized
boolean$class: 'ScriptBuilder'scriptFilePath
StringcredentialsId
StringhubUrl
StringimageName
StringvmVersion
StringcontainerWorkingDir
StringmountSettings
sourceContainer
StringsourceFolder
StringtargetFolder
StringrouteFile
StringnoBase
booleanoverwrite
booleandiagnostic
boolean$class: 'SealightsCLIBuildStep'enabled
booleanfailBuildIfStepFail
booleancommandMode
$class: 'ConfigView'appName
StringbranchName
StringbuildName
$class: 'DefaultBuildName'$class: 'EmptyBuildName'$class: 'LatestBuildName'$class: 'ManualBuildName'insertedBuildName
String$class: 'UpstreamBuildName'upstreamProjectName
StringlabId
StringbuildSessionId
StringadditionalArguments
| Argument name | Description |
|---|---|
| token | The token provided to you by SeaLights (override the global 'token' value for this build). |
| tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
| proxy | A valid URL to a proxy server. |
| agentpath | Override the path to SeaLights jar. |
| javapath | Override the path to the 'java' variable (default is 'java'). |
| filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
StringtechOptions
$class: 'DotNetOptions'namespacesIncluded
StringnamespacesExcluded
StringincludedFilePatterns
StringexcludedFilePatterns
String$class: 'JavaOptions'packagesIncluded
StringpackagesExcluded
String$class: 'EndView'buildSessionId
StringlabId
StringadditionalArguments
| Argument name | Description |
|---|---|
| token | The token provided to you by SeaLights (override the global 'token' value for this build). |
| tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
| proxy | A valid URL to a proxy server. |
| agentpath | Override the path to SeaLights jar. |
| javapath | Override the path to the 'java' variable (default is 'java'). |
| filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
| appname | Override default app name coming from build session id |
| buildname | Override default build name coming from build session id |
| branchname | Override default branch name coming from build session id |
String$class: 'ExternalReportView'report
StringbuildSessionId
StringadditionalArguments
| Argument name | Description |
|---|---|
| token | The token provided to you by SeaLights (override the global 'token' value for this build). |
| tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
| proxy | A valid URL to a proxy server. |
| agentpath | Override the path to SeaLights jar. |
| javapath | Override the path to the 'java' variable (default is 'java'). |
| filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
| appname | Override default app name coming from build session id |
| buildname | Override default build name coming from build session id |
| branchname | Override default branch name coming from build session id |
String$class: 'PrConfigView'appName
StringbranchName
StringbuildName
$class: 'DefaultBuildName'$class: 'EmptyBuildName'$class: 'LatestBuildName'$class: 'ManualBuildName'insertedBuildName
String$class: 'UpstreamBuildName'upstreamProjectName
StringlabId
StringbuildSessionId
StringadditionalArguments
| Argument name | Description |
|---|---|
| token | The token provided to you by SeaLights (override the global 'token' value for this build). |
| tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
| proxy | A valid URL to a proxy server. |
| agentpath | Override the path to SeaLights jar. |
| javapath | Override the path to the 'java' variable (default is 'java'). |
| filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
StringtechOptions
$class: 'DotNetOptions'namespacesIncluded
StringnamespacesExcluded
StringincludedFilePatterns
StringexcludedFilePatterns
String$class: 'JavaOptions'packagesIncluded
StringpackagesExcluded
StringlatestCommit
StringpullRequestNumber
StringrepoUrl
StringtargetBranch
String$class: 'StartView'testStage
StringbuildSessionId
StringlabId
StringadditionalArguments
| Argument name | Description |
|---|---|
| token | The token provided to you by SeaLights (override the global 'token' value for this build). |
| tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
| proxy | A valid URL to a proxy server. |
| agentpath | Override the path to SeaLights jar. |
| javapath | Override the path to the 'java' variable (default is 'java'). |
| filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
| appname | Override default app name coming from build session id |
| buildname | Override default build name coming from build session id |
| branchname | Override default branch name coming from build session id |
String$class: 'UploadReportsView'reportFiles
StringreportsFolders
Stringsource
StringbuildSessionId
StringlabId
StringadditionalArguments
| Argument name | Description |
|---|---|
| token | The token provided to you by SeaLights (override the global 'token' value for this build). |
| tokenfile | A file containing the token provided to you by SeaLights (override the global 'token' value for this build). |
| proxy | A valid URL to a proxy server. |
| agentpath | Override the path to SeaLights jar. |
| javapath | Override the path to the 'java' variable (default is 'java'). |
| filesstorage | A folder where sealights files for this build will be kept (override the global 'Files storage' value for this build). |
| appname | Override default app name coming from build session id |
| buildname | Override default build name coming from build session id |
| branchname | Override default branch name coming from build session id |
StringcliRunner
class io.sealights.plugins.sealightsjenkins.buildsteps.cli.CLIRunnerlogDestination
CONSOLE, FILElogFolder
StringlogLevel
OFF, INFO, DEBUG, WARN, ERRORlogFilename
String$class: 'SecurityCheckerBuilder'$class: 'SeleniumAutoExecBuilder'serverUrl
String$class: 'SeleniumBuilderBuilder'scriptFile
StringparallelSettings
threadPoolSize
int$class: 'SelfServiceBookmarkBuilder'delphixEngine
StringdelphixBookmark
StringdelphixOperation
StringdelphixContainer
StringloadFromProps (optional)
booleansaveToProps (optional)
boolean$class: 'SelfServiceContainerBuilder'delphixEngine
StringdelphixEnvironment
StringdelphixOperation
StringdelphixBookmark
StringloadFromProps (optional)
booleansaveToProps (optional)
boolean$class: 'SemanticVersioningBuilder'parser
StringnamingStrategy
StringuseJenkinsBuildNumber
booleanenvVariable
String$class: 'SendMessageBuildStep'message
Stringfilepath
Stringrecipients
id
StringsensediaApiDeployenviromentName
Stringrevision
StringsensediaApiJsonapiId
StringsensediaApiQArevisionNumber
intdestination
booleanlogInterceptor
booleanresourceOutOfSize
booleanresourceSize
intshellBy default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
command
StringconfiguredLocalRules (optional)
retainOnlyVariablesLimit which environment variables are passed to a build step.
Environment variables passed to the build step are filtered, unless listed below.
The behavior of this filter depends on whether the environment variable is originally defined outside Jenkins:
JOB_URL, it will not be passed to the build step unless specified here.PATH, the behavior depends on the option Process environment variables handling: If that option is set to Retain, the original value will be passed to the build step, discarding any modifications inside Jenkins. If that option is set to Remove, the variable will not be passed to the build step. The following table shows the effect of filtering on an environment variable:
| Behavior | Originally defined outside Jenkins | Originally defined inside Jenkins |
|---|---|---|
| Process environment variables handling: reset | Variable is reset to original value | Variable is removed |
| Process environment variables handling: removed | Variable is removed | Variable is removed |
processVariablesHandling (optional)
RESET, REMOVEretainCharacteristicEnvVars (optional)
When checked, characteristic environment variables will be retained in addition to the variables listed above. These environment variables are job- and build-specific, defined by Jenkins, and are used to identify and kill processes started by this build step. See the documentation for more details on starting processes.
booleanvariables (optional)
Whitespace separated, case insensitive list of environment variables that will be retained, i.e. not removed from the environment of this build step or reset to their default.
StringunstableReturn (optional)
int$class: 'SideeX'protocolMenu
The default protocol is "HTTP".
Use "HTTPS (Disable certificate checking)" to disable certificate checking.
Use "HTTPS (Enable certificate checking)" to enable certificate checking.
$class: 'HTTPItem'baseURL
String$class: 'HTTPSDisableItem'baseURL
String$class: 'HTTPSEnableItem'baseURL
StringcaFilePath
StringstateTime
StringtestCaseFilePath
StringsignAndroidApksandroidHome (optional)
zipalign tool. You can also set the ANDROID_HOME environment variable in your Jenkins system or node configuration. E.g., /usr/local/android-sdk.
StringapksToSign (optional)
myApp/build/outputs/apk/myApp-unsigned.apk or **/*-unsigned.apk or app1/**/*-unsigned.apk, app2/**/*-unsigned.apk.
StringarchiveSignedApks (optional)
SignApksBuilder-out/myApp-unsigned.apk/myApp-signed.apk, where myApp-unsigned.apk is a directory named for the input unsigned APK.
booleanarchiveUnsignedApks (optional)
booleankeyAlias (optional)
Key Store ID references. If your key store contains only one key entry, which is the most common case, you can leave this field blank.
StringkeyStoreId (optional)
StringsignedApkMapping (optional)
unsignedApkNameDirunsignedApkSiblingskipZipalign (optional)
booleanzipalignPath (optional)
zipalign executable this build step should use to align the target APKs. You can also set the ANDROID_ZIPALIGN environment variable in your Jenkins system or node configuration. E.g., /opt/android-tools/bin/zipalign
StringvenafiCodeSignWithSignTooltppName
StringfileOrGlob
A path or a glob that specifies the file(s) to be signed.
StringappendSignatures (optional)
booleanextraArgs (optional)
This plugin invokes Signtool under the hood. Here you can specify extra custom CLI arguments to pass to Signtool.
These arguments will be appended to the Signtool CLI invocation. If they overlap with any arguments implicitly passed by this plugin, then Signtool will raise an error.
argument
Stringsha1 (optional)
The SHA-1 hash of the certificate (inside the TPP) to use for code signing.
Normally you should use 'Signing certificate subject name' instead, but if that name is ambiguous, then use the SHA-1 hash to select a specific signing certificate.
Either a subject name or SHA-1 hash of the signing certificate must be given.
StringsignToolPath (optional)
StringsignatureDigestAlgos (optional)
The digest algorithm(s) to use to creating signatures.
If none specified, 'sha256' is used as the default algorithm. This is very secure, but may not be compatible with older Windows versions. If you need compatibility with older Windows versions, you should specify 'sha1' and 'sha256' (in that order).
When multiple digest algorithms are specified, they are applied in the order specified.
algorithm
StringsubjectName (optional)
The Common Name ("Issued to" or "CN") of the certificate (inside the TPP) to use for code signing.
You can obtain a list of Common Names with 'cspconfig listcertificates' and checking what comes after 'CN='.
Either a subject name or SHA-1 hash of the signing certificate must be given.
StringtimestampingServers (optional)
Specifies one or more timestamping authority servers to use during signing. Specifying this is strongly recommended, because it allows signed files to be usable even after the original signing certificate has expired.
If you specify more than one server, then a random one will be used.
Tip: here are some public timestamping authorities that you can use:
address
StringuseMachineConfiguration (optional)
booleanvenafiClientToolsDir (optional)
C:\Program Files\Venafi CodeSign Protect.StringvenafiVerifyWithSignTooltppName
StringfileOrGlob
A path or a glob that specifies the file(s) to be verified.
StringsignToolPath (optional)
StringuseMachineConfiguration (optional)
booleanvenafiClientToolsDir (optional)
C:\Program Files\Venafi CodeSign Protect.String$class: 'SilkPerformerBuilder'projectLoc
Stringworkload
StringsuccessCriteria
userType
StringmeasureCategory
StringmeasureType
StringmeasureName
StringvalueType
StringoperatorType
StringchosenValue
StringSimplifyQAapi
Stringtoken
class hudson.util.Secret$class: 'SingleConditionalBuilder'buildStep
hudson.tasks.BuildStep)condition
$class: 'AlwaysRun'$class: 'And'conditions
condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'conditions
condition
$class: 'AlwaysRun'$class: 'And'$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'conditions
condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'condition
$class: 'AlwaysRun'$class: 'And'conditions
$class: 'BatchFileCondition'command
If you already have a batch file in SCM, you can just type in the path of that batch file (again relative to the workspace directory), and simply execute that.
String$class: 'BooleanCondition'token
String$class: 'CauseCondition'buildCause
StringexclusiveCause
boolean$class: 'DayCondition'useBuildTime
For long running builds, there can be a considerable difference between these two times.
booleandaySelector
$class: 'SelectDays'days
day
intselected
boolean$class: 'Weekday'$class: 'Weekend'$class: 'ExpressionCondition'expression
Stringlabel
String$class: 'ExtendedCauseCondition'condition
$class: 'UpstreamCauseCondition'projects
String$class: 'UserBuildCauseCondition'users
StringexclusiveCause
boolean$class: 'FileExistsCondition'file
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'FilesMatchCondition'includes
Stringexcludes
StringbaseDir
$class: 'ArtifactsDir'$class: 'JenkinsHome'$class: 'Workspace'$class: 'LegacyBuildstepCondition'condition
Stringinvert
boolean$class: 'NeverRun'$class: 'NodeCondition'allowedNodes
String$class: 'Not'$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'NumericalComparisonCondition'lhs
Stringrhs
Stringcomparator
$class: 'EqualTo'$class: 'GreaterThan'$class: 'GreaterThanOrEqualTo'$class: 'LessThan'$class: 'LessThanOrEqualTo'$class: 'NotEqualTo'$class: 'OntrackDSLRunCondition'ontrackScriptLocation
value
StringscriptPath
StringscriptText
Stringsandbox
booleaninjectEnvironment
BUILD_NUMBER) to bind as variables into the script.
For example, if you set this field to BUILD_NUMBER, you can access the BUILD_NUMBER value from the script using:
ontrack.branch('PRJ', '1.0').build("1.0-${BUILD_NUMBER}", '')
StringinjectProperties
You can define variables to inject into the script by using a property-like format.
For example, the following text:
BRANCH = 1.0
BUILD = ${VERSION}
would inject the corresponding BRANCH and BUILD variables in the script:
ontrack.branch('PRJ', BRANCH).build(VERSION, "Build ${VERSION}")
In the text:
name = value syntax# are ignored${VAR} are expanded using VAR from the current environment variables. StringontrackLog
boolean$class: 'Or'$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
String$class: 'ShellCondition'command
By default, the shell will be invoked with the "-ex" option. So all of the commands are printed before being executed, and the build is considered a failure if any of the commands exits with a non-zero exit code. Again, add the #!/bin/... line to change this behavior.
As a best practice, try not to put a long shell script in here. Instead, consider adding the shell script in SCM and simply call that shell script from Jenkins (via bash -ex myscript.sh or something like that), so that you can track changes in your shell script.
A non-zero exit value will be treated as a false value
String$class: 'StatusCondition'worstResult
StringbestResult
String$class: 'StringsMatchCondition'arg1
Stringarg2
StringignoreCase
boolean$class: 'TextFinderCondition'fileSet
Stringregexp
StringcheckConsoleOutput
boolean$class: 'TimeCondition'earliest
Stringlatest
StringuseBuildTime
For long running builds, there can be a considerable difference between these two times.
boolean$class: 'VariableExistsCondition'variableName
Stringrunner
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'skenaiorgId
StringappId
String$class: 'SkytapBuilder'action
$class: 'AddConfigurationToProjectStep'configurationID
StringconfigurationFile
StringprojectID
StringprojectName
String$class: 'AddTemplateToProjectStep'templateID
StringtemplateFile
StringprojectID
StringprojectName
String$class: 'ChangeConfigurationStateStep'configurationID
StringconfigurationFile
StringtargetRunState
StringhaltOnFailedShutdown
boolean$class: 'ChangeContainerStateStep'containerID
StringcontainerFile
StringtargetContainerAction
String$class: 'ChangeVMContainerHostStatus'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringcontainerHostStatus
String$class: 'ConnectToVPNTunnelStep'configurationID
StringconfigurationFile
StringconfigurationNetworkName
StringvpnID
String$class: 'CreateConfigurationStep'templateID
StringtemplateFile
StringconfigName
StringconfigFile
String$class: 'CreateContainerStep'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringcontainerRegistryName
StringrepositoryName
StringcontainerName
If no name is provided, the container will be named New_Container_[timestamp]
StringcontainerCommand
If no command is provided, will default to using the command in the image spec (if applicable).
StringexposeAllPorts
booleancontainerSaveFilename
String$class: 'CreatePublishURLStep'configurationID
StringconfigurationFile
StringurlSaveFilename
StringportalName
StringpermissionOption
Don't Publish: The Sharing Portal URL will not be available to the user in any way.
View Only: User can view the VM through the Sharing Portal URL. No mouse or keyboard control is allowed, and desktop resizing is disabled.
Use:User can view the VM through the Sharing Portal URL and interact with it using a mouse or keyboard. Desktop resizing is allowed.
Run, Suspend: User can view the VM through the Sharing Portal URL and interact with it using a mouse or keyboard. Desktop resizing is allowed, and the user can also run the machine if it is in a stopped or suspended state.
StringhasPassword
urlPassword
class hudson.util.Secret$class: 'CreatePublishedServiceStep'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringnetworkName
StringportNumber
StringpublishedServiceFile
String$class: 'CreateTemplateFromConfigurationStep'configurationID
StringconfigurationFile
StringtemplateName
StringtemplateDescription
StringtemplateSaveFilename
String$class: 'DeleteConfigurationStep'configurationID
StringconfigurationFile
String$class: 'DeleteContainerStep'containerID
StringcontainerFile
String$class: 'GetContainerMetaDataStep'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringcontainerName
StringcontainerDataFile
String$class: 'ListPublishedURLForConfigurationStep'configurationID
StringconfigurationFile
StringurlName
StringurlFile
String$class: 'ListVMPublishedServiceStep'configurationID
StringconfigurationFile
StringvmID
StringvmName
StringnetworkName
StringportNumber
StringpublishedServiceFile
String$class: 'MergeTemplateIntoConfigurationStep'configurationID
StringconfigurationFile
StringtemplateID
StringtemplateFile
StringconfigFile
String$class: 'NetworkConnectStep'sourceNetworkConfigurationID
StringtargetNetworkConfigurationID
StringsourceNetworkConfigurationFile
StringtargetNetworkConfigurationFile
StringsourceNetworkName
StringtargetNetworkName
String$class: 'SleepBuilder'time
long$class: 'SmartFrogBuilder'smartFrogName
StringdeployHost
Stringhosts
StringsfUserHome
StringsfUserHome2
StringsfUserHome3
StringsfUserHome4
StringsfOpts
StringbuilderId
StringuseAltIni
booleansfIni
StringsfScriptSource
$class: 'FileScriptSource'scriptName
StringscriptPath
String$class: 'StringScriptSource'scriptName
StringscriptContent
String$class: 'SnapshotBuilder'xStudioPath
StringxStudioLicensePath
StringvagrantBox
Stringoverwrite
booleanpreInstallScriptPath
StringpostSnapshotScriptPath
StringresourceDirectoryPath
Stringdependencies
StringsnapshotFilesToDelete
StringinstallScriptSettings
class org.jenkinsci.plugins.spoontrigger.SnapshotBuilder$InstallScriptSettingsstartupFileSettings
class org.jenkinsci.plugins.spoontrigger.SnapshotBuilder$StartupFileSettings$class: 'SnykStepBuilder'additionalArguments (optional)
Additional runtime arguments that will be used to invoke the Snyk CLI. See the Snyk CLI help page for more details.
Use the standalone double-dash -- to pass arguments to the build tool invoked by the Snyk CLI. For example:
-- -Pprofile -Dkey=value for Maven projects.-- --configuration runtime for Gradle projects.-- -Dkey=value for SBT projects.StringfailOnError (optional)
Whether the step should fail if Snyk fails to scan the project due to an error. Errors include scenarios like: failing to download Snyk's binaries, improper Jenkins setup, bad configuration and server errors.
booleanfailOnIssues (optional)
The "When issues are found" selection specifies if builds should be failed or continued based on issues found by Snyk.
The corresponding CLI option for severity parameter: --severity-threshold
booleanmonitorProjectOnBuild (optional)
Monitor the project on every build by taking a snapshot of its current dependencies on Snyk.io. Selecting this option will keep you notified about newly disclosed vulnerabilities and remediation options in the project.
booleanorganisation (optional)
The Snyk organisation in which this project should be tested and monitored. Leave empty to use your default organisation.
The corresponding CLI option for this parameter: --org
StringprojectName (optional)
A custom name for the Snyk project created for this Jenkins project on every build. Leave empty for the project's name to be detected in the manifest file.
The corresponding CLI option for this parameter: --project-name
Stringseverity (optional)
StringsnykInstallation (optional)
Ensures that the selected version of Snyk tools are installed. In addition, the Snyk tools will be added at the start of the PATH environment variable during builds.
If no Snyk installations have been defined in the Jenkins system config, then none of the above steps will take place.
StringsnykTokenId (optional)
This needs to be the ID of an existing "Snyk API Token" credential. The token will be used to authenticate with Snyk.
If you prefer to provide the Snyk API Token another way, such using alternative credential bindings, you'll need to provide a SNYK_TOKEN build environment variable.
StringtargetFile (optional)
The path to the manifest file to be used by Snyk. Leave empty for Snyk to auto-detect the manifest file in the project's root folder.
The corresponding CLI option for this parameter: --file
StringaddALMOctaneSonarQubeListenerpushCoverage (optional)
booleanpushVulnerabilities (optional)
booleanskipWebhookCreation (optional)
booleansonarServerUrl (optional)
StringsonarToken (optional)
String$class: 'SonarRunnerBuilder'additionalArguments (optional)
StringinstallationName (optional)
StringjavaOpts (optional)
Stringjdk (optional)
Stringproject (optional)
Stringproperties (optional)
StringsonarScannerName (optional)
Stringtask (optional)
String$class: 'SoundsBuildTask'afterDelayMs
StringsoundSource
selectedSound
Stringvalue
INTERNAL, URLsoundUrl
String$class: 'SparkNotifyBuilder'disable
booleanmessageType
StringroomList
rName
StringrId
StringmessageContent (optional)
StringcredentialsId (optional)
StringsplitsplitTask
StringsplitName
StringenvironmentName
StringworkspaceName
StringtrafficTypeName
StringsplitDefinitions
StringwhitelistKey
StringtreatmentName
StringsplitYAMLFile
StringspringBootselectedIDs (optional)
StringartifactId (optional)
Stringautocomplete (optional)
StringbootVersion (optional)
Stringdescription (optional)
StringgroupId (optional)
StringjavaVersion (optional)
Stringlanguage (optional)
Stringpackaging (optional)
StringprojectName (optional)
Stringtype (optional)
StringsseBuildalmServerName
StringalmProject
StringcredentialsId
StringclientType
StringalmDomain
StringrunType
StringalmEntityId
StringtimeslotDuration
StringcdaDetails (optional)
deploymentAction
StringdeployedEnvironmentName
StringdeprovisioningAction
Stringdescription (optional)
StringenvironmentConfigurationId (optional)
StringpostRunAction (optional)
StringstackroxapiToken (optional)
StringcaCertPEM (optional)
StringenableTLSVerification (optional)
booleanfailOnCriticalPluginError (optional)
booleanfailOnPolicyEvalFailure (optional)
booleanportalAddress (optional)
StringosfBuilderSuiteStandaloneSonarLintersourcePatterns (optional)
sourcePattern
StringexcludePatterns
excludePattern
StringreportPath (optional)
String$class: 'StartBox'cloud
Stringworkspace
Stringbox
Stringinstance
StringbuildStep
StringstartETConfigure and start a preconfigured ECU-TEST installation.
Pipeline usage
startET(String toolName) : void
startET(String toolName, String workspaceDir, String settingsDir, int timeout,
boolean debugMode, boolean keepInstance, boolean updateUserLibs) : void
ETInstance.start() : void
ETInstance.start(String workspaceDir, String settingsDir, int timeout,
boolean debugMode, boolean keepInstance, boolean updateUserLibs) : void
ETInstance.start(Map<String, Object> settings) : void
startET('ECU-TEST')
def instance = ET.installation('ECU-TEST')
startET installation: instance.installation, workspaceDir: 'C:\\Data'
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.start()
def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0'
instance.start workspaceDir: 'C:\\Data', settingsDir: 'C:\\Data', timeout: 120, debugMode: true, keepInstance: false, updateUserLibs: true
toolName
StringdebugMode (optional)
booleaninstallation (optional)
name
Stringhome
Stringproperties
? extends hudson.tools.ToolProperty<?>keepInstance (optional)
booleansettingsDir (optional)
Stringtimeout (optional)
StringupdateUserLibs (optional)
booleanworkspaceDir (optional)
String$class: 'StartGrid'url
StringcloudTestServerID
Stringname
StringtimeOut
intacmStartPipelineaioProject (optional)
Stringpipeline (optional)
Stringprogram (optional)
String$class: 'StartRSDB'url
StringcloudTestServerID
Stringname
StringtimeOut
intstartTSConfigure and start Tool-Server.
Pipeline usage
startTS(String toolName) : void
startTS(String toolName, String toolLibsIniPath, int tcpPort, int timeout, boolean keepInstance) : void
ETInstance.startTS() : void
ETInstance.startTS(String toolLibsIniPath, int tcpPort, int timeout, boolean keepInstance) : void
ETInstance.startTS(Map<String, Object> settings) : void
startTS('ECU-TEST')
def instance = ET.installation('ECU-TEST')
startTS installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.startTS()
def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0'
instance.startTS toolLibsIniPath: C:\\ToolLibs.ini, tcpPort: 5017, timeout: 60, keepInstance: false
toolName
Stringinstallation (optional)
name
Stringhome
Stringproperties
? extends hudson.tools.ToolProperty<?>keepInstance (optional)
booleantcpPort (optional)
Stringtimeout (optional)
StringtoolLibsIni (optional)
String$class: 'StartTestEnvironment'url
StringcloudTestServerID
Stringname
StringtimeOut
int$class: 'StopBox'cloud
Stringworkspace
Stringbox
Stringinstance
StringbuildStep
StringstopETShutdown ECU-TEST.
Pipelines usage:
stopET(String toolName) : void
stopET(String toolName, int timeout) : void
ETInstance.stop() : void
ETInstance.stop(int timeout) : void
ETInstance.stop(Map<String, Object> settings) : void
stopET('ECU-TEST')
def instance = ET.installation('ECU-TEST')
stopET installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.stop()
def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0'
instance.stop timeout: 60
toolName
Stringinstallation (optional)
name
Stringhome
Stringproperties
? extends hudson.tools.ToolProperty<?>timeout (optional)
String$class: 'StopGrid'url
StringcloudTestServerID
Stringname
String$class: 'StopRSDB'url
StringcloudTestServerID
Stringname
StringstopTSShutdown Tool-Server.
Pipelines usage:
stopTS(String toolName) : void
stopTS(String toolName, int timeout) : void
ETInstance.stopTS() : void
ETInstance.stopTS(int timeout) : void
ETInstance.stopTS(Map<String, Object> settings) : void
stopTS('ECU-TEST')
def instance = ET.installation('ECU-TEST')
stopTS installation: instance.installation
def instance = ET.newInstallation('ECU-TEST', 'C:\\Program Files\\ECU-TEST 8.0')
instance.stopTS()
def instance = ET.newInstallation toolName: 'ECU-TEST', installPath: C:\\Program Files\\ECU-TEST 8.0'
instance.stopTS timeout: 60
toolName
Stringinstallation (optional)
name
Stringhome
Stringproperties
? extends hudson.tools.ToolProperty<?>timeout (optional)
String$class: 'StopTestEnvironment'url
StringcloudTestServerID
Stringname
StringstrobeMeasurementconnectionId
StringcredentialsId
StringrequestType
StringjobName
Stringbody (optional)
Stringduration (optional)
Stringemailto (optional)
StringfinalAction (optional)
Stringheaders (optional)
Stringhlq (optional)
Stringlimit (optional)
Stringmethod (optional)
StringprofileName (optional)
Stringsamples (optional)
Stringtags (optional)
StringtransactionId (optional)
Stringurl (optional)
String$class: 'StudioToolsBuilder'name
Stringoperation
StringprojectDir
StringoutputArchiveFile
StringextendedClassPath
StringoverwriteOutput
booleanTRAPropertyFIle
StringtopazSubmitFreeFormJclconnectionId
StringcredentialsId
StringmaxConditionCode
Stringjcl
StringtopazSubmitJclMembersconnectionId
StringcredentialsId
StringmaxConditionCode
StringjclMember
String$class: 'SvChangeModeBuilder'serverName
Stringforce
booleanmode
OFFLINE, SIMULATING, STAND_BY, LEARNINGdataModel
selectionType
BY_NAME, NONE, DEFAULTdataModel
StringperformanceModel
selectionType
BY_NAME, NONE, OFFLINE, DEFAULTperformanceModel
StringserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
String$class: 'SvDeployBuilder'serverName
Stringforce
booleanservice
StringprojectPath
StringprojectPassword
StringfirstAgentFallback
boolean$class: 'SvExportBuilder'serverName
Stringforce
booleantargetDirectory
StringcleanTargetDirectory
booleanserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
StringswitchToStandByFirst
booleanarchive
boolean$class: 'SvUndeployBuilder'serverName
StringcontinueIfNotDeployed
booleanforce
booleanserviceSelection
selectionType
SERVICE, PROJECT, ALL_DEPLOYED, DEPLOYservice
StringprojectPath
StringprojectPassword
StringSWEAGLEExportactionName
StringmdsName
Stringargs (optional)
Stringexporter (optional)
StringfileLocation (optional)
Stringformat (optional)
StringmapToVariables (optional)
StringmarkFailed (optional)
booleanshowResults (optional)
booleantag (optional)
StringSWEAGLESnapshotactionName
StringmdsName
Stringdescription (optional)
StringmarkFailed (optional)
booleanshowResults (optional)
booleantag (optional)
StringSWEAGLEUploadactionName
StringfileLocation
Stringformat
StringnodePath
StringallowDelete (optional)
Allow Delete If checked will delete any nodes and MDIs that are not part of the upload. If the nodes are included or inherited the nodes and MDIs at points of inclusion will also be deleted unless "Only Parent" is also checked.
booleanautoRecognize (optional)
booleandescription (optional)
StringfilenameNodes (optional)
Create Filename Nodes If checked, nodes will be created for all matching files names in the file location and file data will be placed under file name node.
booleanidentifierWords (optional)
Identifier Words To make nodes part of an array uniquely identifiable, a comma separated list of 'identifier words' can be added. If no identifierWords are provided, the behavior will default to the identifierWords listed in the find.identity_attributes_discovery.word_list preference
StringmarkFailed (optional)
booleanonlyParent (optional)
Only Parent This controls if in case the allowDelete flag is set to true if the deletion of nodes and CDIs will only happen at the node itself, or also at any other place where the node is included or in every child node that is inheriting.
booleanshowResults (optional)
booleansubDirectories (optional)
Search Sub-directories If checked sub-directories will also be searched recursively for matching files.
booleantag (optional)
StringwithSnapshot (optional)
Allow Delete If checked will delete any nodes and MDIs that are not part of the upload. In case the nodes are included or inherited, also the nodes and MDIs at points of inclusion will be deleted
Only Parent If checked will delete any nodes and MDIs that are not part of the upload. In case the nodes are included or inherited, also the nodes and MDIs at points of inclusion will be deleted
Store Snapshot. This controls if automatically a snapshot should be created for each of the impacted config data sets by this data upload.
booleanSWEAGLEValidateactionName
StringmdsName
StringerrMax (optional)
intmarkFailed (optional)
booleannoPending (optional)
booleanretryCount (optional)
intretryInterval (optional)
intshowResults (optional)
booleanstored (optional)
booleanwarnMax (optional)
int$class: 'SyncBuilder'packageid
StringserverName
StringdbName
StringserverAuth
value
Stringusername
Stringpassword
class hudson.util.SecretencryptConnection
booleantrustServerCertificate
booleanoptions
StringdataOptions
Stringfilter
StringpackageVersion
StringisolationLevel
StringupdateScript
booleansqlChangeAutomationVersionOption
value
Latest, SpecificspecificVersion
String$class: 'SyncStepBuilder'packageId
Stringserver
Stringdatabase
StringauthenticationType
StringuserName
Stringpassword
class hudson.util.SecretcompareOptions (optional)
StringfilterFile (optional)
StringtransactionIsoLvl (optional)
String$class: 'SysdigBuilder'name
StringbailOnFail (optional)
booleanbailOnPluginFail (optional)
booleanengineCredentialsId (optional)
Stringengineurl (optional)
Stringengineverify (optional)
booleanforceScan (optional)
booleaninlineScanExtraParams (optional)
StringinlineScanning (optional)
booleanrunAsUser (optional)
String$class: 'SystemGroovy'Executes a system groovy script similarly to hudson_url/script. The script is always executed on master.
Predefined variables:
build
AbstractBuild.
launcher
Launcher.
listener
BuildListener.
out
PrintStream (listener.logger).
source
$class: 'FileSystemScriptSource'scriptFile
String$class: 'StringSystemScriptSource'script
script
Stringsandbox
booleanclasspath
path
Stringbindings (optional)
Define variable bindings (in the properties file format). Specified variables can be addressed from the script.
String$class: 'TATestRunRegistrationBuildStep'This step registers new test run with given category and sets the 'dtTestrunID' build variable.
category
Stringplatform
String$class: 'TagBuilder'changeLogFile (optional)
StringchangeLogParameters (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringinstallationName (optional)
Stringlabels (optional)
StringliquibasePropertiesPath (optional)
Stringpassword (optional)
StringresourceDirectories (optional)
Stringtag (optional)
Stringurl (optional)
Stringusername (optional)
Stringtanaguruname
Stringscenario
StringurlToAudit
StringurlTanaguruWebService
StringperformanceUnstableMark
intperformanceFailedMark
intproxy_uri
Stringproxy_username
Stringproxy_password
String$class: 'TattletaleBuilder'inputDirectory
StringoutputDirectory
Stringtestcompletetestsuite (optional)
StringaccessKeyId (optional)
StringactionOnErrors (optional)
StringactionOnWarnings (optional)
StringcommandLineArguments (optional)
StringcredentialsId (optional)
StringexecutorType (optional)
StringexecutorVersion (optional)
StringgenerateMHT (optional)
booleanlaunchConfig (optional)
project (optional)
Stringroutine (optional)
Stringtags (optional)
Stringtest (optional)
Stringunit (optional)
Stringvalue (optional)
StringlaunchType (optional)
Stringproject (optional)
StringpublishJUnitReports (optional)
booleanroutine (optional)
StringsessionScreenResolution (optional)
Stringtags (optional)
Stringtest (optional)
Stringtimeout (optional)
Stringunit (optional)
StringuseActiveSession (optional)
booleanuseTCService (optional)
booleanuseTimeout (optional)
booleanuserName (optional)
StringuserPassword (optional)
String$class: 'TelegramBotBuilder'message
String$class: 'TelerikAppBuilder'applicationId
StringaccessToken
class hudson.util.Secretconfiguration
StringbuildSettingsiOS
mobileProvisionIdentifieriOS
StringcodesigningIdentityiOS
StringbuildSettingsAndroid
codesigningIdentityAndroid
StringbuildSettingsWP
booleanprismaIaCassetName
StringtemplateType
StringtemplateVersion
Stringtags
StringfailureCriteriaHigh
StringfailureCriteriaLow
StringfailureCriteriaMedium
StringfailureCriteriaOperator
String$class: 'TerminateBox'cloud
Stringworkspace
Stringbox
Stringinstance
StringbuildStep
Stringdelete
booleancfyTerraformcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringdebugOutput (optional)
booleandeploymentId (optional)
ID to assign to the created Cloudify deployment. If not provided, one will be randomly generated. You can obtain the deployment ID from the "environment data" output file.
StringechoEnvData (optional)
If checked, then the created environment's data will be printed to the job's log.
booleanechoInputs (optional)
booleanenvDataLocation (optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
StringenvironmentVariables (optional)
java.util.Map<java.lang.String, java.lang.String>environmentVariablesAsString (optional)
YAML/JSON containing environment variables to pass to the Terraform process. The provided string will be expanded for environment variables (${VAR_NAME}).
StringenvironmentVariablesFile (optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing environment variables to pass to the Terraform process.
Stringexecutable (optional)
Path, on Cloudify Manager, of the Terraform executable. If omitted, the value of the terraform_executable Cloudify secret will be used.
StringpluginsDirectory (optional)
Path, on Cloudify Manager, of Terraform's plugins directory. If omitted, the value of the terraform_plugins_dir Cloudify secret will be used.
StringstorageDirectory (optional)
Path, on Cloudify Manager, of Terraform's storage directory. If omitted, the value of the terraform_storage_dir Cloudify secret will be used.
StringtemplateUrl (optional)
URL of the Terraform template. May be a ZIP, tar.gz, or a Git repository.
Stringtenant (optional)
Stringvariables (optional)
java.util.Map<java.lang.String, java.lang.Object>variablesAsString (optional)
YAML/JSON containing variables to pass to the Terraform template. The provided string will be expanded for environment variables (${VAR_NAME}).
StringvariablesFile (optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
StringdotnetTestdotnet test command is used to execute unit tests in a given solution. It builds the solution and runs a test host application for each test project in the solution. The test host executes tests in the given project using a test framework, for example: MSTest, NUnit, or xUnit, and reports the success or failure of each test. If all tests are successful, the test runner returns 0 as an exit code; otherwise if any test fails, it returns 1.
blame (optional)
TestResults/<Guid>/<Guid>_Sequence.xml that captures the order of tests that were run before the crash.
booleanblameCrash (optional)
--blame.
VSTEST_DUMP_FORCEPROCDUMP environment variable to 1.
booleanblameCrashCollectAlways (optional)
booleanblameCrashDumpType (optional)
--blame-crash.
StringblameHang (optional)
booleanblameHangDumpType (optional)
full, mini, or none. When none is specified, the test host is terminated on timeout, but no dump is collected. Implies --blame-hang.
StringblameHangTimeout (optional)
--blame and --blame-hang.
intcollect (optional)
Stringconfiguration (optional)
Debug, but you can override the build configuration settings in your project.
Stringdiag (optional)
*.host_<date>.txt for the test host log, and *.datacollector_<date>.txt for the data collector log.
Stringfilter (optional)
Stringframework (optional)
dotnet or a .NET Framework test host for the test binaries. This option only determines which type of host to use. The actual framework version to be used is determined by the runtimeconfig.json of the test project. When not specified, the TargetFramework assembly attribute is used to determine the type of host. When that attribute is stripped from the .dll, the .NET Framework host is used.
StringlistTests (optional)
booleanlogger (optional)
dotnet test doesn't accept abbreviations: instead of "console;v=d", use "console;verbosity=detailed".
StringnoBuild (optional)
booleannoRestore (optional)
booleannologo (optional)
booleanoption (optional)
Stringoptions (optional)
StringoptionsString (optional)
StringoutputDirectory (optional)
./bin/<configuration>/<framework>/. For projects with multiple target frameworks (via the TargetFrameworks property), you also need to specify a framework when you specify this option. dotnet test always runs tests from the output directory. You can use AppDomain.BaseDirectory to consume test assets in the output directory.
Stringproject (optional)
Stringproperties (optional)
java.util.Map<java.lang.String, java.lang.String>propertiesString (optional)
StringresultsDirectory (optional)
TestResults in the directory that contains the project file.
StringrunSettings (optional)
java.util.Map<java.lang.String, java.lang.String>runSettingsString (optional)
RunSettings values, specified in in Java properties syntax.
Stringruntime (optional)
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
Stringsettings (optional)
.runsettings file to use for running the tests. Note that the TargetPlatform element (x86|x64) has no effect for dotnet test. To run tests that target x86, install the x86 version of .NET Core. The bitness of the dotnet.exe that is on the path is what will be used for running tests.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleanshutDownBuildServers (optional)
dotnet build-server shutdown will be executed after the main command, shutting down build servers that may have been started.
hanguntil those server processes end. As such, it's recommended to specify this for the last .NET-related step in a job. If using multiple SDKs, each needs its own shutdown (e.g. the .NET Core 3.1 SDK will not shut down build servers from the .NET 5.0 SDK).
booleanspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleantestAdapterPath (optional)
.TestAdapter.dll are inspected. If not specified, the directory of the test .dll is searched.
StringunstableIfWarnings (optional)
booleanverbosity (optional)
StringworkDirectory (optional)
String$class: 'TestBuilder'packageid
StringtempServer
value
StringserverName
StringdbName
StringserverAuth
value
Stringusername
Stringpassword
class hudson.util.SecretencryptConnection
booleantrustServerCertificate
booleanrunTestSet
value
StringrunOnlyParams
StringgenerateTestData
sqlgenPath
Stringoptions
StringdataOptions
Stringfilter
StringpackageVersion
StringsqlChangeAutomationVersionOption
value
Latest, SpecificspecificVersion
StringtestSource
value
scaproject, socartifactprojectPath
Stringpackageid
StringpackageVersion
String$class: 'TestCompositionRunner'url
StringcloudTestServerID
Stringcomposition
StringdeleteOldResults
maxDaysOfResults
intadditionalOptions
Stringthresholds
transactionname
Stringthresholdname
Stringthresholdvalue
Stringthresholdid
StringgeneratePlotCSV
booleantestFoldertestFile
StringexecutionConfig (optional)
timeout
StringstopOnError
booleancheckTestFile
booleanrecordWarnings
booleanfailFast (optional)
booleanpackageConfig (optional)
runTest
booleanrunTraceAnalysis
booleanparameters
name
Stringvalue
StringoutputParameters
name
StringprojectConfig (optional)
execInCurrentPkgDir
booleanfilterExpression
StringjobExecMode
NO_EXECUTION, SEQUENTIAL_EXECUTION, PARALLEL_EXECUTION, SEPARATE_SEQUENTIAL_EXECUTION, SEPARATE_PARALLEL_EXECUTION, NO_TESTCASE_EXECUTION, TEST_GUIDE_EXECUTIONrecursiveScan (optional)
booleanscanMode (optional)
PACKAGES_ONLY, PROJECTS_ONLY, PACKAGES_AND_PROJECTStestConfig (optional)
tbcFile
StringtcfFile
StringforceReload
booleanloadOnly
booleankeepConfig
booleanconstants
name
Stringvalue
String$class: 'TestLinkBuilder'testLinkName
StringtestProjectName
StringtestPlanName
StringplatformName
StringbuildName
StringcustomFields
StringtestPlanCustomFields
StringexecutionStatusNotRun
booleanexecutionStatusPassed
booleanexecutionStatusFailed
booleanexecutionStatusBlocked
booleansingleBuildSteps
hudson.tasks.BuildStep)beforeIteratingAllTestCasesBuildSteps
hudson.tasks.BuildStep)iterativeBuildSteps
hudson.tasks.BuildStep)afterIteratingAllTestCasesBuildSteps
hudson.tasks.BuildStep)transactional
booleanfailedTestsMarkBuildAsFailure
booleanfailIfNoResults
booleanfailOnNotRun
booleanresultSeekers
$class: 'JUnitCaseClassNameResultSeeker'includePattern
StringkeyCustomField
StringattachJUnitXML
booleanincludeNotes
boolean$class: 'JUnitCaseNameResultSeeker'includePattern
StringkeyCustomField
StringattachJUnitXML
booleanincludeNotes
boolean$class: 'JUnitMethodNameResultSeeker'includePattern
StringkeyCustomField
StringattachJUnitXML
booleanincludeNotes
boolean$class: 'JUnitSuiteNameResultSeeker'includePattern
StringkeyCustomField
StringattachJUnitXML
booleanincludeNotes
boolean$class: 'TAPFileNameMultiTestPointsResultSeeker'includePattern
StringkeyCustomField
StringattachTAPStream
booleanattachYAMLishAttachments
booleanincludeNotes
booleancompareFullPath
booleantestpointsAsExecutions
boolean$class: 'TAPFileNameResultSeeker'includePattern
StringkeyCustomField
StringattachTAPStream
booleanattachYAMLishAttachments
booleanincludeNotes
booleancompareFullPath
boolean$class: 'TestNGClassNameResultSeeker'includePattern
StringkeyCustomField
StringattachTestNGXML
booleanmarkSkippedTestAsBlocked
booleanincludeNotes
boolean$class: 'TestNGMethodNameDataProviderNameResultSeeker'includePattern
StringkeyCustomField
StringattachTestNGXML
booleanmarkSkippedTestAsBlocked
booleandataProviderNameKeyCustomField
StringincludeNotes
boolean$class: 'TestNGMethodNameResultSeeker'includePattern
StringkeyCustomField
StringattachTestNGXML
booleanmarkSkippedTestAsBlocked
booleanincludeNotes
boolean$class: 'TestNGSuiteNameResultSeeker'includePattern
StringkeyCustomField
StringattachTestNGXML
booleanmarkSkippedTestAsBlocked
booleanincludeNotes
boolean$class: 'TestOdysseyBuilder'jobId
StringprojectId
StringminPassPercentage
StringtestPackagetestFile
StringexecutionConfig (optional)
timeout
StringstopOnError
booleancheckTestFile
booleanrecordWarnings
booleanpackageConfig (optional)
runTest
booleanrunTraceAnalysis
booleanparameters
name
Stringvalue
StringoutputParameters
name
StringtestConfig (optional)
tbcFile
StringtcfFile
StringforceReload
booleanloadOnly
booleankeepConfig
booleanconstants
name
Stringvalue
StringtestProjecttestFile
StringexecutionConfig (optional)
timeout
StringstopOnError
booleancheckTestFile
booleanrecordWarnings
booleanprojectConfig (optional)
execInCurrentPkgDir
booleanfilterExpression
StringjobExecMode
NO_EXECUTION, SEQUENTIAL_EXECUTION, PARALLEL_EXECUTION, SEPARATE_SEQUENTIAL_EXECUTION, SEPARATE_PARALLEL_EXECUTION, NO_TESTCASE_EXECUTION, TEST_GUIDE_EXECUTIONtestConfig (optional)
tbcFile
StringtcfFile
StringforceReload
booleanloadOnly
booleankeepConfig
booleanconstants
name
Stringvalue
String$class: 'TestRunner'stack
Stringbranch
StringtestNames
Stringundeploy
booleanapiKey
String$class: 'TestStepBuilder'packageId
StringserverType
Stringserver
Stringdatabase
StringauthenticationType
StringuserName
Stringpassword
class hudson.util.SecretrunTestMode
StringrunTests
StringcompareOptions (optional)
StringdgenFile (optional)
StringfilterFile (optional)
StringgenerateTestData (optional)
booleantransactionIsoLvl (optional)
String$class: 'TestStudioAPITestBuilder'apiRunnerPath (optional)
Stringproject (optional)
Stringtest (optional)
StringstartFrom (optional)
StringstopAfter (optional)
Stringvariable (optional)
StringdontSaveContexts (optional)
booleantestAsUnit (optional)
boolean$class: 'TestStudioTestBuilder'artOfTestRunnerPath
StringtestPath
StringsettingsPath
StringdateFormat
| Letter | Date or Time Component | Presentation | Examples |
|---|---|---|---|
| G | Era designator | Text | AD |
| y | Year | Year | 1996; 96 |
| Y | Week year | Year | 2009; 09 |
| M/L | Month in year | Month | July; Jul; 07 |
| w | Week in year | Number | 27 |
| W | Week in month | Number | 2 |
| D | Day in year | Number | 189 |
| d | Day in month | Number | 10 |
| F | Day of week in month | Number | 2 |
| E | Day in week | Text | Tuesday; Tue |
| u | Day number of week | Number | 1 |
| a | Am/pm marker | Text | PM |
| H | Hour in day (0-23) | Number | 0 |
| k | Hour in day (1-24) | Number | 24 |
| K | Hour in am/pm (0-11) | Number | 0 |
| h | Hour in am/pm (1-12) | Number | 12 |
| m | Minute in hour | Number | 30 |
| s | Second in minute | Number | 55 |
| S | Millisecond | Number | 978 |
| z | Time zone | General time zone | Pacific Standard Time; PST; GMT-08:00 |
| Z | Time zone | RFC 822 time zone | -0800 |
| X | Time zone | ISO 8601 time zone | -08; -0800; -08:00 |
| Input string | Pattern |
|---|---|
| 2001.07.04 AD at 12:08:56 PDT | yyyy.MM.dd G 'at' HH:mm:ss z |
| Wed, Jul 4, '01 | EEE, MMM d, ''yy |
| 12:08 PM | h:mm a |
| 12 o'clock PM, Pacific Daylight Time | hh 'o''clock' a, zzzz |
| 0:08 PM, PDT | K:mm a, z |
| 02001.July.04 AD 12:08 PM | yyyyy.MMMM.dd GGG hh:mm aaa |
| Wed, 4 Jul 2001 12:08:56 -0700 | EEE, d MMM yyyy HH:mm:ss Z |
| 010704120856-0700 | yyMMddHHmmssZ |
| 2001-07-04T12:08:56.235-0700 | yyyy-MM-dd'T'HH:mm:ss.SSSZ |
| 2001-07-04T12:08:56.235-07:00 | yyyy-MM-dd'T'HH:mm:ss.SSSXXX |
| 2001-W27-3 | YYYY-'W'ww-u |
StringprojectRoot (optional)
StringtestAsUnit (optional)
booleanoutputPath (optional)
String$class: 'TestSwarmBuilder'testswarmServerUrl
StringjobName
StringuserName
StringauthToken
StringmaxRuns
StringchooseBrowsers
StringpollingIntervalInSecs
StringtimeOutPeriodInMins
StringminimumPassing
StringtestSuiteList
testName
StringtestUrl
StringtestCacheCracker
booleandisableTest
booleantestweaverprojectPath
StringexperimentName
StringjUnitReportDirectory
StringacceptInconclusiveWatchers (optional)
booleanexportAsCsvDecimalSeparator (optional)
StringexportAsCsvDirectory (optional)
StringexportAsCsvNoQuote (optional)
booleanexportAsCsvQuote (optional)
StringexportAsCsvReports (optional)
StringexportAsCsvSeparator (optional)
StringhtmlReportDirectory (optional)
StringinstrumentView (optional)
booleannamespacePattern (optional)
StringparameterValues (optional)
StringrunScenarioLimit (optional)
intrunTimeLimit (optional)
longsilverParameters (optional)
String$class: 'TesteinRunBuilder'targetType
StringtargetId
StringdownloadReport
booleandownloadLogs
boolean$class: 'TesteinUploadStepBuilder'enableJs
jsFilePath
StringjsonFilePath
StringenableJar
jarFilePath
Stringoverwrite
boolean$class: 'TestingBotBuilder'name
String$class: 'TestiniumPlugin'projectId (optional)
intplanId (optional)
intabortOnError (optional)
booleanabortOnFailed (optional)
booleanfailOnTimeout (optional)
booleanignoreInactive (optional)
booleantimeoutSeconds (optional)
int$class: 'TestopiaBuilder'testopiaInstallationName
StringtestRunId
intsingleBuildSteps
hudson.tasks.BuildStep)beforeIteratingAllTestCasesBuildSteps
hudson.tasks.BuildStep)iterativeBuildSteps
hudson.tasks.BuildStep)afterIteratingAllTestCasesBuildSteps
hudson.tasks.BuildStep)failedTestsMarkBuildAsFailure
booleanresultSeekers
$class: 'JUnitCaseClassNameResultSeeker'includePattern
String$class: 'JUnitCaseNameResultSeeker'includePattern
String$class: 'JUnitMethodNameResultSeeker'includePattern
String$class: 'JUnitSuiteNameResultSeeker'includePattern
String$class: 'TAPFileNameResultSeeker'includePattern
String$class: 'TestNGClassNameResultSeeker'includePattern
StringmarkSkippedTestAsBlocked
boolean$class: 'TestNGMethodNameResultSeeker'includePattern
StringmarkSkippedTestAsBlocked
boolean$class: 'TestNGSuiteNameResultSeeker'includePattern
StringmarkSkippedTestAsBlocked
booleanconvertTestsToRun| Framework | Linux shell |
| Maven Surefire | mvn clean -Dtest=$testsToRunConverted test |
| Maven Failsafe | mvn clean -Dit.test=$testsToRunConverted verify |
| Gradle | gradle test $testsToRunConverted |
| Protractor | protractor conf.js --grep="$testsToRunConverted" |
| Cucumber-JVM over Maven/ BDD Scenario |
mvn clean -Dcucumber.options="$testsToRunConverted" test |
| JBehave over Maven | mvn clean -Dfeatures="$testsToRunConverted" test |
| Framework | Windows batch command |
| Maven Surefire | mvn clean -Dtest=%testsToRunConverted% test |
| Maven Failsafe | mvn clean -Dit.test=%testsToRunConverted% verify |
| Gradle | gradle test %testsToRunConverted% |
| Protractor | protractor conf.js --grep="%testsToRunConverted%" |
| Cucumber-JVM over Maven/ BDD Scenario |
mvn clean -Dcucumber.options="%testsToRunConverted%" test |
| JBehave over Maven | mvn clean -Dfeatures="%testsToRunConverted%" test |
| Framework | Pipeline script |
| Maven Surefire | bat 'mvn clean -Dtest=${params.testsToRunConverted} test' |
| Maven Failsafe | bat 'mvn clean -Dit.test=${params.testsToRunConverted} verify' |
| Gradle | bat 'gradle test ${params.testsToRunConverted}' |
| Protractor | bat(/protractor conf.js --grep="${params.testsToRunConverted}"/) |
| Cucumber-JVM over Maven/ BDD Scenario |
bat(/mvn clean -Dcucumber.options="${params.testsToRunConverted}" test/) |
| JBehave over Maven | bat(/mvn clean -Dfeatures="${testsToRunConverted}" test/) |
framework
Stringformat
{
"testPattern": "$package.$class#$testName",
"testDelimiter": ","
}
"replacements": [
{
"type": "replaceRegex",
"target": "$package|$class|$testName",
"regex": "aaa",
"replacement": "bbb",
"description": "Replaces all the sequence of characters matching the regex with a replacement string."
},{
"type": "replaceRegexFirst",
"target": "$package|$class|$testName",
"regex": "aaa",
"replacement": "bbb",
"description": "Replaces the first substring that matches the given regex with the given replacement. For example, given regex '@(.*)@.*' , replacement '$1', and test name '@myTag@ my test name' - will replace test name by the content located between @, that is - 'myTag'."
},{
"type": "replaceString",
"target": "$package|$class|$testName",
"string": "xxx",
"replacement": "yyy",
"description": "Replaces all occurrences of ‘string’ with ‘replacement’."
},{
"type": "joinString",
"target": "$package|$class|$testName",
"prefix": "xxx",
"suffix": "yyy",
"description": "Add prefix and suffix to the test template."
},{
"type": "toLowerCase",
"target": "$package|$class|$testName",
"description": "Convert test template to lower case."
},{
"type": "toUpperCase",
"target": "$package|$class|$testName",
"description": "Convert test template to upper case."
},{
"type": "notLatinAndDigitToOctal",
"target": "$package|$class|$testName",
"description": "Replaces all non-latin characters and digits ^[a-zA-Z0-9] to their ASCII octal value."
}]
String$class: 'TestsigmaExecutionBuilder'apiEndPoint
StringapiKey
StringtestPlanId
StringmaxWaitInMinutes
StringreportsFilePath
String$class: 'TicsAnalyzer'ticsPath
C:\Program Files (x86)\TIOBE\TICS\BuildServer. This directory should contain the TICSQServer and TICSMaintenance executables. You can leave this field empty if these executables can be found on the PATH environment variable of the Jenkins slave user.StringticsConfiguration
C:\Program Files (x86)\TIOBE\TICS\FileServer\cfg. The TICS configuration directory contains the SERVER.txt and PROJECTS.txt configuration files, among others. This setting sets the TICS environment variable before executing TICSQServer. You can leave this field empty if this variable is already set on the Jenkins slave.StringprojectName
TICSMaintenance from the command line. Note that you can use Jenkins environment variables such as $JOB_NAME here.StringbranchName
StringbranchDirectory
TICSMaintenance -branchdir. Note that you can use Jenkins variables (such as $WORKSPACE) here.StringenvironmentVariables
$WORKSPACE here. Example:
TICS_M2_OPTS=-s C:\Tools\apache-maven\conf\settings.xml TICS_COVERITY_URL=http://localhost:8080 QACBIN=C:/QAC/common/bin PATH=C:\Tools\bin;$PATH
StringcreateTmpdir
booleantmpdir
C:/temp/$JOB_NAME.StringextraArguments
Stringcalc
ABSTRACTINTERPRETATION
booleanACCUCHANGERATE
booleanACCUFIXRATE
booleanACCULINESADDED
booleanACCULINESCHANGED
booleanACCULINESDELETED
booleanALL
booleanAVGCYCLOMATICCOMPLEXITY
booleanBUILDRELATIONS
booleanCHANGEDFILES
booleanCHANGERATE
booleanCODINGSTANDARD
booleanCOMPILERWARNING
booleanDEADCODE
booleanDUPLICATEDCODE
booleanELOC
booleanFANOUT
booleanFINALIZE
booleanFIXRATE
booleanGLOC
booleanINCLUDERELATIONS
booleanINTEGRATIONTESTCOVERAGE
booleanLINESADDED
booleanLINESCHANGED
booleanLINESDELETED
booleanLOC
booleanMAXCYCLOMATICCOMPLEXITY
booleanPREPARE
booleanSECURITY
booleanSYSTEMTESTCOVERAGE
booleanTOTALTESTCOVERAGE
booleanUNITTESTCOVERAGE
booleanrecalc
ABSTRACTINTERPRETATION
booleanACCUCHANGERATE
booleanACCUFIXRATE
booleanACCULINESADDED
booleanACCULINESCHANGED
booleanACCULINESDELETED
booleanALL
booleanAVGCYCLOMATICCOMPLEXITY
booleanBUILDRELATIONS
booleanCHANGEDFILES
booleanCHANGERATE
booleanCODINGSTANDARD
booleanCOMPILERWARNING
booleanDEADCODE
booleanDUPLICATEDCODE
booleanELOC
booleanFANOUT
booleanFINALIZE
booleanFIXRATE
booleanGLOC
booleanINCLUDERELATIONS
booleanINTEGRATIONTESTCOVERAGE
booleanLINESADDED
booleanLINESCHANGED
booleanLINESDELETED
booleanLOC
booleanMAXCYCLOMATICCOMPLEXITY
booleanPREPARE
booleanSECURITY
booleanSYSTEMTESTCOVERAGE
booleanTOTALTESTCOVERAGE
booleanUNITTESTCOVERAGE
booleanrunTicsprojectName
StringbranchName
StringbranchDirectory (optional)
Stringcalc (optional)
StringenvironmentVariables (optional)
java.util.LinkedHashMap<java.lang.String, java.lang.String>extraArguments (optional)
Stringrecalc (optional)
StringticsBin (optional)
StringticsConfiguration (optional)
Stringtmpdir (optional)
StringtotaltestUTconnectionId
StringcredentialsId
StringprojectFolder
StringtestSuite
Wild carding of test scenarios/suites names can be done using '*' for any characters and '?' for a single character. 'All_Scenarios' can be used to run all test scenarios or 'All_Suites' can be used to run all test suites.
Stringjcl
StringccClearStats (optional)
booleanccDB2 (optional)
booleanccPgmType (optional)
StringccRepo (optional)
StringccSystem (optional)
StringccTestId (optional)
StringdeleteTemp (optional)
booleanhlq (optional)
StringhostPort (optional)
Stringrecursive (optional)
booleanuseStubs (optional)
booleantotaltestenvironmentId
StringfolderPath
StringserverUrl
StringserverCredentialsId
StringconnectionId
StringcredentialsId
StringsonarVersion (optional)
StringlogLevel (optional)
StringaccountInfo (optional)
Use the accounting information field to enter an account number and any other accounting information that your installation requires.
The accounting information must be entered, just as it would be on the job card. Currently only 52 characters are allowed for the accounting information.
StringccThreshold (optional)
intclearCodeCoverage (optional)
booleancollectCCRepository (optional)
StringcollectCCSystem (optional)
StringcollectCCTestID (optional)
StringcollectCodeCoverage (optional)
booleancompareJUnits (optional)
booleancontextVariables (optional)
StringcreateJUnitReport (optional)
booleancreateReport (optional)
booleancreateResult (optional)
booleancreateSonarReport (optional)
booleancustomerId (optional)
StringenterpriseDataHostPort (optional)
StringenterpriseDataWorkspace (optional)
StringhaltAtFailure (optional)
booleanhaltPipelineOnFailure (optional)
booleanjclPath (optional)
StringjsonFile (optional)
Use the JSON file field to enter a JSON file containing the tests to execute.
Note: This field is only used for Total Test CLI version 20.04.01 and later
StringlocalConfig (optional)
booleanlocalConfigLocation (optional)
StringprogramList (optional)
Use the Test list field to enter a comma separated list of program names to be tested. Will only include test scenarios that have component under test defined as one of these
Note: This field is only used for Total Test CLI version 20.04.01 and later
Stringrecursive (optional)
booleanreportFolder (optional)
StringselectEnvironmentRadio (optional)
StringselectProgramsOption (optional)
booleanselectProgramsRadio (optional)
StringsiteId (optional)
StringsourceFolder (optional)
StringstopIfTestFailsOrThresholdReached (optional)
booleanuploadToServer (optional)
booleanuseEnterpriseData (optional)
booleanuseScenarios (optional)
boolean$class: 'ToxBuilder'toxIni
Stringrecreate
booleantoxenvPattern
StringtptExecuteexePaths
StringexecutionConfiguration
tptFile
Stringconfiguration
Stringid
StringenableTest (optional)
booleanreportDir (optional)
StringtestSet (optional)
StringtestdataDir (optional)
Stringtimeout (optional)
longarguments (optional)
StringenableJunit (optional)
booleanisTptMaster (optional)
booleanjUnitLogLevel (optional)
NONE, ERROR, WARNING, INFO, ALLjUnitreport (optional)
StringslaveJob (optional)
StringslaveJobCount (optional)
StringslaveJobTries (optional)
StringtptBindingName (optional)
StringtptPort (optional)
StringtptStartUpWaitTime (optional)
StringtptAgentexePaths
StringtptBindingName (optional)
StringtptPort (optional)
StringtptStartUpWaitTime (optional)
StringtricentisCInewTricentisClientPath
StringnewEndpoint
StringconfigurationFilePath (optional)
Specify the path to the Tricentis CI test execution configuration XML file. The test configuration file includes more details about which items you would like to execute.
If you use this setting, leave the TestEvents setting of this page empty. Otherwise, this build step fails.
Stringendpoint (optional)
Specify the address of the webservice. This component triggers the test execution.
If you execute your tests via Tosca Remote Service, the endpoint needs to point to the TOSCARemoteExecutionService (e.g. http://servername:8732/TOSCARemoteExecutionService/).
If you execute your tests via Tosca Distributed Execution, the endpoint needs to point to the Manager Service of the Tosca Distribution Server (e.g. http://servername:8732/DistributionServerService/ManagerService.svc).
StringtestEvents (optional)
Input the TestEvents that you want to execute, separated by semicolons. You can identify the TestEvents with their name or their system ID.
This field is optional. It can only be used if you execute your tests via Tosca Distributed Execution.
If you use this setting, leave the Configuration File setting of this page empty. Otherwise, this build step fails.
StringtricentisClientPath (optional)
Specify the path to the Tricentis CI test execution configuration XML file. The test configuration file includes more details about which items you would like to execute.
If you use this setting, leave the TestEvents setting of this page empty. Otherwise, this build step fails.
String$class: 'TriggerBuilder'configs
projects
Stringblock
buildStepFailureThreshold
StringunstableThreshold
StringfailureThreshold
StringconfigFactories
$class: 'AllNodesBuildParameterFactory'$class: 'AllNodesForLabelBuildParameterFactory'name
StringnodeLabel
StringignoreOfflineNodes
boolean$class: 'BinaryFileParameterFactory'This implementation does not interpret the contents of those files, and instead it simply gets passed and placed into the workspace of the triggered project(s) under the name specified here.
This is useful, for example, when you have a portion of the job that can be split into concurrently executable subtasks. In such a situation, you can have an earlier step produce subtask work units by packaging necessary stuff into individual files, then use this mode to execute them all in parallel.
parameterName
StringfilePattern
StringnoFilesFoundAction
SKIP, NOPARMS, FAIL$class: 'CounterBuildParameterFactory'from
Stringto
Stringstep
StringparamExpr
StringvalidationFail
FAIL, SKIP, NOPARMS$class: 'CounterGeneratorParameterFactory'from
Stringto
Stringstep
StringparamExpr
StringvalidationFail
FAIL, SKIP, NOPARMS$class: 'FileBuildParameterFactory'filePattern
Stringencoding
StringnoFilesFoundAction
SKIP, NOPARMS, FAIL$class: 'FileGeneratorParameterFactory'filePattern
StringnoFilesFoundAction
SKIP, NOPARMS, FAIL$class: 'MultipleBinaryFileParameterFactory'parametersList
class org.jenkinsci.plugins.parallel_test_executor.MultipleBinaryFileParameterFactory$ParameterBindingnoFilesFoundAction
SKIP, NOPARMS, FAIL$class: 'NodeListBuildParameterFactory'name
StringnodeListString
Stringconfigs
$class: 'BooleanParameters'configs
name
Stringvalue
boolean$class: 'CurrentBuildParameters'$class: 'FileBuildParameters'propertiesFile
Stringencoding
StringfailTriggerOnMissing
booleanuseMatrixChild
booleancombinationFilter
StringonlyExactRuns
booleantextParamValueOnNewLine
boolean$class: 'GeneratorCurrentParameters'$class: 'GitRevisionBuildParameters'combineQueuedCommits
boolean$class: 'MatrixSubsetBuildParameters'filter
See the "Combination Filter" field in a matrix project configuration page for more details about the environment the script runs in, examples, and so on.
What you specify here gets expanded by variables of the triggering build, which allows you to dynamically control the subset of the triggered job. For example, if you trigger job BAR from FOO with label=="${TARGET}" in the filter, and if FOO defines the TARGET variable and FOO #1 sets TARGET to be linux, then the triggered BAR #3 will only select the subset of combinations where label=="linux" holds true.
Note that the variable expansion follows the ${varname} syntax used throughout in Jenkins, which collides with Groovy string inline expression syntax. However, Jenkins variable expansion leaves undefined variables as-is, so most of the time your Groovy string line expression syntax will survive the expansion, get passed to Groovy as-is, and work as expected. If you do need to escape '$', use '$$'.
String$class: 'NodeLabelBuildParameter'name
StringnodeLabel
String$class: 'NodeParameters'$class: 'PredefinedBuildParameters'properties
StringtextParamValueOnNewLine
boolean$class: 'PredefinedGeneratorParameters'properties
String$class: 'SubversionRevisionBuildParameters'includeUpstreamParameters
boolean$class: 'TwitterPublisher'tokenCredentialsID
StringconsumerCredentialsID
StringtweetText
StringUiPathAssetsassetsAction
AutoVersionCurrentVersionDeleteAssetsDeployAssetsDynamicallyjobsCount
intuser
Stringmachine
StringExternalAppaccountForApp
StringapplicationId
StringapplicationSecret
StringapplicationScope
StringCustomVersionversion
StringNonProductionRobotrobotsIds
StringTestTestProjecttestProjectPath
Stringenvironments
StringTestSettestSet
StringTokencredentialsId
StringaccountName
StringUnattendedUserPasscredentialsId
StringorchestratorAddress
StringorchestratorTenant
StringfolderName
Stringcredentials
AutoVersionCurrentVersionDeleteAssetsDeployAssetsDynamicallyjobsCount
intuser
Stringmachine
StringExternalAppaccountForApp
StringapplicationId
StringapplicationSecret
StringapplicationScope
StringCustomVersionversion
StringNonProductionRobotrobotsIds
StringTestTestProjecttestProjectPath
Stringenvironments
StringTestSettestSet
StringTokencredentialsId
StringaccountName
StringUnattendedUserPasscredentialsId
StringfilePath
StringtraceLevel
None, Critical, Error, Warning, Information, VerboseUiPathPackversion
AutoVersionCurrentVersionDeleteAssetsDeployAssetsDynamicallyjobsCount
intuser
Stringmachine
StringExternalAppaccountForApp
StringapplicationId
StringapplicationSecret
StringapplicationScope
StringCustomVersionversion
StringNonProductionRobotrobotsIds
StringTestTestProjecttestProjectPath
Stringenvironments
StringTestSettestSet
StringTokencredentialsId
StringaccountName
StringUnattendedUserPasscredentialsId
StringprojectJsonPath
StringoutputPath
StringtraceLevel
None, Critical, Error, Warning, Information, Verbosecredentials (optional)
AutoVersionCurrentVersionDeleteAssetsDeployAssetsDynamicallyjobsCount
intuser
Stringmachine
StringExternalAppaccountForApp
StringapplicationId
StringapplicationSecret
StringapplicationScope
StringCustomVersionversion
StringNonProductionRobotrobotsIds
StringTestTestProjecttestProjectPath
Stringenvironments
StringTestSettestSet
StringTokencredentialsId
StringaccountName
StringUnattendedUserPasscredentialsId
StringorchestratorAddress (optional)
StringorchestratorTenant (optional)
StringoutputType (optional)
StringrunWorkflowAnalysis (optional)
booleanuseOrchestrator (optional)
boolean$class: 'UnicornValidationBuilder'unicornUrl
StringsiteUrl
StringmaxErrorsForStable
StringmaxWarningsForStable
StringmaxErrorsForUnstable
StringmaxWarningsForUnstable
String$class: 'UninstallBuilder'packageId
StringfailOnUninstallFailure
boolean$class: 'Unity3dBuilder'For projects that use Unity3d as the build system.
This causes Jenkins to invoke the Unity3d Editor with the given command line arguments.
A non-zero exit code from Unity3d makes Jenkins mark the build as a failure.
unity3dName
StringargLine
-quit -batchmode -executeMethod YourEditorScript.YourBuildMethod [-nographics] or
-quit -batchmode -buildWindowsPlayer path/to/your/build.exe or
-quit -batchmode -buildOSXPlayer path/to/your/build.app
If this value isn't set, the globalArgLine is used.
Note: we make little to no attempt to detect conflicting arguments or arguments not suitable to the platform neither at configuration nor at runtime.
If the specified command line contains no -projectpath argument, the plugin automatically adds one with the proper parameter (the workspace of the project on the target machine). This is to make sure unity builds the proper project. Otherwise unity would reuse the last opened project. You can override it, but this hasn't been thoroughly tested.
If your build agent have multiple executors (which you should probably do), it is highly recommended to make use of a -logFile argument to avoid letting Unityed write to the standard editor.log concurrently. A recommended practise is to use something like -logFile "$WORKSPACE/unity3d_editor.log".
See the official Editor command line arguments documentation.
StringunstableReturnCodes
Stringunshelveshelf
Stringresolve
Stringtidy
booleanignoreEmpty
booleantpAppUpdateFileprojectId (optional)
StringappId (optional)
StringfilePath (optional)
StringtpAppUpdateURLprojectId (optional)
StringappId (optional)
StringapplicationUrl (optional)
String$class: 'UpdateBox'cloud
Stringworkspace
Stringbox
Stringvariables
StringtpDataSourceUpdateprojectId (optional)
StringdataSourceId (optional)
StringfilePath (optional)
StringazureVMSSUpdateInstancesazureCredentialsId
StringresourceGroup
Stringname
StringinstanceIds
,'.
String$class: 'UpdatePriority'prefix
Stringpriority
String$class: 'UpdateProjectBuilder'tpProjectParamUpdateprojectId (optional)
StringparameterId (optional)
StringparameterValue (optional)
String$class: 'UpdateReleaseStage'releasePrefix
Stringstage
String$class: 'UpdateStatus'prefix
Stringstatus
StringtpTestPackageUpdateprojectId (optional)
StringtestPackageId (optional)
StringfilePath (optional)
StringresolveConflicts (optional)
booleanupdraftPublishurl
Stringpath
String$class: 'UploadAppBuildStep'applicationLocation
StringkeystoreInfo
keystoreLocation
StringkeystorePassword
StringkeyAlias
StringkeyPassword
StringextraArguments
touchId
booleancamera
booleanallowResign
booleanuuid
StringuniqueName
String$class: 'UploadAppBuilder'mcServerName
StringmcUserName
StringmcPassword
StringmcTenantId
StringproxySettings
fsUseAuthentication
booleanfsProxyAddress
StringfsProxyUserName
StringfsProxyPassword
class hudson.util.SecretapplicationPaths
mcAppPath
StringuploadCloudifyBlueprintUse this step to upload a blueprint to Cloudify Manager.
Two paramters are mandatory:
In addition, exactly one of the following parameters is mandatory:
If you provide a blueprint's root directory, then the entire directory contents are packaged into a blueprint archive.
archivePath (optional)
StringarchiveUrl (optional)
StringblueprintId (optional)
StringcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringmainFileName (optional)
StringrootDirectory (optional)
Stringtenant (optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
String$class: 'UploadBuild'tenantId
Stringid
Stringname
StringversionName
Stringrevision
Stringrequestor
Stringstatus
StringstartTime
StringendTime
StringappName
StringappId
StringappExtId
Stringdebug
booleanfatal
booleanupload-pgyeruKey
StringapiKey
StringscanDir
Stringwildcard
StringinstallType
Stringpassword
StringupdateDescription
StringchannelShortcut
StringqrcodePath
StringenvVarsPath
Stringupload-pgyer-v2apiKey
StringscanDir
Stringwildcard
StringbuildName
StringbuildInstallType
StringbuildPassword
StringbuildUpdateDescription
StringbuildChannelShortcut
StringqrcodePath
StringenvVarsPath
String$class: 'UploadDeployment'id
StringtenantId
Stringname
Stringresult
Stringinitiator
StringversionName
StringversionExtId
Stringtype
StringenvironmentId
StringenvironmentName
Stringdescription
StringstartTime
StringendTime
StringappName
StringappId
StringappExtId
Stringdebug
booleanfatal
boolean$class: 'UploadJUnitTestResult'properties
java.util.Map<java.lang.String, java.lang.String>$class: 'UploadMetricsFile'tenantId
Stringname
StringfilePath
StringtestSetName
Stringenvironment
StringcombineTestSuites
booleanfatal
booleandebug
booleanpluginType
StringdataFormat
StringrecordName
StringmetricDefinitionId
StringmetricsRecordUrl
Stringdescription
StringexecutionDate
StringbuildId
StringbuildUrl
StringappId
StringappName
StringappExtId
StringuploadProgetPackagefeedName
StringgroupName
A string of no more than fifty characters:
StringpackageName
A string of no more than fifty characters:
Stringversion
Stringartifacts
Removing Unwanted Folders
Top level folders can be excluded from the package using a custom addition to the Ant fileset - wrapping unwanted folder names in square brackets ([ ]):
StringcaseSensitive (optional)
org.apache.tools.ant.DirectoryScanner which by default is case sensitive. For instance, if the job produces *.hpi files, pattern "**/*.HPI" will fail to find them.
booleandefaultExcludes (optional)
booleandependencies (optional)
Stringdescription (optional)
Stringexcludes (optional)
Stringicon (optional)
Stringmetadata (optional)
If you need to add additional metadata, it's strongly recommended that you prefix these properties with an underscore (_) on the off-chance that a property you add will exist in a future version of the specification.
Stringtitle (optional)
A string of no more than fifty characters
StringuploadCloudifyBlueprintcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringoutputLocation (optional)
Stringtenant (optional)
Cloudify tenant to operate on. If left empty, then the default tenant (defined in the plugin's configuration page) will be used.
StringwagonLocation (optional)
StringyamlLocation (optional)
plugin.yaml file of the plugin.
String$class: 'UpmergeBuilder'commitUsername
StringuTesterUrlListTaskinitialUrl
StringurlsWhiteList
StringrulesList
rule
StringcomplianceMinimum
floatallowSimultaneousLogins
booleanloginFlowJson
StringuseRunner
booleanfetchResponseTimeout
intuseMangouseSlaveNodes
StringnodeLabel
StringprojectId
Stringtags
StringtestName
StringtestStatus
StringassignedTo
Stringvb6projectFile
StringcompileConstants (optional)
StringoutDir (optional)
StringvCommanderaction
$class: 'VCommanderRequestNewServiceAction'payload
Stringsync
booleantimeout
longpolling
long$class: 'VCommanderRunWorkflowAction'targetType
StringtargetName
StringworkflowName
Stringsync
booleantimeout
longpolling
long$class: 'VCommanderWaitForRequestNewServiceAction'requestId
Stringtimeout
longpolling
long$class: 'VCommanderWaitForRunWorkflowAction'taskId
Stringtimeout
longpolling
long$class: 'VMGRAPI'vAPIUrl
StringvAPIUser
StringvAPIPassword
StringvAPIInput
StringvJsonInputFile
StringdeleteInputFile
booleanauthRequired
booleanapiType
StringdynamicUserId
booleanapiUrl
StringrequestMethod
StringadvConfig
booleanconnTimeout
intreadTimeout
int$class: 'VMGRLaunch'vAPIUrl
StringvAPIUser
StringvAPIPassword
StringvSIFName
StringvSIFInputFile
StringcredentialInputFile
StringdeleteInputFile
booleandeleteCredentialInputFile
booleanuseUserOnFarm
booleanauthRequired
booleanvsifType
StringuserFarmType
StringdynamicUserId
booleanadvConfig
booleanconnTimeout
intreadTimeout
intenvVarible
booleanenvVaribleFile
StringinaccessibleResolver
StringstoppedResolver
StringfailedResolver
StringdoneResolver
StringsuspendedResolver
StringwaitTillSessionEnds
booleanstepSessionTimeout
intgenerateJUnitXML
booleanextraAttributesForFailures
booleanstaticAttributeList
StringmarkBuildAsFailedIfAllRunFailed
booleanfailJobIfAllRunFailed
booleanenvSourceInputFile
StringvMGRBuildArchive
booleandeleteAlsoSessionDirectory
booleangenericCredentialForSessionDelete
booleanarchiveUser
StringarchivePassword
StringfamMode
StringfamModeLocation
StringnoAppendSeed
booleanmarkBuildAsPassedIfAllRunPassed
booleanfailJobUnlessAllRunPassed
booleanuserPrivateSSHKey
booleanattrValues
booleanattrValuesFile
StringexecutionType
StringsessionsInputFile
StringdeleteSessionInputFile
booleanenvVariableType
StringenvVariableText
StringattrVariableType
StringattrVariableText
StringpauseSessionOnBuildInterruption
booleanenvSourceInputFileType
StringexecutionScript
StringexecutionShellLocation
StringexecutionVsifFile
StringdefineVaribleFile
StringdefineVarible
booleandefineVariableType
StringdefineVariableText
String$class: 'VSphereBuildStepContainer'buildStep
$class: 'Clone'sourceName
Stringclone
StringlinkedClone
booleanresourcePool
Stringcluster
Stringdatastore
Stringfolder
StringpowerOn
booleantimeoutInSeconds
intcustomizationSpec
String$class: 'ConvertToTemplate'vm
Stringforce
boolean$class: 'ConvertToVm'template
StringresourcePool
Stringcluster
String$class: 'Delete'vm
StringfailOnNoExist
boolean$class: 'DeleteSnapshot'vm
StringsnapshotName
Stringconsolidate
booleanfailOnNoExist
boolean$class: 'Deploy'template
Stringclone
StringlinkedClone
booleanresourcePool
Stringcluster
Stringdatastore
Stringfolder
StringcustomizationSpec
StringtimeoutInSeconds
intpowerOn
boolean$class: 'ExposeGuestInfo'vm
StringenvVariablePrefix
StringwaitForIp4
boolean$class: 'PowerOff'vm
StringevenIfSuspended
booleanshutdownGracefully
booleanignoreIfNotExists
booleangracefulShutdownTimeout (optional)
int$class: 'PowerOn'vm
StringtimeoutInSeconds
int$class: 'Reconfigure'vm
StringreconfigureSteps
$class: 'ReconfigureAnnotation'annotation (optional)
Stringappend (optional)
boolean$class: 'ReconfigureCpu'cpuCores
StringcoresPerSocket
String$class: 'ReconfigureDisk'diskSize
Stringdatastore
String$class: 'ReconfigureMemory'memorySize
String$class: 'ReconfigureNetworkAdapters'deviceAction
ADD, EDIT, REMOVEdeviceLabel
StringmacAddress
StringstandardSwitch
booleanportGroup
StringdistributedSwitch
booleandistributedPortGroup
StringdistributedPortId
String$class: 'Rename'oldName
StringnewName
String$class: 'RenameSnapshot'vm
StringoldName
StringnewName
StringnewDescription
String$class: 'RevertToSnapshot'vm
StringsnapshotName
String$class: 'SuspendVm'vm
String$class: 'TakeSnapshot'vm
StringsnapshotName
Stringdescription
StringincludeMemory
booleanserverName
String$class: 'VaddyPlugin'host
StringuserId
StringauthKey
StringcrawlId
StringapiServerUrl
StringproxyHost
StringproxyPort
String$class: 'VagrantDestroyCommand'vagrantFile
StringvagrantVm
String$class: 'VagrantProvisionCommand'vagrantFile
StringvagrantVm
Stringprovisioners
Stringparallel
boolean$class: 'VagrantSshCommand'vagrantFile
StringvagrantVm
Stringcommand
StringasRoot
boolean$class: 'VagrantUpCommand'vagrantFile
StringvagrantVm
StringdestroyOnError
booleanprovider
StringdontKillMe
boolean$class: 'ValgrindBuilder'valgrindExecutable
StringworkingDirectory
StringincludePattern
StringexcludePattern
StringoutputDirectory
StringoutputFileEnding
StringprogramOptions
Stringtool
$class: 'ValgrindToolHelgrind'historyLevel
String$class: 'ValgrindToolMemcheck'showReachable
booleanundefinedValueErrors
booleanleakCheckLevel
StringtrackOrigins
booleanvalgrindOptions
StringignoreExitCode
booleantraceChildren
booleanchildSilentAfterFork
booleangenerateSuppressions
booleansuppressionFiles
StringremoveOldReports
booleancrxValidatepackageIdFilters (optional)
**/*.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 validated in the order in which the filters are specified. At least one package must match each filter or the step will fail.
StringallowNonCoveredRoots (optional)
booleanforbiddenACHandlingModeSet (optional)
StringforbiddenExtensions (optional)
.jar
.zip
This field supports parameter tokens.
StringforbiddenFilterRootPrefixes (optional)
/apps/system
/apps/system/config
/apps/systemOfADown/config
StringlocalDirectory (optional)
StringpathsDeniedForInclusion (optional)
/apps/system/rep:policy
/etc/map/http/site_root_redirect
Use this test to safeguard specific paths or possible paths within unrestricted roots from overly broad workspace filters.
StringvalidationFilter (optional)
/etc # define /etc as the filter root
-/etc/packages(/.)? # exclude package paths
This field supports parameter tokens.
String$class: 'Validator'stack
Stringbranch
StringapiKey
StringcontentReplaceconfigs (optional)
filePath
StringfileEncoding
StringvariablesPrefix
StringvariablesSuffix
StringemptyValue
Stringconfigs
name
Stringvalue
String$class: 'VectorCASTCommand'winCommand
StringunixCommand
String$class: 'VectorCASTSetup'environmentSetupWin
StringenvironmentSetupUnix
StringexecutePreambleWin
StringexecutePreambleUnix
StringenvironmentTeardownWin
StringenvironmentTeardownUnix
StringoptionUseReporting
booleanoptionErrorLevel
StringoptionHtmlBuildDesc
StringoptionExecutionReport
booleanoptionClean
booleanwaitLoops
longwaitTime
longmanageProjectName
StringjobName
StringnodeLabel
String$class: 'ViberNotifier'token (optional)
Stringsender (optional)
Stringmessage (optional)
String$class: 'ViewCloner'url
StringreplacePatternString
StringniewViewName
Stringpassword
Stringusername
String$class: 'VirtualenvBuilder'pythonName
Stringhome
Stringclear
booleansystemSitePackages
booleannature
Stringcommand
StringignoreExitCode
booleanvisualexpertinstallPath
StringprojectName
StringdoAnalysis
booleancreateReferenceDocument
booleancreateCodeReviewDocument
boolean$class: 'VsCodeMetricsBuilder'toolName
Stringfiles
Assembly file(s) to analyze.
You can specify multiple analyze assemblies by separating them with new-line or space.
Command Line Argument: /file:[ assembly file path ]
StringoutputXML
Metrics results XML output file.
Command Line Argument: /out:[ output file path ]
Stringdirectory
Location to search for assembly dependencies.
You can specify multiple directories by separating them with new-line or space.
Command Line Argument: /directory:[ directory ]
StringsearchGac
Search the Global Assembly Cache for missing references.
Command Line Argument: /searchgac
booleanplatform
Location of framework assemblies, such as mscorlib.dll.
Command Line Argument: /platform:[ directory ]
Stringreference
Reference assemblies required for analysis.
You can specify multiple reference assemblies by separating them with new-line or space.
Command Line Argument: /reference:[ assembly file path ]
StringignoreInvalidTargets
Silently ignore invalid target files.
Command Line Argument: /ignoreinvalidtargets
booleanignoreGeneratedCode
Suppress analysis results against generated code.
Command Line Argument: /ignoregeneratedcode
booleancmdLineArgs
StringfailBuild
booleanvsTestcmdLineArgs (optional)
Stringenablecodecoverage (optional)
Enables data diagnostic adapter CodeCoverage in the test run.
Default settings are used if not specified using settings file.
Command Line Argument: /Enablecodecoverage
booleanfailBuild (optional)
booleanframework (optional)
Target .NET Framework version to be used for test execution.
Valid values are Framework35, Framework40 and Framework45.
Command Line Argument: /Framework: [ framework version ]
StringinIsolation (optional)
Runs the tests in an isolated process.
This makes vstest.console.exe process less likely to be stopped on an error in the tests, but tests might run slower.
booleanlogger (optional)
Specify a logger for test results. For example, to log results into a Visual Studio Test Results File (TRX) use /Logger:trx.
Command Line Argument: /Logger:[ uri/friendlyname ]
Stringplatform (optional)
Target platform architecture to be used for test execution.
Valid values are x86, x64 and ARM.
Stringsettings (optional)
Run tests with additional settings such as data collectors.
Example: Local.RunSettings
Command Line Argument: /Settings:[ file name ]
StringtestCaseFilter (optional)
Run tests that match the given expression.
<Expression> is of the format <property>=<value>[||<Expression>].
Example: TestCategory=Nightly||Name=Namespace.ClassName.MethodName
The TestCaseFilter command line option cannot be used with the Tests command line option.
Command Line Argument: /TestCaseFilter:[ expression ]
StringtestFiles (optional)
Specify the path to your VSTest compiled assemblies.
You can specify multiple test assemblies by separating them with new-line or space.
Stringtests (optional)
Run tests with names that match the provided values.
To provide multiple values, separate them by commas.
Example: TestMethod1,testMethod2
The /Tests command line option cannot be used with the /TestCaseFilter command line option.
Command Line Argument: /Tests:[ test name ]
StringuseVs2017Plus (optional)
This makes adjustments to the arguments for the sake of compatibility with Visual Studio 2017+.
Command Line Argument: /UseVs2017Plus:true
booleanuseVsixExtensions (optional)
This makes vstest.console.exe process use or skip the VSIX extensions installed (if any) in the test run.
Command Line Argument: /UseVsixExtensions:true
booleanvsTestName (optional)
String$class: 'WASBuildStep'additionalClasspath
StringappendTrace
booleancommands
StringjavaOptions
StringjobId
Stringlanguage
StringprofileScriptFiles
StringpropertiesFiles
StringrunIf
true.StringscriptFile
StringscriptParameters
StringtraceFile
StringwasServerName
Stringuser
Stringpassword
StringgreetprojectId
StringappPath
StringscriptPath
StringgroupId
Stringtimeout
The timeout of this test run.The default value is 60 minutes.
StringframeType
StringcaseTimeout
The timeout of each device running in your test.The default value is 10 minutes.
StringtargetOsType
String$class: 'WakeUpIOSDevice'url
StringcloudTestServerID
StringadditionalOptions
String$class: 'WallarmFastBuilder'appHost
StringappPort
StringfastPort
StringfastName
StringpolicyId
inttestRecordId
intwallarmApiHost
StringtestRunName
StringtestRunDesc
Stringrecord
booleanstopOnFirstFail
booleanfailBuild
booleanwithoutSudo
booleanlocalDockerNetwork
StringlocalDockerIp
StringwallarmVersion
StringfileExtensionsToExclude
StringinactivityTimeout
inttestRunRps
intwallarmApiToken (optional)
String$class: 'WarriorPluginBuilder'configType
StringgitConfigUrl
StringgitConfigCredentials
booleangitConfigTagValue
StringgitConfigCloneType
StringgitConfigUname
StringgitConfigPwd
StringgitConfigFile
StringsftpConfigIp
StringsftpConfigUname
StringsftpConfigPwd
StringsftpConfigFile
StringpythonPath
StringuploadExecLog
booleanuploadServerIp
StringuploadServerUname
StringuploadServerPwd
StringuploadServerType
StringuploadServerDir
StringrunFiles
runFile
Stringwattspeedtoken
class hudson.util.Secretprojects
int$class: 'WebLoadAnalyticsBuilder'inputLsFile
StringportfolioFile
Stringformat
JUNIT, HTML, DOC, ODT, XLS, XLSX, RTF, PDF, CSV, RAWlocation
StringreportName
StringcompareToSessions
StringcompareToPreviousBuilds
int$class: 'WebLoadConsoleBuilder'tplFile
StringlsFile
StringexecutionDuration
longvirtualClients
longprobindClient
long$class: 'WildflyBuilder'war
Stringhost
Stringport
Stringusername
Stringpassword
Stringserver
String$class: 'WinBatchBuildStep'buildStepId
StringdefineArgs
booleanbuildStepArgs
arg
String$class: 'WinDocksBuilder'ipaddress
Stringimage
StringwinRMClienthostName
StringcredentialsId
StringwinRMOperations
invokeCommandcommand
StringsendFilesource
Stringdestination
StringconfigurationName
String$class: 'WixToolsetBuilder'sources
StringmarkAsUnstable
booleancompileOnly
booleanuseUiExt
booleanuseUtilExt
booleanuseBalExt
booleanuseComPlusExt
booleanuseDependencyExt
booleanuseDifxAppExt
booleanuseDirectXExt
booleanuseFirewallExt
booleanuseGamingExt
booleanuseIISExt
booleanuseMsmqExt
booleanuseNetfxExt
booleanusePsExt
booleanuseSqlExt
booleanuseTagExt
booleanuseVsExt
booleanmsiOutput
Enter a name for the generated MSI/EXE package. If left blank, the MSI package is named setup.msi. You can also use the file ending *.exe. But keep in mind, that you have to create a Bootstrapper and activeate the BalExtension to create an Executable.
You can use environment variables like $GIT_BRANCH to define a package name.
Stringarch
String$class: 'WsapBuilder'wsapLocation
StringenvVar
StringcredentialsId
StringtargetUrl
StringipAddress
Stringport
intapiKey
StringsastAnalysis
target
StringdastAnalysis
scanMethod
scan
StringapiUrl
StringapiDefinition
StringincludeUrls
$class: 'DASTAnalysis'$class: 'ExcludeEntry'url
String$class: 'HeaderEntry'header
Stringvalue
String$class: 'IncludeEntry'url
String$class: 'LoginProperties'useLogin
booleanloginUrl
StringrequestJson
StringusernameField
StringpasswordField
StringloggedInRegex
StringloggedOutRegex
Stringheaders
$class: 'DASTAnalysis'$class: 'ExcludeEntry'url
String$class: 'HeaderEntry'header
Stringvalue
String$class: 'IncludeEntry'url
String$class: 'LoginProperties'$class: 'SASTAnalysis'target
String$class: 'ScanMethod'scan
StringapiUrl
StringapiDefinition
String$class: 'UserEntry'username
Stringpassword
Stringusers
$class: 'DASTAnalysis'$class: 'ExcludeEntry'url
String$class: 'HeaderEntry'header
Stringvalue
String$class: 'IncludeEntry'url
String$class: 'LoginProperties'$class: 'SASTAnalysis'target
String$class: 'ScanMethod'scan
StringapiUrl
StringapiDefinition
String$class: 'UserEntry'username
Stringpassword
String$class: 'SASTAnalysis'target
String$class: 'ScanMethod'scan
StringapiUrl
StringapiDefinition
String$class: 'UserEntry'username
Stringpassword
StringexcludeUrls
$class: 'DASTAnalysis'$class: 'ExcludeEntry'url
String$class: 'HeaderEntry'header
Stringvalue
String$class: 'IncludeEntry'url
String$class: 'LoginProperties'useLogin
booleanloginUrl
StringrequestJson
StringusernameField
StringpasswordField
StringloggedInRegex
StringloggedOutRegex
Stringheaders
$class: 'DASTAnalysis'$class: 'ExcludeEntry'url
String$class: 'HeaderEntry'header
Stringvalue
String$class: 'IncludeEntry'url
String$class: 'LoginProperties'$class: 'SASTAnalysis'target
String$class: 'ScanMethod'scan
StringapiUrl
StringapiDefinition
String$class: 'UserEntry'username
Stringpassword
Stringusers
$class: 'DASTAnalysis'$class: 'ExcludeEntry'url
String$class: 'HeaderEntry'header
Stringvalue
String$class: 'IncludeEntry'url
String$class: 'LoginProperties'$class: 'SASTAnalysis'target
String$class: 'ScanMethod'scan
StringapiUrl
StringapiDefinition
String$class: 'UserEntry'username
Stringpassword
String$class: 'SASTAnalysis'target
String$class: 'ScanMethod'scan
StringapiUrl
StringapiDefinition
String$class: 'UserEntry'username
Stringpassword
StringloginProperties
useLogin
booleanloginUrl
StringrequestJson
StringusernameField
StringpasswordField
StringloggedInRegex
StringloggedOutRegex
Stringheaders
$class: 'DASTAnalysis'$class: 'ExcludeEntry'url
String$class: 'HeaderEntry'header
Stringvalue
String$class: 'IncludeEntry'url
String$class: 'LoginProperties'$class: 'SASTAnalysis'target
String$class: 'ScanMethod'scan
StringapiUrl
StringapiDefinition
String$class: 'UserEntry'username
Stringpassword
Stringusers
$class: 'DASTAnalysis'$class: 'ExcludeEntry'url
String$class: 'HeaderEntry'header
Stringvalue
String$class: 'IncludeEntry'url
String$class: 'LoginProperties'$class: 'SASTAnalysis'target
String$class: 'ScanMethod'scan
StringapiUrl
StringapiDefinition
String$class: 'UserEntry'username
Stringpassword
StringxcodeBuildallowFailingBuildResults (optional)
Checking this option will prevent a build step from failing if xcodebuild exits with a non-zero return code.
This can be useful for build steps that run unit tests and also have a post-build task to publish unit test results: the test step will not fail the entire build for a failing unit test, but will instead mark the build unstable in the "publish test" phase.
booleanappURL (optional)
StringassetPackManifestURL (optional)
StringassetPacksBaseURL (optional)
StringassetPacksInBundle (optional)
booleanbuildDir (optional)
The value to use for the BUILD_DIR setting. You only need to supply this value if you want the product of the Xcode build to be in a location other than the one specified in project settings and this job 'SYMROOT' parameter.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/build
StringbuildIpa (optional)
Checking this option will create a .ipa for each .app found in the build directory.
An .ipa is basically a zipped up .app.
This is quite handy for distributing ad-hoc builds to testers as they can just double-click the .ipa and it will import into iTunes.
booleanbundleID (optional)
The new bundle ID. Usually something like com.companyname.projectname.
StringbundleIDInfoPlistPath (optional)
The path to the info.plist file which contains the CFBundleIdentifier of your project.
Usually something like:
StringcfBundleShortVersionStringValue (optional)
This will set the CFBundleShortVersionString to the specified string.
Supports all macros and also environment and build variables from the Token Macro Plugin.
StringcfBundleVersionValue (optional)
This will set the CFBundleVersion to the specified string.
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example the value ${BUILD_NUMBER} will be replaced with the current build number.
We advice you to generate a unique value for each build if you want for example deploy it into a private store.
In that case, for example, you can use : ${JOB_NAME}-${BUILD_NUMBER}
StringchangeBundleID (optional)
Checking this option will replace the bundle identifier.
You will need to specify which bundle ID (CFBundleIdentifier) to use and where is the Info.plist file located.
This is handy for example when you want to use a different code signing identity in your development projects.
booleancleanBeforeBuild (optional)
This will delete the build directories before invoking the build. This will force the rebuilding of ALL dependencies and can make large projects take a lot longer.
booleancleanResultBundlePath (optional)
This will delete the ResultBundlePath before invoking the build.
If the directory already exists in the location specified by ResultBundlePath, xcodebuild will be an error and should be checked.
booleancleanTestReports (optional)
booleancompileBitcode (optional)
booleanconfiguration (optional)
This is the name of the configuration as defined in the Xcode project.
By default there are Debug and Release configurations.
StringcopyProvisioningProfile (optional)
booleandevelopmentTeamID (optional)
StringdevelopmentTeamName (optional)
StringdisplayImageURL (optional)
StringfullSizeImageURL (optional)
StringgenerateArchive (optional)
Checking this option will create an .xcarchive .app found in the build directory.
An .xcarchive is useful for submission to the app store or third party crash reporters.
You must specify a Scheme to perform an archive.
booleanignoreTestResults (optional)
booleaninterpretTargetAsRegEx (optional)
Build all entries listed under the "Targets:" section of the xcodebuild -list output that match the regexp.
booleanipaExportMethod (optional)
StringipaName (optional)
StringipaOutputDirectory (optional)
StringkeychainId (optional)
StringkeychainName (optional)
The name of this configured keychain. Each job will specify a keychain configuration by the name.
StringkeychainPath (optional)
The path of the keychain to use to retrieve certificates to sign the package (default : ${HOME}/Library/Keychains/login.keychain).
StringkeychainPwd (optional)
The password of the keychain to use to retrieve certificates to sign the package.
class hudson.util.SecretlogfileOutputDirectory (optional)
Specify the directory to output the log of xcodebuild.
If you leave it blank, it will be output to "project directory/builds/${BUILD_NUMBER}/log" with other logs.
If an output path is specified, it is output as a xcodebuild.log file in a relative directory under the "build output directory"
StringmanualSigning (optional)
booleannoConsoleLog (optional)
booleanprovideApplicationVersion (optional)
booleanprovisioningProfiles (optional)
provisioningProfileAppId
StringprovisioningProfileUUID
StringresultBundlePath (optional)
Specify the directory to output the output the test result.
If you leave it blank, it will not output a test result and will not analyze the test results.
If an output path is specified, it is output as a test result in a relative directory under the "ResultBundlePath".
The plug-in analyzes the test result here and outputs a JUnit compatible XML file under the ${WORKSPACE}/test-reports.
Stringsdk (optional)
You only need to supply this value if you want to specify the SDK to build against. If empty, the SDK will be determined by Xcode. If you wish to run OCUnit tests, you will need to use the iPhone Simulator's SDK, for example:
/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator4.1.sdk/
StringsigningMethod (optional)
StringstripSwiftSymbols (optional)
booleansymRoot (optional)
You only need to supply this value if you want to specify the SYMROOT path to use.
If empty, the default SYMROOT path will be used (it could be different depending of your Xcode version).
Supports all macros and also environment and build variables from the Token Macro Plugin.
For example you can use the value :
${WORKSPACE}/symroot
Stringtarget (optional)
The target to build. If left empty, this will build all targets in the project.
If you wish to build your binary and the unit test module, it is best to do this as two separate steps each with their own target.
This was, the iPhone Simulator SDK can be specified for the unit tests.
Stringthinning (optional)
StringunlockKeychain (optional)
booleanuploadBitcode (optional)
booleanuploadSymbols (optional)
booleanuseLegacyBuildSystem (optional)
Instead of "New Builld System" which became available from Xcode 9, we build the application using the legacy build system.
There is a possibility that you can handle old projects that cause problems with the new build system.
Also, since new output formats of logs are changed in the new build system, it is also useful when you want to handle logs with legacy third party tools.
booleanxcodeName (optional)
StringxcodeProjectFile (optional)
StringxcodeProjectPath (optional)
StringxcodeSchema (optional)
StringxcodeWorkspaceFile (optional)
StringxcodebuildArguments (optional)
Extra xcodebuild parameters, added after the command that jenkins generates based on the rest of the config
String$class: 'XFramiumBuilder'configFile
StringsuiteName
StringtestNames
StringtagNames
StringstepTags
StringdeviceTags
StringdefaultCloud
StringoverrideDefaults
boolean$class: 'XLRVarSetterBuilder'XLR_releaseId
StringXLR_varName
StringJKS_varName
Stringdebug
booleanosfBuilderSuiteXMLLintxsdsPath (optional)
StringxmlsPath (optional)
StringreportPath (optional)
String$class: 'XShellBuilder'commandLine
StringexecuteFromWorkingDir
booleanregexToKill
StringtimeAllocated
String$class: 'XrayExportBuilder'serverInstance
Stringissues
Stringfilter
StringfilePath
StringcredentialId
Stringfields (optional)
java.util.Map<java.lang.String, java.lang.String>xrayInstance (optional)
configID
Stringalias
Stringhosting
SERVER, CLOUDserverAddress
StringcredentialId
String$class: 'XrayImportFeatureBuilder'serverInstance
StringfolderPath
StringprojectKey
StringtestInfo
Stringpreconditions
StringcredentialId
StringlastModified (optional)
Stringyarncommand
StringworkspaceSubdirectory (optional)
String$class: 'ZAPBuilder'startZAPFirst
booleanzapHost
StringzapPort
Stringzaproxy
autoInstall
booleantoolUsed
StringzapHome
Stringjdk
Stringtimeout
intzapSettingsDir
StringautoLoadSession
booleanloadSession
StringsessionFilename
StringremoveExternalSites
booleaninternalSites
StringcontextName
StringincludedURL
StringexcludedURL
StringalertFilters
StringauthMode
booleanusername
Stringpassword
StringloggedInIndicator
StringloggedOutIndicator
StringauthMethod
StringloginURL
StringusernameParameter
StringpasswordParameter
StringextraPostData
StringauthScript
StringauthScriptParams
scriptParameterName
StringscriptParameterValue
StringtargetURL
StringspiderScanURL
booleanspiderScanRecurse
booleanspiderScanSubtreeOnly
booleanspiderScanMaxChildrenToCrawl
intajaxSpiderURL
booleanajaxSpiderInScopeOnly
booleanactiveScanURL
booleanactiveScanRecurse
booleanactiveScanPolicy
StringgenerateReports
booleanselectedReportMethod
StringdeleteReports
booleanreportFilename
StringselectedReportFormats
StringselectedExportFormats
StringexportreportTitle
StringexportreportBy
StringexportreportFor
StringexportreportScanDate
StringexportreportReportDate
StringexportreportScanVersion
StringexportreportReportVersion
StringexportreportReportDescription
StringexportreportAlertHigh
booleanexportreportAlertMedium
booleanexportreportAlertLow
booleanexportreportAlertInformational
booleanexportreportCWEID
booleanexportreportWASCID
booleanexportreportDescription
booleanexportreportOtherInfo
booleanexportreportSolution
booleanexportreportReference
booleanexportreportRequestHeader
booleanexportreportResponseHeader
booleanexportreportRequestBody
booleanexportreportResponseBody
booleanjiraCreate
booleanjiraProjectKey
StringjiraAssignee
StringjiraAlertHigh
booleanjiraAlertMedium
booleanjiraAlertLow
booleanjiraFilterIssuesByResourceType
booleancmdLinesZAP
cmdLineOption
StringcmdLineValue
StringzAdviserDownloadconnectionId
StringcredentialsId
Stringjcl
StringencryptedDataFile
StringunencryptedDataFile
StringencryptData (optional)
booleanuploadData (optional)
booleanzAdviserUploadconnectionId
StringuploadDataFile
String$class: 'ZOSJobSubmitter'server
Stringport
intcredentialsId
Stringwait
booleanwaitTime
intdeleteJobFromSpool
booleanjobLogToConsole
booleanjobFile
StringMaxCC
StringJESINTERFACELEVEL1
booleanFTPActiveMode
boolean$class: 'ZanataCliBuilder'projFile
StringsyncG2zanata
booleansyncZ2git
booleanzanataCredentialsId
StringextraPathEntries (optional)
String$class: 'ZanataSyncStep'zanataCredentialsId
StringpullFromZanata (optional)
booleanpushToZanata (optional)
booleansyncOption (optional)
StringzanataLocaleIds (optional)
StringzanataProjectConfigs (optional)
StringzanataURL (optional)
String$class: 'ZapRunner'host
StringzapInstallDescription
value
Stringpath
StringrepositoryURL
StringsourcePath
StringzulipSendmessage (optional)
Stringstream (optional)
Stringtopic (optional)
StringcfyCloudFormationawsCredentialsId (optional)
The ID of the credentials to use when accessing AWS. Parameters' expansion is supported when using freestyle jobs.
StringcredentialsId (optional)
The ID of the credentials to use when accessing Cloudify. Parameters' expansion is supported when using freestyle jobs.
StringdebugOutput (optional)
booleandeploymentId (optional)
ID to assign to the created Cloudify deployment. If not provided, one will be randomly generated. You can obtain the deployment ID from the "environment data" output file.
StringechoEnvData (optional)
If checked, then the created environment's data will be printed to the job's log.
booleanechoInputs (optional)
booleanenvDataLocation (optional)
Path to a file that will contain the created environment's data. If not provided, the environment data won't be written.
Stringparameters (optional)
java.util.Map<java.lang.String, java.lang.Object>parametersAsString (optional)
StringparametersFile (optional)
Path, relative to the Jenkins workspace root, of a YAML/JSON file containing parmaeters to pass to the template.
StringregionName (optional)
AWS region to use. If not specified, the value of the aws_region_name secret is used.
StringstackName (optional)
Name of the new stack.
StringtemplateBody (optional)
StringtemplateBucketName (optional)
StringtemplateFile (optional)
StringtemplateResourceName (optional)
StringtemplateUrl (optional)
URL of the Terraform template. May be a ZIP, tar.gz, or a Git repository.
Stringtenant (optional)
StringNCScanBuilderncScanType
StringncWebsiteId
StringncProfileId
StringncDoNotFail (optional)
booleanacxServerURL (optional)
StringcredentialsId (optional)
StringncApiToken (optional)
ObjectncConfirmed (optional)
booleanncIgnoreFalsePositive (optional)
booleanncIgnoreRiskAccepted (optional)
booleanncSeverity (optional)
StringncStopScan (optional)
boolean$class: 'com.alauda.jenkins.plugins.freestyle.CreateStep'jsonyaml
StringadvancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringlogLevel (optional)
Stringproject (optional)
String$class: 'com.alauda.jenkins.plugins.freestyle.DeleteStep'advancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringignoreNotFound (optional)
booleanlogLevel (optional)
Stringproject (optional)
Stringselector (optional)
kind (optional)
Stringlabels (optional)
name
Stringvalue
Stringnames (optional)
name
String$class: 'com.alauda.jenkins.plugins.freestyle.RawStep'command
Stringarguments
StringadvancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringlogLevel (optional)
Stringproject (optional)
String$class: 'com.alauda.jenkins.plugins.freestyle.WatchStep'advancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringfailPattern (optional)
StringlogLevel (optional)
Stringproject (optional)
Stringselector (optional)
kind (optional)
Stringlabels (optional)
name
Stringvalue
Stringnames (optional)
name
StringsuccessPattern (optional)
Stringtemplate (optional)
String$class: 'com.cloudbees.dockerpublish.DockerBuilder'repoName
StringbuildAdditionalArgs (optional)
StringbuildContext (optional)
StringcreateFingerprint (optional)
booleandockerToolName (optional)
StringdockerfilePath (optional)
StringforcePull (optional)
booleanforceTag (optional)
booleannoCache (optional)
booleanregistry (optional)
url
https://index.docker.io/v1/).
StringcredentialsId
StringrepoTag (optional)
Stringserver (optional)
uri
unix:///var/run/docker.sock or tcp://127.0.0.1:2376).
StringcredentialsId
StringskipBuild (optional)
booleanskipDecorate (optional)
booleanskipPush (optional)
booleanskipTagLatest (optional)
boolean$class: 'com.cloudbees.plugins.deployer.DeployBuilder'hosts
? extends com.cloudbees.plugins.deployer.hosts.DeployHost<?, ?>$class: 'com.etas.jenkins.plugins.CreateTextFile.CreateFileBuilder'textFilePath
StringtextFileContent
StringfileOption
StringuseWorkspace
boolean$class: 'com.groupon.jenkinsci.plugins.DotCiFigtemplate.HelloWorldBuilder'name
StringazureVMSSUpdateazureCredentialsId
StringresourceGroup
Stringname
StringimageReference
id (optional)
Resource ID or VHD URI of the custom image.
Example Resource ID: /subscriptions/your-subscription-id/resourceGroups/your-resource-group/providers/Microsoft.Compute/images/your-image-name
Example VHD URI: http://your-storage-account.blob.core.windows.net/vhds/your-disk-image.vhd
Stringoffer (optional)
Stringpublisher (optional)
Stringsku (optional)
Stringversion (optional)
StringNCScanBuilderncScanType
StringncWebsiteId
StringncProfileId
StringncDoNotFail (optional)
booleancredentialsId (optional)
StringncApiToken (optional)
ObjectncConfirmed (optional)
booleanncIgnoreFalsePositive (optional)
booleanncIgnoreRiskAccepted (optional)
booleanncServerURL (optional)
StringncSeverity (optional)
StringncStopScan (optional)
boolean$class: 'com.openshift.jenkins.plugins.freestyle.CreateStep'jsonyaml
StringadvancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringlogLevel (optional)
Stringproject (optional)
String$class: 'com.openshift.jenkins.plugins.freestyle.DeleteStep'advancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringignoreNotFound (optional)
booleanlogLevel (optional)
Stringproject (optional)
Stringselector (optional)
kind (optional)
Stringlabels (optional)
name
Stringvalue
Stringnames (optional)
name
String$class: 'com.openshift.jenkins.plugins.freestyle.RawStep'command
Stringarguments
StringadvancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringlogLevel (optional)
Stringproject (optional)
String$class: 'com.openshift.jenkins.plugins.freestyle.WatchStep'advancedArguments (optional)
value
StringclusterName (optional)
StringcredentialsId (optional)
StringfailPattern (optional)
StringlogLevel (optional)
Stringproject (optional)
Stringselector (optional)
kind (optional)
Stringlabels (optional)
name
Stringvalue
Stringnames (optional)
name
StringsuccessPattern (optional)
Stringtemplate (optional)
String$class: 'com.syncapse.jenkinsci.plugins.awscloudformationwrapper.CloudFormationBuildStep'stacks
stackName
Name of the stack. The name associated with the stack. The name must be unique within your AWS account. Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters. You can pass Environment Variables into this field.
Stringdescription
StringcloudFormationRecipe
Stringparameters
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.
Stringtimeout
longawsAccessKey
StringawsSecretKey
StringawsRegion
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_Paulosleep
long$class: 'com.synopsys.integration.jenkins.coverity.extensions.buildstep.CoverityBuildStep'coverityInstanceUrl
Specify which Synopsys Coverity connect instance to run this job against.
The resulting Synopsys Coverity connect instance URL is stored in the $COV_URL environment variable, and will affect both the full and incremental analysis.
StringonCommandFailure
Specify the action to take if a Coverity static analysis command fails.
StringprojectName
Specify the name of the Coverity project.
The resulting project name is stored in the $COV_PROJECT environment variable, and will affect both the full and incremental analysis.
StringstreamName
Specify the name of the Coverity stream that you would like to use for the commands.
The resulting stream name is stored in the $COV_STREAM environment variable, and will affect both the full and incremental analysis.
StringcheckForIssuesInView
viewName
Specify the name of the Coverity view that you would like to check for issues.
The resulting view name is stored in the $COV_VIEW environment variable, and affects checking for issues in both the full and incremental analysis, if configured.
StringbuildStatusForIssues
Specify the build status to set if issues are found in the configured view.
StringconfigureChangeSetPatterns
changeSetExclusionPatterns
Specify a comma separated list of filename patterns that you would like to explicitly excluded from the Jenkins change set.
The pattern is applied to the $CHANGE_SET environment variable, and will affect which files are analyzed in an incremental analysis (cov-run-desktop).
Examples:
| File Name | Pattern | Will be excluded |
|---|---|---|
| test.java | *.java | Yes |
| test.java | *.jpg | No |
| test.java | test.* | Yes |
| test.java | test.???? | Yes |
| test.java | test.????? | No |
StringchangeSetInclusionPatterns
Specify a comma separated list of filename patterns that you would like to explicitly included from the Jenkins change set.
The pattern is applied to the $CHANGE_SET environment variable, and will affect which files are analyzed in an incremental analysis (cov-run-desktop).
Examples:
| File Name | Pattern | Will be included |
|---|---|---|
| test.java | *.java | Yes |
| test.java | *.jpg | No |
| test.java | test.* | Yes |
| test.java | test.???? | Yes |
| test.java | test.????? | No |
StringcoverityRunConfiguration
$class: 'AdvancedCoverityRunConfiguration'commands
command
Provide the Coverity command you want to run.
The command should start with the name of the Coverity command you want to run. Ex: cov-build, cov-analyze, etc.
For examples and a list of the available environment variables that can be used, refer to the Command Examples documentation
String$class: 'SimpleCoverityRunConfiguration'coverityAnalysisType
Specify the way you wish to perform your Coverity analysis.
Each analysis type runs a specific Coverity command with some default arguments, followed by cov-commit-defects with some default arguments. Additional command-specific arguments can be provided below.
Full Analysis:
cov-analyze --dir ${WORKSPACE}/idir
cov-commit-defects --dir ${WORKSPACE}/idir --url ${COV_URL} --stream ${COV_STREAM}
Incremental Analysis:
cov-run-desktop --dir ${WORKSPACE}/idir --url ${COV_URL} --stream ${COV_STREAM} ${CHANGE_SET}
cov-commit-defects --dir ${WORKSPACE}/idir --url ${COV_URL} --stream ${COV_STREAM}
Determined by change set threshold
Will run the commands specified by Full Analysis if the number of files listed in the CHANGE_SET environment variable meets or exceeds the specified threshold, otherwise will run the commands specified by Incremental Analysis.
COV_ANALYZE, COV_RUN_DESKTOP, THRESHOLDsourceArgument
The argument that specifies the source for the given capture type.
For Build, this is the build command to pass to cov-build.
For Buildless Capture (Project) this is the project directory to pass to cov-capture.
For Buildless Capture (SCM) this is the scm url to pass to cov-capture.
StringcommandArguments
covBuildArguments
Specify additional arguments to apply to the invocation of the cov-build command. Affects the Build capture type.
Note:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
StringcovAnalyzeArguments
Specify additional arguments to apply to the invocation of the cov-analyze command. Affects the Full Analysis analysis type.
Note:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
StringcovRunDesktopArguments
Specify additional arguments to apply to the invocation of the cov-run-desktop command. Affects the Incremental Analysis analysis type.
Note:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
StringcovCommitDefectsArguments
Specify additional arguments to apply to the invocation of the cov-commit-defects command. Affects all analysis types.
Note:
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
StringcovCaptureArguments
Specify additional arguments to apply to the invocation of the cov-capture command. Affects the Buildless Capture (Project) and Buildless Capture (SCM) capture types.
The following options are automatically provided and should not be specified as an argument here. If you wish to override any of the provided arguments, select the 'Run custom Coverity commands' run configuration.
With the Buildless Capture (Project) capture type, the following arguments are automatically provided:
With the Buildless Capture (SCM) capture type, the following arguments are automatically provided:
StringchangeSetAnalysisThreshold (optional)
For use with the Coverity Analysis Type Determined by change set threshold. Specifies the number of files that triggers a Full Analysis.
Determined by change set threshold will run an Incremental Analysis unless the number of files specified in the $CHANGE_SET environment variable meets or exceeds the value of this field.
If the number of files specified in the $CHANGE_SET environment variable meets or exceeds the value of this field, Determined by change set threshold will run a Full Analysis
intcoverityCaptureType (optional)
Specify the way you wish to capture your source for Coverity analysis.
Each capture type runs a specific Coverity command with some default arguments. Additional command-specific arguments can be provided below.
Build
cov-build --dir ${WORKSPACE}/idir Source Argument (build command)
Buildless Capture (Project)
cov-capture --project-dir Source Argument (project directory)
Buildless Capture (SCM)
cov-capture --scm-url Source Argument (scm url)
COV_BUILD, COV_CAPTURE_PROJECT, COV_CAPTURE_SCMcustomWorkingDirectory (optional)
The fully qualified path to a directory in which to run the cov-build or cov-capture command.
StringcleanUpAction (optional)
Specify the clean up action to perform on a successful execution.
Will either persist or delete the intermediate directory created by the specified capture type.
PERSIST_INTERMEDIATE_DIRECTORY, DELETE_INTERMEDIATE_DIRECTORYcredentialsId (optional)
Specify the credentials to use with the Synopsys Coverity connect instance.
StringoverrideDefaultCredentials (optional)
boolean$class: 'eggPlantBuilder'script
Relative to the Execution Directory, specify the script or scripts, separated by commas to execute in the test relative to the workspace directory for this job, for example:
NOTE: To have scripts run against different SUTs, it is necessary to create a build step for each SUT.
StringSUT
Stringport
Set the VNC Server port for the SUT, eg. 5900. Leaving this blank will use the default port for VNC, 5900.
Stringpassword
Specifies the password for the VNC server. If there's no password, this field can be left blank.
StringcolorDepth
StringglobalResultsFolder
OPTIONAL. Specify the path to the global results folder, relative to the workspace.
StringdefaultDocumentDirectory
Specify the path to the Default Document Directory, relative to the Execution Directory. See Running Eggplant From the Command Line in the Eggplant documentation
Stringparams
Parameters to be passed to the script(s). Equivalent to the -params flag when executing from the command line.
StringreportFailures
booleancommandLineOutput
Pipe eggPlant results out as part of the console output.
booleaninstallationName
String$class: 'iOSAppInstaller'url
StringcloudTestServerID
Stringipa
StringadditionalOptions
String$class: 'iOSSimulatorLauncher'url
StringcloudTestServerID
Stringapp
Stringsdk
Stringfamily
StringdotnetRestoredotnet restore command uses NuGet to restore dependencies as well as project-specific tools that are specified in the project file. In most cases, you don't need to explicitly use the dotnet restore command, since a NuGet restore is run implicitly if necessary when you run the following commands:
dotnet restore explicitly to control when the restore occurs so that they can control network usage. To prevent the implicit NuGet restore, you can use the --no-restore flag with any of these commands to disable implicit restore.
configfile (optional)
StringdisableParallel (optional)
booleanforce (optional)
booleanforceEvaluate (optional)
booleanignoreFailedSources (optional)
booleanlockFilePath (optional)
StringlockedMode (optional)
booleannoCache (optional)
booleannoDependencies (optional)
booleanpackages (optional)
Stringproject (optional)
Stringruntime (optional)
Stringruntimes (optional)
StringruntimesString (optional)
<RuntimeIdentifiers> tag in the .csproj file. For a list of Runtime Identifiers (RIDs), see the RID catalog.
Stringsdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleansource (optional)
Stringsources (optional)
StringsourcesString (optional)
StringspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleanuseLockFile (optional)
booleanverbosity (optional)
StringworkDirectory (optional)
StringdotnetToolRestoredotnet tool restore command finds the tool manifest file that is in scope for the current directory and installs the tools that are listed in it. For information about manifest files, see Install a local tool and Invoke a local tool.
additionalSource (optional)
StringadditionalSources (optional)
StringadditionalSourcesString (optional)
Stringconfigfile (optional)
StringdisableParallel (optional)
booleanignoreFailedSources (optional)
booleannoCache (optional)
booleansdk (optional)
dotnet will be in the path.
With .NETelement (or a
withDotNet block in a pipeline script) to specify one, or ensure this step runs on a node that has a .NET SDK installed and in the path.
StringshowSdkInfo (optional)
dotnet --info will be executed before the main command. This shows a list of available SDKs and runtimes, indicating which one is currently being used.
booleanspecificSdkVersion (optional)
dotnet executable may use the most recent SDK available on the system, even when PATH is set up to find an older SDK deployment first; see this page for more information.
global.json file will be created in the current directory, referencing that SDK version and disabling roll-forward.
global.json already present in the current directory.
booleantoolManifest (optional)
Stringverbosity (optional)
q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic].
StringworkDirectory (optional)
String$class: 'jenkins.plugins.coverity.CoverityBuildStep'The build step can be configured as any other build steps. Choose the appropriate builder and configure the command to be performed. The configured build step will be wrapped with the Coverity cov-build executables so that it captures the build and can be used to further analysis by using coverity static tools. This build step is only for capturing build of compiled sources.
buildStep
hudson.tasks.BuildStep)$class: 'org.jenkinsci.plugins.dockerbuildstep.DockerBuilder'dockerCmd
$class: 'CommitCommand'containerId
Stringrepo
Stringtag
StringrunCmd
String$class: 'CreateContainerCommand'image
Stringcommand
StringhostName
StringcontainerName
StringenvVars
Stringlinks
StringexposedPorts
StringcpuShares
StringmemoryLimit
Stringdns
StringextraHosts
StringnetworkMode
StringpublishAllPorts
This setting corresponds to the --publish-all (-P) option of the docker run CLI command.
booleanportBindings
--publish (-p) option of the docker run CLI command.
Enter one or more port binding, each on its own line. The syntax is host container where host is either hostPort or hostIp:hostPort and container is either containerPort or containerPort/protocol.
Alternatively, you can separate host and port with a colon (":"), thus using the same syntax as in the Docker CLI.
Examples
StringbindMounts
--volume (-v) option of the docker run CLI command.
Enter one or more bind mount, each on its own line. The syntax is hostPath containerPath[ rw|ro]
Stringprivileged
This setting corresponds to the --privileged option of the docker run CLI command.
booleanalwaysRestart
boolean$class: 'CreateImageCommand'dockerFolder
StringimageTag
StringdockerFile
Stringpull
booleannoCache
booleanrm
booleanbuildArgs
String$class: 'ExecCreateAndStartCommand'containerIds
Stringcommand
String$class: 'ExecCreateCommand'containerIds
Stringcommand
String$class: 'ExecStartCommand'commandIds
String$class: 'KillCommand'containerIds
String$class: 'PullImageCommand'fromImage
Stringtag
Stringregistry
StringdockerRegistryEndpoint
url
https://index.docker.io/v1/).
StringcredentialsId
String$class: 'PushImageCommand'image
Stringtag
Stringregistry
StringdockerRegistryEndpoint
url
https://index.docker.io/v1/).
StringcredentialsId
String$class: 'RemoveAllCommand'removeVolumes
booleanforce
boolean$class: 'RemoveCommand'containerIds
StringignoreIfNotFound
booleanremoveVolumes
booleanforce
boolean$class: 'RemoveImageCommand'imageName
StringimageId
StringignoreIfNotFound
boolean$class: 'RestartCommand'containerIds
Stringtimeout
int$class: 'SaveImageCommand'imageName
StringimageTag
Stringdestination
Stringfilename
StringignoreIfNotFound
boolean$class: 'StartByImageIdCommand'imageId
String$class: 'StartCommand'containerIds
StringwaitPorts
StringcontainerIdsLogging
String$class: 'StopAllCommand'$class: 'StopByImageIdCommand'imageId
String$class: 'StopCommand'containerIds
String$class: 'TagImageCommand'image
Stringrepository
Stringtag
StringignoreIfNotFound
booleanwithForce
boolean$class: 'org.jenkinsci.plugins.ios.connector.DeployBuilder'path
Stringudid
(We are looking for more ways to let you specify the target device flexibly. Please send in your suggestions.)
String$class: 'org.jenkinsci.plugins.liquibase.builder.UpdateBuilder'changeLogFile (optional)
StringchangeLogParameters (optional)
Stringcontexts (optional)
StringcredentialsId (optional)
StringinstallationName (optional)
Stringlabels (optional)
StringliquibasePropertiesPath (optional)
Stringpassword (optional)
StringresourceDirectories (optional)
Stringurl (optional)
Stringusername (optional)
StringosfBuilderSuiteForSFCCDeployhostname (optional)
StringtfCredentialsId (optional)
StringocCredentialsId (optional)
StringocVersion (optional)
StringbuildVersion (optional)
StringcreateBuildInfoCartridge (optional)
booleanactivateBuild (optional)
booleansourcePaths (optional)
sourcePath
StringexcludePatterns
excludePattern
StringtempDirectory (optional)
Stringgreetname
StringuseFrench (optional)
boolean$class: 'org.quality.gates.jenkins.plugin.QGBuilder'jobConfigData
class org.quality.gates.jenkins.plugin.JobConfigDataglobalConfigDataForSonarInstance
class org.quality.gates.jenkins.plugin.GlobalConfigDataForSonarInstance$class: 'quality.gates.jenkins.plugin.QGBuilder'jobConfigData
class quality.gates.jenkins.plugin.JobConfigData$class: 'vRABlueprintBuildStep'params
serverUrl
StringuserName
Stringpassword
Stringtenant
StringpackageBlueprint
booleanblueprintPath
StringoverWrite
booleanpublishBlueprint
booleanserviceCategory
String$class: 'vRADeploymentBuildStep'params
serverUrl
StringuserName
Stringpassword
Stringtenant
StringblueprintName
StringwaitExec
booleanrequestTemplate
booleanrequestParams
json
StringbuildContent
StringPlease submit your feedback about this page through this quick form.
Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?
See existing feedback here.